Collection processing event

Delivered when a batch add or update against a Collection finishes. Reports how many items were processed and lists the IDs that were touched.

For signing-secret setup and retry semantics that apply to every variant, see the Webhooks overview.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

functionCallTryNumber?integer

The attempt number of the function call that created this event. 1 indexed.

eventID*string

Unique ID generated by bem to identify the event.

createdAt?string

Timestamp indicating when the event was created.

Formatdate-time

referenceID*string

The unique ID you use internally to refer to this data point, propagated from the original function input.

inboundEmail?

The inbound email that triggered this event.

metadata?

eventType?string

Value in"collection_processing"

collectionID*string

Unique identifier of the collection.

collectionName*string

Name/path of the collection.

operation*string

The operation performed (add or update).

Value in"add" | "update"

processedCount*integer

Number of items successfully processed.

collectionItemIDs?array<>

Array of collection item KSUIDs that were added or updated.

status*string

Processing status (success or failed).

Value in"success" | "failed"

errorMessage?string

Error message if processing failed.

Example Requests

POST/collection-processing