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

发送 Webhook 测试事件

POST https://ark.cn-beijing.volces.com/api/v3/webhook_endpoints/{endpoint_id}/test

生成并异步投递一个 webhook.test 测试事件。启用和停用状态下均可调用,测试事件不受订阅事件列表过滤。

接口返回 200 表示测试事件已生成并受理,不表示回调地址已经收到事件。测试事件只尝试投递一次;普通接收失败不改变接入点状态,不更新业务投递统计,也不会自动启用接入点。

每次调用都会生成新的测试事件。请求超时后直接重试可能导致接收端收到多个不同事件 ID 的测试通知。

鉴权#

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

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

请求参数#

Path 参数#

endpoint_id string 必选  |  接入点 ID

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

响应参数#

created_at string  |  生成时间

Webhook 测试事件的生成时间,采用 RFC 3339 格式。

data object  |  事件数据

Webhook 测试事件的数据。

id string  |  接入点 ID

data.id

被测试的 Webhook 接入点 ID,与请求路径中的 endpoint_id 相同。

type string  |  事件类型

data.type

事件类型,固定为 webhook.test。

id string  |  事件 ID

Webhook 测试事件 ID,以 whe- 开头。回调正文和 webhook-id 请求头使用相同值。

type string  |  对象类型

对象类型,固定为 event。