跳到主要内容

删除 Webhook

按 ID 取消订阅一个 Webhook。删除是永久性的——签名密钥无法恢复，Webhook ID 也不会被复用。

端点​

DELETE /v1/webhooks/{id}

权重： 5 鉴权： 必须（已签名）——参见 鉴权。

路径参数​

名称类型必填说明
idstringYESWebhook 标识，格式为 wh_<6-8 hex>。

响应​

{
  "deleted": true,
  "id": "wh_2a4f10"
}

响应字段​

字段类型说明
deletedboolean成功响应时始终为 true。
idstring被删除 Webhook 的标识，回显以供确认。

行为说明​

  • 进行中的投递会跑完。 在 DELETE 调用发出时已经派发到你端点的任何投递都会运行至完成（成功、失败或超时），不会被中途取消。
  • 排队的重试会被丢弃。 在该 Webhook 重试队列中等待的事件会被丢弃，不会再被重新投递。
  • 不会再有新事件入队。 在 DELETE 成功返回之后产生的事件不会再与该 Webhook 匹配。

错误​

  • 403 INSUFFICIENT_PERMISSION —— API 密钥缺少 webhooks:write 范围。
  • 404 NOT_FOUND —— 该账户上不存在该 id 对应的 Webhook，或该 Webhook 已被删除。

完整列表参见 错误。

示例​

curl -X DELETE "https://api.pipai.example/v1/webhooks/wh_2a4f10" \
  -H "X-PipAI-API-Key: $API_KEY" \
  -H "X-PipAI-Timestamp: $TS" \
  -H "X-PipAI-Signature: $SIG"