如何为 Web Unlocker API 设置 Webhooks

了解 webhooks 的工作原理

使用异步请求时，Web Unlocker API 在后台处理作业。您可以配置一个 webhook，而不是轮询结果。Webhook 是一个 HTTP 端点，当您的作业完成时，Bright Data 会调用它。流程如下：

发送异步请求
接收 response_id
Bright Data 处理请求
Bright Data 向您的 webhook_url 发送通知
使用 response_id 检索结果

Webhooks 通知您作业何时准备就绪，但不包括完整的响应正文。

前置条件

以下为必需项：

创建 webhook 端点

您需要一个可公开访问的 URL 来接收 webhook 通知。

为了演示目的，我们将使用 webhook.site。它可以立即生成一个临时 webhook URL，并让您实时检查传入的请求，包括标头、查询参数和有效负载。

发送带有 webhook 的异步请求

将 webhook_url 参数添加到您的请求：

cURL

curl --request POST \
  --url 'https://api.brightdata.com/unblocker/req?zone=<unlocker-zone-name>' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://geo.brdtest.com/welcome.txt",
    "webhook_url": "https://webhook.site/<webhook-url-id>",
  }'

  import requests

  url = "https://api.brightdata.com/unblocker/req?zone=<unlocker-zone-name>"

  payload = {
      "url": "https://geo.brdtest.com/welcome.txt",
      "webhook_url": "https://webhook.site/<webhook-url-id>",
  }
  headers = {
      "Authorization": "Bearer <API_KEY>",
      "Content-Type": "application/json"
  }

  response = requests.post(url, json=payload, headers=headers)

  print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://geo.brdtest.com/welcome.txt',
    webhook_url: 'https://webhook.site/<webhook-url-id>',
  })
};

fetch('https://api.brightdata.com/unblocker/req?zone=<unlocker-zone-name>', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

将 <API_KEY>、<unlocker-zone-name>、<webhook-url-id> 替换为您的实际值。

接收 webhook 通知

请求处理完成后，Bright Data 向您的 webhook_url 发送 POST 请求。

// 典型的 webhook 请求包括：
{
  "status": 200,
  "response_id": "<RESPONSE_ID>",
  "request_url": "https://geo.brdtest.com/welcome.txt"
}

如果您使用 webhook.site，可以检查传入的请求，包括有效负载字段和标头（例如 user-agent）。

此 webhook 通知您请求已完成。

使用 response_id 检索结果

使用 webhook 中的 response_id 获取实际结果：

curl --silent --compressed \
  "https://api.brightdata.com/unblocker/get_result?response_id=<RESPONSE_ID>" \
  -H "Authorization: Bearer <API_KEY>" \
  -o results.json

然后检查输出：

cat results.json

该文件将包含完整响应，包括标头和正文。

可选将自定义数据附加到 webhook

您可以使用 webhook_data 包含自定义元数据。当使用 webhook_method 作为 POST 时，此数据将在 webhook 通知的请求正文中发送。

curl --request POST \
  --url 'https://api.brightdata.com/unblocker/req?zone=web_unlocker3' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://geo.brdtest.com/welcome.txt",
    "webhook_url": "https://webhook.site/a14a55b3-c3cc-4890-84f2-eeebe4b264a4",
    "webhook_method": "POST",
    "webhook_data": "{\"job_id\": \"my_job_123\", \"source\": \"test_script\"}"
  }'

webhook_data 字段在 webhook 通知中按原样返回。这允许您附加标识符（如作业 ID 或元数据），使将响应映射到您的内部工作流更加容易。

恭喜

您已成功为 Web Unlocker API 设置了 webhooks。您现在可以接收已完成作业的实时通知，并构建更高效、事件驱动的抓取工作流。

快速开始

数据提取

Web 访问

AI 训练数据

代理网络

如何为 Web Unlocker API 设置 Webhooks