BulkTriggerResponse

The result of a batch submission.

countintegerrequired

Number of events successfully queued.

Possible values: >= 0

Example: 2500

events object[]required

Per-event outcomes, in the order submitted.

Array [

channelstring | nullnullable

The channel the event was queued on, when it was queued.

Example: email

errorstring | nullnullable

Why this event was rejected, when it was.

Example: Subscriber usr_1 has no reachable channel

eventIdstring | nullnullable

Nerve's identifier for the event, present when it was queued.

Example: evt_9c4f1a2b3d5e6f708192a3b4c5d6e7f8

indexintegerrequired

Zero-based position of this event in the submitted events array, so a failure can be matched back to what you sent.

Possible values: >= 0

statusstringrequired

QUEUED or FAILED.

Example: QUEUED

]

failedCountintegerrequired

Number of events rejected. Zero when status is QUEUED.

Possible values: >= 0

Example: 0

jobIdstringrequired

Identifier for the batch, for correlating logs. Individual events each carry their own eventId.

Example: job_batch_4d2f8a1c9b3e7f60

statusstringrequired

QUEUED when every event was accepted, PARTIAL when some were not. A batch where nothing succeeded is still reported here rather than as an error status, because the per-event reasons are what you need.

Example: QUEUED

BulkTriggerResponse

{
  "count": 2500,
  "events": [
    {
      "channel": "email",
      "error": "Subscriber usr_1 has no reachable channel",
      "eventId": "evt_9c4f1a2b3d5e6f708192a3b4c5d6e7f8",
      "index": 0,
      "status": "QUEUED"
    }
  ],
  "failedCount": 0,
  "jobId": "job_batch_4d2f8a1c9b3e7f60",
  "status": "QUEUED"
}