Webhook 集成

透過 Webhook 集成功能，您可以在 Thordata Web Scraper 抓取任務發生特定事件時，自動向指定系統發送通知，實時掌握任務狀態或將資料推送到其他服務中。Webhook 支援動態注入資料，便於後續自動化處理或業務聯動。

集成設定：

1. 集成功能名稱 用於識別和管理該 Webhook 設定。建議自定義一個清晰易懂的名稱，方便後續查看與維護。

2. 事件類型 您可以為以下任務事件設定觸發通知：

• 執行中：任務正在執行

• 任務成功：抓取任務已成功完成，並返回結果

• 任務失敗：抓取任務未返回任何資料或發生錯誤

1. 發送通知的方式 當選定事件發生時，系統將向您設定的 URL 發送一條 HTTP POST 請求，請求體為 JSON 格式，內容可自定義，並可透過變數動態注入事件資料。

① 有效負載（Payload） 格式說明：Payload 模板必須是合法的 JSON 字串，並可使用雙大括號 {{ }} 引用變數，例如：

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

② 可用變數：

變數名稱	類型	說明
userId	string	觸發事件的 Thordata 使用者 ID
createdAt	string	Webhook 觸發時間（ISO 格式）
eventType	string	目前觸發的事件類型
eventData	Object	與該事件相關的上下文資料
resource	Object	事件資源的詳細資料（如檔案連結、任務 ID 等）
globals	Object	目前事件日期（ISO 8601 格式）

③ 示例：

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

}

對應說明：

中文名稱	對應名
使用者ID	userId
使用者帳號ID	userName
建立時間	createdAt
狀態：成功/失敗	eventType
事件的相關資料	eventData
產品唯一編號	prodect_id
API 任務 ID	apiRunId
任務資源	resource
任務 ID	taskId
抓取參數	url
抓取 Token	apiKey
API 請求 URL	apiUrl
API 回應碼	apiCode
回應時間	apiResponseTime
錯誤訊息	apiErrorMsg
API 結果	apiResult
錯誤次數	errorNumber
成功率	successRate
執行秒數	runseconds
任務細節	detail
流量消耗	flow
檔案大小	fileSize
抓取類型	type
CSV 下載連結	csvUrl
JSON 下載連結	jsonUrl
音訊連結	audioUrl
影片連結	videoUrl
字幕連結	subtitleUrl
任務開始時間	createdAt
任務結束時間	finishedAt

1. Headers 模板（可選） Headers 模板是一個類似 JSON 的字串，您可在其中向 webhook 請求的預設 header 添加附加資訊。您可以像在 Payload 模板中一樣傳遞變數（包括使用字串插值與可用變數）。生成的 headers 必須是有效的 JSON 物件，且值只能為字串。

請注意，以下鍵是系統預設且會被覆蓋：

• Host：請求 URL

• Content-Type：application/json

• Webhook：Tasks 值

• Webhook-Dispatch-Id：Tasks id

• Request-Origin

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