跳转到主要内容
使用此端点修改现有的 Webhook。您可以更新回调 URL、更改状态以停用或重新启用推送,也可以同时进行这两项操作。webhookId 作为 URL 路径参数传入。更改会立即生效——停用 Webhook 后将停止事件推送,直到您重新启用它。Webhook 停用期间发生的事件不会进入队列,重新启用后也不会补发。已删除的 Webhook 无法更新。
所有请求都必须包含 X-BH-TOKEN 请求头和 Content-Type: application/json。

端点

PUT https://api.velafi.com/v2/webhook/{webhookId}

路径参数

string
必填
要更新的 Webhook 的唯一 ID。可从创建 Webhook或列出 Webhook的响应中获取。

请求参数

string
可选。此 Webhook 的新回调 URL,必须以 http 开头。如果省略,URL 保持不变。
number
可选。Webhook 的更新状态:10 = 启用,20 = 停用。30 会被拒绝——请改用删除 Webhook。如果省略,状态保持不变。

响应字段

number
HTTP 风格的响应码。200 表示成功。
string
人类可读的状态消息,例如 SUCCESS。
object

示例

cURL
Response
您无法更改现有 Webhook 的 eventType。如需监听其他事件,请创建新的 Webhook 并删除旧的 Webhook。