按 event_id 倒序返回指定 Webhook 最近 7 天的投递事件,每个事件包含当前 Webhook 的 delivery 信息。没有匹配记录时返回空数组;Webhook 删除后,已有投递事件在 7 天保留期内仍可查询。
前提
已完成 Endpoint 与鉴权配置,详见API 总览与认证。
接口
GET /webhook_endpoints/{id}/events
路径参数
| 参数 | 必填 | 类型 | 说明 |
|---|---|---|---|
id | 是 | string | Webhook ID,格式 wep_<ULID> |
Query 参数
| 参数 | 必填 | 类型 | 说明 |
|---|---|---|---|
limit | 否 | integer | 每页数量,默认 20,范围 1~100 |
page | 否 | string | 不透明分页游标;首页不传,后续传上一页返回的 next_page |
请求示例
响应
响应包含 data(Webhook对象数组)与 next_page(下一页游标,无更多数据时为 null)。
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
data | array<object> | 事件对象数组 |
data[].type | string | 固定为 event |
data[].id | string | 事件 ID,格式 whe_<ULID>;同一事件的所有投递尝试使用相同外层 id |
data[].created_at | string | 事件创建时间,ISO 8601 |
data[].data | object | 事件载荷 |
data[].data.id | string | 资源标识;Thread 事件中为 Session 标识 |
data[].data.type | string | 事件类型 |
data[].data.workspace_id | string | 工作空间 ID |
data[].data.session_thread_id | string | Thread 事件中为具体 Thread 标识 |
data[].delivery | object | 当前 Webhook 的投递信息 |
data[].delivery.webhook_id | string | Webhook ID |
data[].delivery.status | string | 投递状态,如 SUCCEEDED |
data[].delivery.attempt_count | integer | 投递尝试次数 |
data[].delivery.delivery_at | string | 投递开始时间,ISO 8601 |
data[].delivery.finish_at | string | 投递完成时间,ISO 8601 |
data[].delivery.failure_reason | string | null | 失败原因;成功时为 null |
next_page | string | null | 下一页游标,末页为 null |
request_id | string | 本次请求的唯一标识,排查问题时附带 |
错误码
| 状态码 | 错误码 | 说明 |
|---|---|---|
| 400 | 11800016 | invalid webhook event query |