Browse AI
  1. webhooks
Browse AI
  • system
    • Endpoint for checking the status of Browse AI infrastructure
      GET
  • internal
    • Retrieve list of teams under user account
      GET
  • robots
    • Retrieve list of robots under your account
      GET
    • Retrieve single robot by ID
      GET
    • Update a robot's cookies
      PATCH
  • tasks
    • Get all tasks by a robot
      GET
    • Run a robot
      POST
    • Retrieve a task
      GET
  • monitors
    • Retrieve a robot's monitors
      GET
    • Create a new monitor on a robot
      POST
    • Retrieve a robot's monitor
      GET
    • Update a robot's monitor
      PATCH
    • Delete a robot's monitor
      DELETE
  • bulk runs
    • Bulk run tasks
      POST
    • Retrieve a robot's bulk runs list
      GET
    • Retrieve a robot's bulk run
      GET
  • webhooks
    • Retrieve a robot's webhooks
      GET
    • Create a new webhook on a robot
      POST
    • Delete a robot's webhook
      DELETE
  1. webhooks

Create a new webhook on a robot

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
/robots/{robotId}/webhooks
Create a new webhook on a robot

请求参数

Path 参数

Header 参数

Body 参数application/json

示例

返回响应

🟢200A JSON object containing the newly created monitor.
application/json
Body

🟠400A JSON containing error attributes. This will happen if any of the parameters are not valid.
🟠401The request is not authorized
🟠404The resource is not found
🔴500There was an error on the server
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --request POST \
  --url https://api.browse.ai/v2/robots/{robotId}/monitors \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --data '{"name":"Monitor products","inputParameters":{"originUrl":"https://www.espressozone.com/espresso-machines/semi-automatic-espresso-machines"},"schedule":"FREQ=HOURLY;INTERVAL=1;BYWEEKDAY=MO,TU,WE,TH,FR","notifyOnCapturedScreenshotChange":true,"notifyOnCapturedTextChange":true,"capturedScreenshotNotificationThreshold":15}'
响应示例响应示例
200 - 示例 1
{
    "statusCode": 200,
    "messageCode": "success",
    "webhook": {
        "id": "6d7f1218-43fb-4735-ac71-21e81b1ab23e",
        "url": "https://example.com/v2/webhooks/callback/events",
        "webhookEvent": "taskCapturedDataChanged",
        "createdAt": 1678795867879
    }
}
修改于 2024-02-20 02:11:12
上一页
Retrieve a robot's webhooks
下一页
Delete a robot's webhook
Built with