Webhook
Webhooks 允许您配置采集器以在发生特定事件时执行 HTTP 操作。例如，您可以使用它们在当前采集器运行完成或失败时获取通知。
配置如下：
1.触发时机
状态 | 描述 |
|---|---|
RUNNING | 任务开始运行 |
SUCCEEDED | 任务执行成功 |
FAILED | 任务执行失败 |
TIMEOUT | 任务执行超时 |
ABORTED | 任务终止运行 |
2.URL
Webhook 请求的目标 URL。数据将通过JSON 以 POST 请求发送到目标 URL。目标服务状态码返回 2XX 则视为发送成功。
3.Payload
Webhook 负载的模板。双大括号内的变量{{var}}可用于将动态值注入到有效负载中。
示例：
{
"eventType": {{eventType}},
"runId": {{runId}},
"taskId": {{taskId}},
"createAt": {{createAt}}
}
支持的变量如下：
变量名 | 类型 | 描述 |
|---|---|---|
runId | string | 本次执行 id |
scraperId | string | 采集器 id |
taskId | string | 任务 id （对于临时采集，taskId 为 ""） |
eventType | string | 事件类型，参考 事件类型 |
kvStoreId | string | Key-value 存储类型的 id |
datasetId | string | 数据集 id |
requestQueueId | string | 采集队列 id |
createAt | string | 事件时间 |
4.Headers
Webhook 会将 headers template 经过模板替换后，最为 POST 请求的 header 发送出去。用法与 Payload 一致。
5.描述
此 Webhook 的功能描述，可选项。
Last modified: 16 十月 2024