Ir para a navegação
Webhooks Payload ReferenceWebhooks

Batch Status Update

Receive a notification when a batch completes or fails

Cabeçalhos

X-Signature-PrimarystringObrigatório
An HMAC signature of the payloadd

Payload

The payload of this webhook request is an object.
idstringObrigatório
A unique identifier for the batch.
created_atdatetimeObrigatório
The date and time the batch was created.
statusenumObrigatório
The current status of the batch.
Valores permitidos:
metricsobjectObrigatório
Metrics about the batch processing progress.
outputUrlstringObrigatório
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.

Resposta

200
qualquer
Retorne um status 200 para indicar que os dados foram recebidos com sucesso.