Passer à la navigation
Webhooks Payload ReferenceWebhooks

batch status update

Sent when a batch completes or fails, with the same delivery, retry and signing rules as generation webhooks. Deduplicate on Sync-Delivery-Id or the batch id.

En-têtes

Sync-SignaturestringRequis

t=<unix seconds>,v1=<hex HMAC-SHA256> over <t>.<raw request body>, signed with your organization webhook secret.

Sync-Delivery-IdstringRequis
Identifies this delivery. It stays the same on every retry.

Charge utile

The payload of this webhook request is an object.
idstringRequis
A unique identifier for the batch.
createdAtdatetimeRequis
The date and time the batch was created.
statusenumRequis
The batch status, COMPLETED or FAILED.
Valeurs autorisées:
metricsobjectRequis
outputUrlstringRequis
URL of the JSONL results file. A GET follows a 302 redirect to a signed result URL. Empty when there are no results.
webhookUrlstringOptionnel
The webhook URL the batch was created with.
optionsmap from strings to anyOptionnel
Batch options.

Réponse

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