Parse event

Delivered when a parse function renders a document into a navigable structure of sections, entities, and relationships. The full parsed structure 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"parse"

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.

inputType?string

The input type of the content you're sending for transformation.

Value in

"csv" | "docx" | "email" | "heic" | "html" | "jpeg" | "json" | "heif" | "m4a" | "mp3" | "pdf" | "png" | "text" | "wav" | "webp" | "xls" | "xlsx" | "xml"

transformationID?string

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

s3URL?|

Presigned S3 URL for the input content uploaded to S3.

inputs?array<>|

Array of parse inputs with their types and S3 URLs.

transformedContent*object

The parsed content of the input. Top-level keys are sections, entities, and relationships; the precise shape is determined by the parse function's configuration.

correctedContent?||array<>|||||

Corrected feedback provided for fine-tuning purposes.

invalidProperties?array<>

List of properties that were invalid in the input.

itemOffset*integer

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

itemCount*integer

The number of items that were parsed. Used for batch parsing to indicate how many items were parsed.

fieldBoundingBoxes?object

Per-field bounding boxes. A JSON object mapping RFC 6901 JSON Pointer paths to the document regions from which each parsed value was sourced.

fieldConfidences?object

Per-field confidence scores. A JSON object mapping RFC 6901 JSON Pointer paths to float values in the range [0, 1] indicating the model's confidence in each parsed field value.

avgConfidence?|

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

Emitted when a parse function completes. Reuses the extract event shape on the wire — both wrap a Transformation and downstream consumers care about the same transformedContent payload — but uses a distinct eventType discriminator so receivers can dispatch on the function type that produced it.

POST/parse

Parse event

Request Body

Response Body

See also

Parse event

Request Body

Response Body

2XX

Request Bodyapplication/json

See also