v36

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0187270483.0 KB

Webhooks

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.

postWebhookjoin

Payload

functionCallTryNumberinteger

The attempt number of the function call that created this event. 1 indexed.

eventIDstring required

Unique ID generated by bem to identify the event.

createdAtstring date-time

Timestamp indicating when the event was created.

referenceIDstring required

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

eventType'join'

functionCallIDstring

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

functionIDstring required

Unique identifier of function that this event is associated with.

functionNamestring required

Unique name of function that this event is associated with.

functionVersionNuminteger

Version number of function that this event is associated with.

callIDstring

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

workflowIDstring

Unique identifier of workflow that this event is associated with.

workflowNamestring

Name of workflow that this event is associated with.

workflowVersionNuminteger

Version number of workflow that this event is associated with.

joinType'standard' required

The type of join that was performed.

transformationIDstring

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

transformedContentobject required

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

invalidPropertiesstring[] required

List of properties that were invalid in the input.

fieldConfidencesobject

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.

avgConfidencenumber float nullable

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

Response

Return any 2XX status code to acknowledge receipt. The exact code is not inspected.