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.

A completed transformation

transformationIDstring

Unique ID generated by bem following Segment's KSUID conventions.

pipelineIDstring

ID of pipeline that transformed the original input data.

referenceIDstring

The unique ID you use internally to refer to this data point.

createdAtstring

Timestamp indicating when the transformation was created.

Formatdate-time
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?string

Last timestamp indicating when the transform was published via webhook and received a non-200 response. Set to null if on a subsequent retry if the webhook service receives a 200 response.

inputTypeInputType

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

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

For CSV transformations, this offset represents starting row of the CSV for which you want to fetch transformations for. For PDF transformations, this offset represents the starting page of the PDF that the transformation pertains to. For pipelines that have independentDocumentProcessingEnabled set to true. Note that this is zero-indexed.

transformedContentobject & AnyType

The transformed content as an object, in the schema defined by the pipeline.

invalidProperties?array<string>

Highlights any fields missing from transforming the original input data that are marked as required in the respective output schema for the pipeline.

eventID?string

Unique ID of the event associated with this transformation.

functionID?string

Unique ID of the function that performed this transformation.

functionName?string

Name of the function that performed this transformation.

taskID?string

Unique ID generated by bem associated with the corresponding task that led to this transformation.

Response Body