Events

Receive event webhook

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

An event

eventIDstring

Unique ID generated by bem to identify the event.

referenceIDstring

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

inboundEmail?EventInboundEmail

The inbound email that triggered this event.

metadata?object
eventType?string
Value in"transform"
functionCallID?string

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

functionIDstring

Unique identifier of function that this event is associated with.

functionNamestring

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.

transformedContentobject

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

Empty Object

invalidProperties?array<string>

List of properties that were invalid in the input.

itemOffsetinteger

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

itemCountinteger

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

eventIDstring

Unique ID generated by bem to identify the event.

referenceIDstring

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

inboundEmail?EventInboundEmail

The inbound email that triggered this event.

metadata?object
eventType?string
Value in"route"
functionCallID?string

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

functionIDstring

Unique identifier of function that this event is associated with.

functionNamestring

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.

choicestring

The choice made by the router function.

s3URL?string

The presigned S3 URL of the file that was routed.

eventIDstring

Unique ID generated by bem to identify the event.

referenceIDstring

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

inboundEmail?EventInboundEmail

The inbound email that triggered this event.

metadata?object
eventType?string
Value in"split_collection"
functionCallID?string

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

functionIDstring

Unique identifier of function that this event is associated with.

functionNamestring

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.

outputTypestring
Value in"print_page" | "semantic_page"
printPageOutputobject
semanticPageOutputobject
eventIDstring

Unique ID generated by bem to identify the event.

referenceIDstring

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

inboundEmail?EventInboundEmail

The inbound email that triggered this event.

metadata?object
functionCallID?string

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

functionIDstring

Unique identifier of function that this event is associated with.

functionNamestring

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.

outputTypestring
Value in"print_page" | "semantic_page"
printPageOutput?object
semanticPageOutput?object
eventIDstring

Unique ID generated by bem to identify the event.

referenceIDstring

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

inboundEmail?EventInboundEmail

The inbound email that triggered this event.

metadata?object
eventType?string
Value in"error"
functionCallID?string

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

functionIDstring

Unique identifier of function that this event is associated with.

functionNamestring

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.

messagestring

Error message.

eventIDstring

Unique ID generated by bem to identify the event.

referenceIDstring

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

inboundEmail?EventInboundEmail

The inbound email that triggered this event.

metadata?object
eventType?string
Value in"join"
functionCallID?string

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

functionIDstring

Unique identifier of function that this event is associated with.

functionNamestring

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.

joinTypestring

The type of join that was performed.

Value in"standard"
transformationID?string

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

transformedContentobject

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

Empty Object

invalidPropertiesarray<string>

List of properties that were invalid in the input.

itemsarray<JoinEventItem>

The items that were joined.