Browse AI

Retrieve a robot's webhooks

开发环境

http://dev-cn.your-api-server.com

GET

/robots/{robotId}/webhooks

webhooks

Retrieve a robot's webhook list.

请求示例

Java

Objective-C

Shell

curl --location --request GET 'http://dev-cn.your-api-server.com/robots/c3689adb-50aa-44af-b265-a7e0d4e5846e/webhooks' \
--header 'authorization: Bearer YOUR_SECRET_API_KEY'

响应示例

200 - 示例 1

{
    "statusCode": 200,
    "messageCode": "success",
    "webhooks": {
        "totalCount": 10,
        "items": [
            {
                "id": "6d7f1218-43fb-4735-ac71-21e81b1ab23e",
                "url": "https://example.com/v2/webhooks/callback/events",
                "webhookEvent": "taskCapturedDataChanged",
                "createdAt": 1678795867879
            }
        ]
    }
}

请求参数

Path 参数

robotId

string

必需

Unique robot ID

You can find a robot's ID by opening it on the dashboard and copying its ID in the browser address bar.

示例值:

c3689adb-50aa-44af-b265-a7e0d4e5846e

Header 参数

authorization

string

必需

You can generate a new API key on your dashboard if you do not have one.

示例值:

Bearer YOUR_SECRET_API_KEY

返回响应

🟢200A JSON including monitors list.

application/json

Body

statusCode

enum<number>

必需

枚举值:

200

messageCode

enum<string>

必需

枚举值:

success

webhooks

object

必需

totalCount

number

必需

Total number of webhooks this robot has

示例值:

items

array[object (Webhook) {4}]

必需

Array of all webhooks

🟠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

修改于 2024-02-20 02:11:12

Retrieve a robot's bulk run

Create a new webhook on a robot