Webhook 集成

Webhook 集成功能說明： 該功能是用於指定 Web Scraper API 抓取任務發生特定事件時發送通知。讓您可以動態將數據添加到通知負載中。

集成功能名稱： 用於定義集成任務的名稱，為了方便您的管理，建議您自定義名稱。

事件類型： 創建成功：成功創建新的抓取任務 創建失敗：創建抓取任務時失敗 運行中：抓取任務正常抓取中 任務成功：抓取任務的抓取成功返回數據 任務失敗：抓取任務未返回內容

發送通知： 您可以使用 HTTP 請求操作發送通知，該操作會向指定的 URL 發送包含 JSON 有效負載的 HTTP POST 請求。有效負載使用有效負載模板定義，該模板是一種類似 JSON 的語法，允許您使用包含雙花括號括起來的變數 {{variable}}。這使得在觸發 Webhook 時能夠將數據動態注入到有效負載中。

1. 有效載荷： 有效負載模板是一個類似 JSON 格式的字符串，它允許您自定義有效負載結構，並注入僅在 Webhook 調用時已知的動態數據。除了變數之外，該字符串也必須是有效的 JSON 格式。 變數必須用雙花括號括起來，並且只能使用「可用變數」部分列出的預定義變數。使用任何其他變數將導致驗證錯誤。

變數的語法是：{{oneOfAvailableVariables}}。變數支持使用點符號訪問嵌套屬性：{{variable.property}}。

① 預設有效載荷：

{
"userId": "{{userId}}",
"createdAt": "{{createdAt}}",
"eventType": "{{eventType}}",
"eventData": "{{eventData}}",
"resource": "{{resource}}"
}

② 可用變數： userId：string，擁有該 webhook 的 Thordata 用戶 ID。 createdAt：string，Webhook 觸發事件的時間的 ISO 字符串格式。 eventType：string，觸發事件的類型。 eventData：Object，與觸發事件相關聯的數據。 resource：Object，事件的資源。 globals：Object，全局上下文中可用的數據。包含 dateISO（Webhook 觸發事件的日期，ISO 8601 格式）和 dateUnix（觸發事件的日期，Unix 時間戳，秒）。 可自定義變數，例如："text": "My user id is {{userId}}"

③ 示例：

{
"createdAt": "2025-06-07T06:33:14Z",
"eventData": {
"actorId": "H5PMBR7kx5OMBBwS",
"actorRunId": "n6QWqyUOraU4AAvO"
},
"eventType": "ACTOR.RUN.SUCCEEDED",
"resource": {
"apiCode": 400,
"apiErrorMsg": "",
"apiKey": "289f5c53e47d616********************",
"apiResponseTime": 28000,
"apiResult": "",
"apiUrl": "",
"audioUrl": "",
"createdAt": "2025-06-07T14:33:14+08:00",
"csvUrl": "https://th-scrapers-1303252866.cos.na-siliconvalley.myqcloud.com/scrapers/thordata/2025/06/07/2e9ddee0582a40a9****************.csv",
"errorNumber": 1,
"fileSize": 1765,
"finishedAt": "2025-06-07T14:33:44+08:00",
"flow": 1765,
"jsonUrl": "https://th-scrapers-1303252866.cos.na-siliconvalley.myqcloud.com/scrapers/thordata/2025/06/07/2e9ddee0582a40a9****************.json",
"prodect_id": 3,
"subtitleUrl": "",
"successRate": 0,
"taskId": "2e9ddee0582a40a9b1f459831b1419e1",
"type": 0,
"url": "{"spider_errors":true,"spider_id":"3","spider_parameters":[{"url":"https://www.amazon.com/dp/B0DPMHRZ1W?th=1\u0026psc=1"}]}",
"userId": 3406,
"userName": "Thor8444****",
"videoUrl": ""
},
"userId": 3406
}

1. 標題模板： headers 模板是一个类似 JSON 的字符串，您可以在其中向 webhook 请求的默认 header 添加附加信息。您可以像在有效负载模板中一样传递变量（包括使用字符串插值和可用变量）。生成的 headers 必须是有效的 JSON 对象，并且值只能是字符串。 请注意，以下键是硬编码的，并且将始终被重写：

可用變數： Host：請求 URL Content-Type：application/json Webhook： Tasks 值 Webhook-Dispatch-Id： Tasks id Request-Origin

如果您需要更多幫助，請通過郵箱 [e-mail] 聯繫我們。