面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/get-webhook-event-api.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

查询 Webhook 事件详情

GET https://ark.cn-beijing.volces.com/api/v3/webhook_endpoints/{endpoint_id}/events/{event_id}

查询指定 Webhook 接入点在最近 7 天内关联的单个事件信封。响应是投递时保存的冻结信封,与回调请求体一致。

接口不返回投递状态或逐次重试明细,也不会重新读取业务资源。接入点停用后仍可查询;删除接入点后,在 7 天墓碑保留期内仍可查询尚未过期的关联事件。

鉴权#

本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。

  • API Key 鉴权,请在 API Key 管理 页面,获取长效 API Key。

请求参数#

Path 参数#

endpoint_id string 必选  |  接入点 ID

Webhook 接入点 ID,以 wep- 开头。该 ID 可从创建或接入点列表接口的响应中获取。

event_id string 必选  |  事件 ID

Webhook 事件 ID,以 whe- 开头。该事件必须曾与指定接入点关联且仍在 7 天保留期内。

响应参数#

created_at string  |  发生时间

事件发生时间,采用 RFC 3339 格式。

data object  |  事件数据

事件类型、资源 ID 和该事件需要的关联上下文。各事件的字段语义请参见 Webhook 事件结构参考。

id string  |  资源 ID

data.id

触发事件的资源 ID。线程事件返回所属 Session ID;测试事件返回被测试的接入点 ID。

type string  |  事件类型

data.type

Webhook 事件类型。支持的取值和触发条件请参见 Webhook 事件结构参考。

session_thread_id string  |  线程 ID

data.session_thread_id

发生状态变化的 Session 线程 ID。仅线程状态事件返回该字段。

vault_id string  |  Vault ID

data.vault_id

凭证所属的 Vault ID。仅 Vault 凭证事件返回该字段。

id string  |  事件 ID

Webhook 事件 ID,以 whe- 开头。该值与回调请求的 webhook-id 请求头一致。

type string  |  对象类型

对象类型,固定为 event。