Webhook là gì?

Một webhook là một điểm cuối HTTP mà bạn cung cấp, và chúng tôi sẽ gửi một yêu cầu POST đến đó khi nhiệm vụ của bạn hoàn thành — cho dù thành công hay thất bại. Điều này loại bỏ nhu cầu liên tục kiểm tra API và cho phép hệ thống của bạn phản hồi theo thời gian thực.

Cách sử dụng Webhook

Khi tạo nhiệm vụ, hãy bao gồm trường webhook.url trong yêu cầu của bạn. Ví dụ:

{
  "actor": "scraper.shopee",
  "webhook": {
    "url": "https://webhook.site/8fe8b27a-3902-42d9-a44e-b5e74466e475"
  },
  "input": {
    "url": "https://shopee.tw/api/v4/pdp/get_pc?item_id=1413075726&shop_id=19675194"
  }
}
 

Payload Webhook

Khi nhiệm vụ hoàn tất, chúng tôi sẽ POST kết quả đến URL webhook của bạn.

Payload thành công

{
  "response": {
    "data": "base64 json string",
    "encoding": "base64"
  },
  "state": "completed",
  "success": true,
  "taskId": "7a0087db-05ae-4caf-887c-67e5efcaf3d1"
}
 

Payload thất bại

{
  "state": "completed",
  "status": {
    "code": 4,
    "message": "context deadline exceeded"
  },
  "success": false,
  "taskId": "d5f188a7-9d87-4f7d-8801-5a7c6083b3e6"
}
 

Vẫn muốn tự kiểm tra?

Không vấn đề gì — bạn luôn có thể tự lấy kết quả:

curl --location --request GET 'https://api.scrapeless.com/api/v1/scraper/result/{taskId}' \
--header 'x-api-token: YOUR_API_KEY' \
--header 'Content-Type: application/json'
 

Điều này hoạt động cho dù có thiết lập webhook hay không.

Hãy thử

Kiểm tra webhook của bạn ngay lập tức bằng Webhook.site — một công cụ miễn phí tạo ra các URL có thể kiểm tra và hiển thị cho bạn các yêu cầu đến theo thời gian thực.

Câu hỏi thường gặp

Q: Bạn sẽ thử lại webhook nếu nó thất bại?

Hiện tại thì chưa. Hãy đảm bảo điểm cuối của bạn đáng tin cậy và khả dụng.

Q: Các cuộc gọi webhook có đồng bộ không?

Không — chúng tôi gửi chúng không đồng bộ, vì vậy nó sẽ không chặn quá trình xử lý nhiệm vụ.