Send event

Delivered when a send function attempts to deliver a payload to a downstream destination (webhook, S3, or Google Drive). The result of that delivery — including the destination's response — is in the body. The original payload that was delivered is mirrored in deliveredContent.

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"send"

functionCallID?string

Unique identifier of function call that this event is associated with.

functionID*string

Unique identifier of function that this event is associated with.

functionName*string

Unique name of function that this event is associated with.

functionVersionNum?integer

Version number of function that this event is associated with.

callID?string

Unique identifier of workflow call that this event is associated with.

workflowID?string

Unique identifier of workflow that this event is associated with.

workflowName?string

Name of workflow that this event is associated with.

workflowVersionNum?integer

Version number of workflow that this event is associated with.

deliveryStatus*string

Whether the payload was successfully delivered or the send node was skipped.

Value in"success" | "skip"

destinationType*string

The type of destination the payload was sent to.

Value in"webhook" | "s3" | "google_drive"

deliveredContent?object

The full protocol event JSON that was delivered — identical to what subscription publish would deliver for the same event. For ad-hoc calls with a JSON file input, contains the raw input JSON. For ad-hoc calls with a binary file input, contains {"s3URL": ""}.

webhookOutput?

Populated when destinationType is "webhook".

s3Output?

Populated when destinationType is "s3".

googleDriveOutput?

Populated when destinationType is "google_drive".

Response Body

Example Requests

POST/send

Send event

Request Body

Response Body

2XX

Request Bodyapplication/json

See also