Create a new webhook on a robot

curl --location --request POST 'http://dev-cn.your-api-server.com/robots/c3689adb-50aa-44af-b265-a7e0d4e5846e/webhooks' \ --header 'authorization: Bearer YOUR_SECRET_API_KEY' \ --header 'Content-Type: application/json' \ --data-raw '{ "hookUrl": "https://example.com/v2/webhooks/callback/events", "eventType": "taskCapturedDataChanged" }'

{ "statusCode": 200, "messageCode": "success", "webhook": { "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

Body 参数application/json

hookUrl

string

必需

Webhook URL

示例值:

https://example.com/v2/webhooks/callback/events

eventType

enum<string>

必需

枚举值:

taskCapturedDataChangedtaskFinishedtaskFinishedSuccessfullytaskFinishedWithError

示例值:

taskFinished

示例

返回响应

🟢200A JSON object containing the newly created monitor.

application/json

Body

statusCode

enum<number>

必需

枚举值:

200

messageCode

enum<string>

必需

枚举值:

success

webhook

object (Webhook)

必需

string

必需

Unique webhook ID

示例值:

6d7f1218-43fb-4735-ac71-21e81b1ab23e

url

string

必需

Webhook URL

示例值:

https://example.com/v2/webhooks/callback/events

webhookEvent

enum<string>

必需

枚举值:

taskCapturedDataChangedtaskFinishedtaskFinishedSuccessfullytaskFinishedWithError

示例值:

taskFinished

createdAt

integer

必需

Monitor creation date and time in the form of a Unix timestamp.

示例值:

1678795867879

🟠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