Saltar a la navegación
Webhooks Payload ReferenceWebhooks

Batch Status Update

Receive a notification when a batch completes or fails

Encabezados

X-Signature-PrimarystringRequerido
An HMAC signature of the payloadd

Carga útil

The payload of this webhook request is an object.
idstringRequerido
A unique identifier for the batch.
created_atdatetimeRequerido
The date and time the batch was created.
statusenumRequerido
The current status of the batch.
Valores permitidos:
metricsobjectRequerido
Metrics about the batch processing progress.
outputUrlstringRequerido
The URL to download the batch results file when completed. A GET request follows a 302 redirect to a signed JSONL result URL.
webhookUrlstringOpcional

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

Respuesta

200
cualquier
Devuelve un estado 200 para indicar que los datos se recibieron correctamente.