跳转到主要内容
使用此端点永久删除 Webhook 端点。删除后,VelaFi 会立即停止向关联 URL 发送事件通知。已删除的 Webhook 会以 status: 30 出现在Webhook 列表中,但无法恢复——如需重新注册相同的 URL 或事件类型,请创建新的 Webhook。
所有请求都必须在 X-BH-TOKEN 请求头中携带通过 GET /v2/token/generate 获取的令牌(请参阅认证)。删除操作不可撤销。

端点

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

路径参数

string
必填
要删除的 Webhook 的唯一 ID。可从 Webhook 列表的响应中获取。

响应字段

number
HTTP 风格的响应码。200 表示成功。
string
可读的状态消息,例如 SUCCESS。
boolean
Webhook 已删除时为 true。

示例

cURL
Response
删除操作是永久性的,无法撤销。在某事件类型没有任何有效 Webhook 期间发生的事件不会进入队列。已在队列中的事件不会被取消:如果您在约 15 天内为相同事件类型创建了新的 Webhook,这些事件将携带已删除 Webhook 的 webhookId 投递到新 Webhook 的 URL。如需持续接收事件,请立即创建新的 Webhook。