Payload shaping event

Delivered when a payload_shaping function applies its JMESPath expressions to reshape an input payload. The reshaped result is in transformedContent.

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

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.

transformedContent*object

The reshaped payload produced by applying the function's JMESPath expressions to the input data.

Response Body

Example Requests

Emitted by payload_shaping functions, which restructure JSON payloads using JMESPath expressions configured on the function. The shaped result is carried in transformedContent.

POST/payload-shaping

Payload shaping event

Request Body

Response Body

2XX

Request Bodyapplication/json

See also