删除 Webhook
接口说明
通过 webhookId 删除单个 Webhook 订阅。
接口信息
| 字段 | 值 |
|---|---|
| 方法 | DELETE |
| 路径 | /openapi/v2/webhooks/{webhookId} |
| Operation ID | deleteWebhook |
| 鉴权 | Bearer OpenAPI key |
入参
| 名称 | 位置 | 必填 | 类型 | 示例 | 说明 |
|---|---|---|---|---|---|
webhookId | path | 是 | string | webhook-11111111-1111-4111-8111-111111111111 | Webhook API 返回的 Webhook 标识。 |
请求体
这个接口没有请求体。
请求示例
bash
curl -X DELETE "https://openapi.example.com/openapi/v2/webhooks/webhook-11111111-1111-4111-8111-111111111111" \
-H "Authorization: Bearer <openapi-key>"成功响应
200
返回 Webhook 订阅删除确认。
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
deleted | 是 | boolean | 请求的资源是否已经删除。 |
webhookId | 是 | string | 已删除的 Webhook 标识。 |
成功响应示例
json
{
"deleted": true,
"webhookId": "webhook-11111111-1111-4111-8111-111111111111"
}错误码
下表列出这个接口已声明的全部错误响应。
| HTTP 状态 | 错误码 | 说明 |
|---|---|---|
| 401 | UNAUTHORIZED | Bearer API key 缺失、格式错误、未知、已撤销或已删除。 |
| 404 | NOT_FOUND | 请求的资源不存在。 |
| 429 | RATE_LIMITED | 请求超过当前配置的速率限制。 |
| 500 | INTERNAL_ERROR | API 遇到内部错误。 |
| 503 | DATABASE_REPOSITORY_UNAVAILABLE | 当前接口所需的数据暂时不可用。 |