更新 Endpoint 的接收地址、描述、订阅事件或元数据。
Webhook 当前为 Beta 功能,接口、字段和行为可能在后续版本中调整。
PUT /api/v1/forward/webhook/endpoints/{endpoint_id}
仅修改请求中出现的字段。省略字段会保留原值。
请求头
| Header | 是否必填 | 说明 |
|---|---|---|
Authorization | 是 | Bearer <PAT 或管理员 SAT> |
Content-Type | 是 | application/json |
路径参数
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
endpoint_id | string | 是 | Webhook Endpoint ID。 |
请求体参数
| 字段 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
url | string | 否 | 新的事件接收地址。生产环境建议使用 HTTPS。 |
description | string | 否 | 新的用途说明。 |
events | string[] | 否 | 替换完整订阅列表,至少包含一项。支持 * 或具体事件名,不支持前缀通配符。 |
active | boolean | 否 | Endpoint 是否启用;也可使用单独的启用或停用接口。 |
metadata | object | 否 | 合并更新自定义元数据;值为字符串,传入 null 可删除对应键。 |
示例请求
示例响应
HTTP 200 OK
signing_secret。
错误
| HTTP | Type | 触发条件 |
|---|---|---|
400 | invalid_request_error | URL、事件列表、Metadata 或请求体不合法。 |
401 | authentication_error | 认证信息缺失、无效或已过期。 |
403 | permission_error | 当前令牌不能管理 Webhook。 |
404 | not_found_error | Endpoint 不存在或当前账号不可见。 |
413 | invalid_request_error | 请求体过大。 |
500/502/503 | api_error | 服务暂时不可用。 |

