Ir para a navegação
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.

Cabeçalhos

Sync-SignaturestringObrigatório

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

Sync-Delivery-IdstringObrigatório
Identifies this delivery. It stays the same on every retry.

Payload

The payload of this webhook request is an object.
idstringObrigatório
A unique identifier for the batch.
createdAtdatetimeObrigatório
The date and time the batch was created.
statusenumObrigatório
The batch status, COMPLETED or FAILED.
Valores permitidos:
metricsobjectObrigatório
outputUrlstringObrigatório
URL of the JSONL results file. A GET follows a 302 redirect to a signed result URL. Empty when there are no results.
webhookUrlstringOpcional
The webhook URL the batch was created with.
optionsmap from strings to anyOpcional
Batch options.

Resposta

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