Events

Receive event webhook

Webhooks can be configured to send events to your desired URL.

Request Body

application/json

An event

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"transform"
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.

transformationID?string

Unique ID for each transformation output generated by bem following Segment's KSUID conventions.

transformedContent*object

The transformed content of the input. The structure of this object is defined by the function configuration.

invalidProperties?array<string>

List of properties that were invalid in the input.

itemOffset*integer

The offset of the first item that was transformed. Used for batch transformations to indicate which item in the batch this event corresponds to.

itemCount*integer

The number of items that were transformed. Used for batch transformations to indicate how many items were transformed.

Example Requests

POST/ReceiveEventWebhook