Passer à la navigation
Webhooks Payload ReferenceWebhooks

Batch Status Update

Receive a notification when a batch completes or fails

En-têtes

X-Signature-PrimarystringRequis
An HMAC signature of the payloadd

Charge utile

The payload of this webhook request is an object.
idstringRequis
A unique identifier for the batch.
created_atdatetimeRequis
The date and time the batch was created.
statusenumRequis
The current status of the batch.
Valeurs autorisées:
metricsobjectRequis
Metrics about the batch processing progress.
outputUrlstringRequis
The URL to download the batch results file when completed. A GET request follows a 302 redirect to a signed JSONL result URL.
webhookUrlstringOptionnel

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

Réponse

200
n'importe quel
Retournez un statut 200 pour indiquer que les données ont été reçues avec succès.