Events
Receive event webhook
Webhooks can be configured to send events to your desired URL.
Example Requests
POST
/ReceiveEventWebhookThe 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.
date-timeThe unique ID you use internally to refer to this data point, propagated from the original function input.
The inbound email that triggered this event.
"transform"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.
ID of pipeline that transformed the original input data.
Timestamp indicating when the transform was published via webhook and received a successful 200 response. Value is null if the transformation hasn't been sent.
date-timeLast timestamp indicating when the transform was published via webhook and received a non-200 response. Set to null on a subsequent retry if the webhook service receives a 200 response.
The input type of the content you're sending for transformation.
"csv" | "docx" | "email" | "heic" | "html" | "jpeg" | "json" | "heif" | "m4a" | "mp3" | "pdf" | "png" | "text" | "wav" | "webp" | "xls" | "xlsx" | "xml"Unique ID for each transformation output generated by bem following Segment's KSUID conventions.
Presigned S3 URL for the input content uploaded to S3.
Array of transformation inputs with their types and S3 URLs.
The transformed content of the input. The structure of this object is defined by the function configuration.
Corrected feedback provided for fine-tuning purposes.
List of properties that were invalid in the input.
Accuracy, precision, recall, and F1 score when corrected JSON is provided.
Indicates whether array order matters when comparing corrected JSON with extracted JSON.
Indicates whether this transformation was created as part of a regression test.
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 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].