Zur Navigation springen
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.

Header

Sync-SignaturestringErforderlich

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

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

Payload

The payload of this webhook request is an object.
idstringErforderlich
A unique identifier for the batch.
createdAtdatetimeErforderlich
The date and time the batch was created.
statusenumErforderlich
The batch status, COMPLETED or FAILED.
Erlaubte Werte:
metricsobjectErforderlich
outputUrlstringErforderlich
URL of the JSONL results file. A GET follows a 302 redirect to a signed result URL. Empty when there are no results.
webhookUrlstringOptional
The webhook URL the batch was created with.
optionsmap from strings to anyOptional
Batch options.

Antwort

200
beliebig
Geben Sie einen 200-Status zurück, um anzuzeigen, dass die Daten erfolgreich empfangen wurden.