Skip to main content
WEBHOOK

Authorizations

​
X-API-KEY
string
header
required

Body

application/json

The webhook body delivered when a batch reaches a terminal status (plan 083). Documentation-only model — registered on app.webhooks so it renders in the API reference; nothing calls this as an endpoint. The live serializer is extract.core.webhooks.build_batch_update_body.

​
batch_id
string
required

The batch that reached a terminal status.

​
status
enum<string>
required

Terminal batch status. Treat completed AND partially_failed as 'results are ready' — partially_failed means some items succeeded and some failed (check counts), not a total failure.

Available options:
completed,
partially_failed,
failed,
cancelled
​
counts
BatchCounts · object
required

Per-item-status counts at completion.

​
total_items
integer
required

Number of items in the batch.

​
type
string
default:batch.update

Event type. Only batch.update exists today.

Allowed value: "batch.update"
​
metadata
Metadata · object | null

The metadata you passed on POST /v1/batches, echoed verbatim.

​
completed_at
string | null

ISO-8601 UTC timestamp when the batch reached its terminal status.

​
results_expires_at
string | null

ISO-8601 UTC timestamp after which this batch's results are deleted (3-day default retention). Fetch results before then; a resend after this point is refused.

Response

Successful Response