根据 Endpoint ID 获取当前配置和投递状态摘要。
Webhook 当前为 Beta 功能,接口、字段和行为可能在后续版本中调整。
GET /api/v1/forward/webhook/endpoints/{endpoint_id}
请求头
| Header | 是否必填 | 说明 |
|---|---|---|
Authorization | 是 | Bearer <PAT 或管理员 SAT> |
路径参数
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
endpoint_id | string | 是 | Webhook Endpoint ID。 |
示例请求
示例响应
HTTP 200 OK
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
id | string | Endpoint ID。 |
url | string | 事件接收地址。 |
description | string | Endpoint 描述;未设置时可能省略。 |
events | string[] | 当前订阅事件。 |
metadata | object | Endpoint 元数据。 |
active | boolean | Endpoint 是否接收事件。 |
last_success_at | string/null | 最近一次成功投递时间,RFC 3339 格式。 |
last_failure_at | string/null | 最近一次失败投递时间,RFC 3339 格式。 |
disabled_reason | string | 停用原因;没有原因时省略。 |
consecutive_fail | integer | 连续投递失败次数。 |
created_at | string | 创建时间,RFC 3339 格式。 |
updated_at | string | 更新时间,RFC 3339 格式。 |
signing_secret 不会通过该接口返回。
错误
| HTTP | Type | 触发条件 |
|---|---|---|
401 | authentication_error | 认证信息缺失、无效或已过期。 |
403 | permission_error | 当前令牌不能管理 Webhook。 |
404 | not_found_error | Endpoint 不存在或当前账号不可见。 |
500/502/503 | api_error | 服务暂时不可用。 |

