Zur Navigation springen
Webhooks Payload ReferenceWebhooks

Batch Status Update

Receive a notification when a batch completes or fails

Header

X-Signature-PrimarystringErforderlich
An HMAC signature of the payloadd

Payload

The payload of this webhook request is an object.
idstringErforderlich
A unique identifier for the batch.
created_atdatetimeErforderlich
The date and time the batch was created.
statusenumErforderlich
The current status of the batch.
Erlaubte Werte:
metricsobjectErforderlich
Metrics about the batch processing progress.
outputUrlstringErforderlich
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.

Antwort

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