Webhook 回调
Webhook 用于在异步任务执行过程中推送状态变化,以便即时获知任务进展。
XCrawl 当前支持在以下接口中配置 webhook:
POST /v1/scrapePOST /v1/crawl
配置参考
{
"webhook": {
"url": "https://your-domain.com/xcrawl/webhook",
"headers": {
"X-Webhook-Secret": "YOUR_SHARED_SECRET"
},
"events": [
"started",
"completed",
"failed"
]
}
}字段:
| 字段 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
url | string | 否 | - | 回调地址 |
headers | object map | 否 | - | 回调请求自定义请求头 |
events | string[] | 否 | ["started","completed","failed"] | 回调事件 |
events 选项:
started:任务开始时回调completed:任务成功完成时回调failed:任务失败时回调
回调内容
Webhook 的回调 payload 与对应的异步结果查询接口保持一致:
- Scrape 任务事件对应 Scrape Result API
- Crawl 任务事件对应 Crawl Result API
started事件通常只包含任务标识与状态completed事件会包含最终的data结果failed事件会包含任务标识、状态和时间戳,data可能不存在
