Webhooks Payload ReferenceWebhooks

Batch Status Update

Receive a notification when a batch completes or fails

Headers

X-Signature-PrimarystringRequired
An HMAC signature of the payloadd

Payload

The payload of this webhook request is an object.
idstringRequired
A unique identifier for the batch.
created_atdatetimeRequired
The date and time the batch was created.
statusenumRequired
The current status of the batch.
Allowed values:
metricsobjectRequired
Metrics about the batch processing progress.
outputUrlstringRequired

The URL to download the batch results file (available when completed).

webhookUrlstringOptional
The webhook URL for batch status notifications.

Response

200
any
Return a 200 status to indicate that the data was received successfully.