Extract event
Delivered when an extract function completes processing of a document and produces structured JSON. The body's transformedContent matches the function's outputSchema.
For signing-secret setup and retry semantics that apply to every variant, see the Webhooks overview.
Payload
The attempt number of the function call that created this event. 1 indexed.
Unique ID generated by bem to identify the event.
Timestamp indicating when the event was created.
The unique ID you use internally to refer to this data point, propagated from the original function input.
Unique identifier of function call that this event is associated with.
Unique identifier of function that this event is associated with.
Unique name of function that this event is associated with.
Version number of function that this event is associated with.
Unique identifier of workflow call that this event is associated with.
Unique identifier of workflow that this event is associated with.
Name of workflow that this event is associated with.
Version number of workflow that this event is associated with.
The input type of the content you're sending for transformation.
jfif is accepted as an alias for jpeg — JFIF is the same format under a different extension — and is normalized to jpeg, so responses and webhooks report jpeg for a JFIF upload. The undeclared alias jpg behaves the same way.
Unique ID for each transformation output generated by bem following Segment's KSUID conventions.
Presigned S3 URL for the input content uploaded to S3.
The transformed content of the input. The structure of this object is defined by the function configuration.
List of properties that were invalid in the input.
The offset of the first item that was transformed. Used for batch transformations to indicate which item in the batch this event corresponds to.
The number of items that were transformed. Used for batch transformations to indicate how many items were transformed.
Per-field bounding boxes. A JSON object mapping RFC 6901 JSON Pointer paths (e.g. "/invoiceNumber", "/items/0/price") to the document regions from which each extracted value was sourced.
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.
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.