手动禁用 Webhook。请求体为空。禁用后不再投递新的事件,已产生但尚未投递的事件会被取消。
前提
已完成 Endpoint 与鉴权配置,详见API 总览与认证。
接口
POST /webhook_endpoints/{id}/disable
路径参数
| 参数 | 必填 | 类型 | 说明 |
|---|---|---|---|
id | 是 | string | Webhook ID,格式 wep_<ULID> |
请求示例
响应
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
id | string | — |
description | string | null | — |
url | string | — |
events | array<string> | — |
status | string | 禁用后为 DISABLED |
disabled_reason | string | null | 手动禁用为 MANUAL |
consecutive_fail | integer | 返回禁用完成时的当前值 |
last_success_at | string | null | 返回禁用完成时的当前值 |
last_failure_at | string | null | 返回禁用完成时的当前值 |
created_at | string | — |
updated_at | string | — |
request_id | string | 本次请求的唯一标识,排查问题时附带 |
错误码
| 状态码 | 错误码 | 说明 |
|---|---|---|
| 404 | 11800001 | webhook not found |