{
"event": "batch.completed",
"id": "evt_123",
"created_at": "2026-07-09T18:00:12.000Z",
"data": {
"batch": {
"id": "batch_9f2c8a",
"tags": [
"docs"
],
"crawl": {
"source": {
"type": "start_url",
"url": "https://example.com/docs"
},
"max_pages": 500,
"max_depth": 0,
"follow_subdomains": true,
"url_pattern": "^https://example\\.com/docs/",
"exclude_url_pattern": "/tag/|/author/",
"languages": "same_as_start_url"
},
"input": {
"reserved": 24817,
"reserved_is_ceiling": false,
"submitted": 25000,
"duplicates": 183,
"invalid": 0
},
"progress": {
"succeeded": 18091,
"failed": 311,
"pending": 6415
},
"credits": {
"reserved": 24817,
"refunded": 6726,
"ocr_charged": 42,
"net": 18091
},
"timing": {
"created_at": "<string>",
"started_at": "<string>",
"completed_at": "<string>"
},
"page_errors": [
{
"code": "WEBSITE_ACCESS_ERROR",
"count": 204
}
],
"failure": {
"code": "stalled",
"message": "Batch stopped reporting progress and was finalized automatically"
},
"results": {
"expires_at": "<string>",
"files": [
{
"url": "<string>",
"items": 123,
"bytes": 123
}
]
},
"formats": {
"html": true,
"markdown": true
},
"policies": [
"pol_3f9c2a7e5b8d4c1f9a6e0b2d7c4f8a1e"
]
}
}
}Webhooks
Receive batch.completed events
Receive the batch’s final status and result links.
WEBHOOK
batchCompleted
{
"event": "batch.completed",
"id": "evt_123",
"created_at": "2026-07-09T18:00:12.000Z",
"data": {
"batch": {
"id": "batch_9f2c8a",
"tags": [
"docs"
],
"crawl": {
"source": {
"type": "start_url",
"url": "https://example.com/docs"
},
"max_pages": 500,
"max_depth": 0,
"follow_subdomains": true,
"url_pattern": "^https://example\\.com/docs/",
"exclude_url_pattern": "/tag/|/author/",
"languages": "same_as_start_url"
},
"input": {
"reserved": 24817,
"reserved_is_ceiling": false,
"submitted": 25000,
"duplicates": 183,
"invalid": 0
},
"progress": {
"succeeded": 18091,
"failed": 311,
"pending": 6415
},
"credits": {
"reserved": 24817,
"refunded": 6726,
"ocr_charged": 42,
"net": 18091
},
"timing": {
"created_at": "<string>",
"started_at": "<string>",
"completed_at": "<string>"
},
"page_errors": [
{
"code": "WEBSITE_ACCESS_ERROR",
"count": 204
}
],
"failure": {
"code": "stalled",
"message": "Batch stopped reporting progress and was finalized automatically"
},
"results": {
"expires_at": "<string>",
"files": [
{
"url": "<string>",
"items": 123,
"bytes": 123
}
]
},
"formats": {
"html": true,
"markdown": true
},
"policies": [
"pol_3f9c2a7e5b8d4c1f9a6e0b2d7c4f8a1e"
]
}
}
}See Webhooks for signature verification, retries, and replay.
Headers
Body
application/json
Payload sent when a batch completes.
Response
2XX
Webhook accepted.
Was this page helpful?