向指定 Endpoint 发送一个测试事件,用于验证接收地址和签名处理。
Webhook 当前为 Beta 功能,接口、字段和行为可能在后续版本中调整。
POST /api/v1/forward/webhook/endpoints/{endpoint_id}/test
测试事件类型为 webhook.test,无需将它加入 Endpoint 的订阅列表。投递是异步的,接口返回成功表示测试事件已被接受,不表示接收端已经处理完成。
调用前请先确保 Endpoint 已启用。Endpoint 已停用时,接口仍可能返回 202,但 delivery_rows 为 0 且不会产生回调。
请求头
| Header | 是否必填 | 说明 |
|---|---|---|
Authorization | 是 | Bearer <PAT 或管理员 SAT> |
路径参数
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
endpoint_id | string | 是 | Webhook Endpoint ID。 |
示例请求
示例响应
HTTP 202 Accepted
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
event_id | integer | 本次测试请求的标识。 |
delivery_rows | integer | 本次测试已接受的投递任务数量。 |
错误
| HTTP | Type | 触发条件 |
|---|---|---|
401 | authentication_error | 认证信息缺失、无效或已过期。 |
403 | permission_error | 当前令牌不能管理 Webhook。 |
404 | not_found_error | Endpoint 不存在或当前账号不可见。 |
500/502/503 | api_error | 测试事件暂时无法发送。 |

