batch.canceled
⚠️
Preview — this feature is being built; the design below is the spec.
Sent when: A cancel request finished: in-flight requests completed and the rest were dropped.
| Property | Value |
|---|---|
| Scope | One workspace. Register with an inference key at /v1/webhooks. |
| Area | Batches |
| Subscribe with | "events": ["batch.canceled"], or a prefix such as "batch.*" |
Payload
{
"id": "evt_01JCA5D7F9H1K3M5P7R9",
"type": "batch.canceled",
"created_at": "2026-11-05T10:00:00Z",
"workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
"data": {
"object": {
"id": "batch_01JBXF3P8K",
"type": "batch",
"status": "canceled",
"output_file_id": "file_01JBXG7Q",
"request_counts": {
"total": 5000,
"succeeded": 300,
"failed": 0,
"canceled": 4700
}
}
}
}data.object matches what the corresponding GET endpoint returned when the event happened. Prompt and output text are never included.
What to do
- Results for requests that ran before the cancel are still available.
Delivery
Deliveries are signed, retried with back-off for up to 3 days, and may arrive more than once or out of order. De-duplicate on the syntic-event-id header and compare timestamps before acting. See Webhooks.
Was this page helpful?