Join event

Delivered when a join function combines outputs from multiple upstream calls into a single transformed payload.

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

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.

joinType*string

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.

transformedContent*object

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

invalidProperties*array<>

List of properties that were invalid in the input.

items*array<>

The items that were joined.

fieldConfidences?object

Per-field confidence scores. A JSON object mapping RFC 6901 JSON Pointer paths (e.g. "/invoiceNumber") to float values in the range [0, 1] indicating the model's confidence in each extracted field value.

avgConfidence?|

Average confidence score across all extracted fields, in the range [0, 1].

Response Body

Example Requests

POST/join

Join event

Request Body

Response Body

2XX

Request Bodyapplication/json

See also