Transformations

Receive completed Transformation webhook

Pipelines can also be configured to send webhooks to your desired URL. Webhooks will be called upon the successful completion of each transformed data point, instead of batched.

Request Body

application/json

A completed transformation

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"transform"
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.

pipelineID?string

ID of pipeline that transformed the original input data.

publishedAt?string

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.

Formatdate-time
lastPublishErrorAt?|

Last 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.

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 transformation inputs with their types and S3 URLs.

transformedContent*object

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

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

Corrected feedback provided for fine-tuning purposes.

invalidProperties?array<>

List of properties that were invalid in the input.

metrics?|

Accuracy, precision, recall, and F1 score when corrected JSON is provided.

orderMatching?boolean

Indicates whether array order matters when comparing corrected JSON with extracted JSON.

isRegression?boolean

Indicates whether this transformation was created as part of a regression test.

itemOffset*integer

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

itemCount*integer

The number of items that were transformed. Used for batch transformations to indicate how many items were transformed.

Response Body

Example Requests

POST/ReceiveTransformationWebhook