Skip to navigation
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 when completed. A GET request follows a 302 redirect to a signed JSONL result URL.
webhookUrlstringOptional

The webhook URL for batch status notifications. Deliveries include a Sync-Signature header signed with the organization webhook secret.

Response

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