通过 HTTP 回调接收 Forward 资源和异步任务的状态变化。
Webhook 当前为 Beta 功能，接口、字段和行为可能在后续版本中调整。
POST 请求。Webhook 适合接收 Schedule Run 等无法依赖长连接等待的异步结果。
本组接口只管理当前个人空间或当前企业 Workspace 下、通过 Forward Mode 创建的 Endpoint。其他空间或其他模式创建的 Endpoint 不会出现在列表中，也不能通过本组接口操作。
接口
| 方法 | 路径 | 说明 |
|---|---|---|
POST | /api/v1/forward/webhook/endpoints | 创建 Endpoint |
GET | /api/v1/forward/webhook/endpoints | 列出 Endpoints |
GET | /api/v1/forward/webhook/endpoints/{endpoint_id} | 获取 Endpoint |
PUT | /api/v1/forward/webhook/endpoints/{endpoint_id} | 更新 Endpoint |
DELETE | /api/v1/forward/webhook/endpoints/{endpoint_id} | 删除 Endpoint |
POST | /api/v1/forward/webhook/endpoints/{endpoint_id}/enable | 启用 Endpoint |
POST | /api/v1/forward/webhook/endpoints/{endpoint_id}/disable | 停用 Endpoint |
POST | /api/v1/forward/webhook/endpoints/{endpoint_id}/test | 发送测试事件 |
认证
Webhook Endpoint 是管理类资源。以上接口接受 Qoder PAT 或管理员 Service Account Token：
公开事件
Forward 当前公开以下 Schedule 事件：
| 事件类型 | 触发时机 |
|---|---|
forward.schedule.created | Schedule 创建成功。 |
forward.schedule_run.succeeded | Schedule Run 成功完成。 |
forward.schedule_run.failed | Schedule Run 执行失败。 |
events 接受 *，或者符合 namespace.name 形式的具体事件名。订阅 * 可以接收当前及未来可投递的全部事件；前缀通配符（例如 forward.*）不受支持。只有公开事件目录中的事件具有投递契约，生产环境建议显式订阅所需的公开事件。
事件载荷、签名校验和幂等处理见 接收 Webhook 事件。
使用流程
- 准备一个可接收公网 HTTPS
POST请求的地址。 - 创建 Endpoint，并安全保存创建响应中的
signing_secret。 - 调用测试接口验证网络连通性和签名处理。
- 订阅所需事件，并使用
Webhook-ID对重复投递去重。
2xx，再异步处理耗时业务。