事件 · Webhook 服务事件
webhook.ping
测试事件
由 POST /v1/webhooks/{webhook_id}/test 发送的测试事件。无法订阅该事件,它也不会写入事件记录。
- 对象类型
- webhook
- 投递对象
- 具有 admin 角色的 Webhook
有效负载
idstring必填事件 ID(
evt_…),也会作为webhook-id头发送。可用于丢弃重复的投递。typestring必填可选值:
webhook.pingcreated_atstring (date-time)必填变更发生的时间(UTC)。
org_idinteger必填api_versionstring必填data结构定义的契约版本。sequenceinteger在该 Webhook 内的投递序号(测试事件不返回)。
payloadstring必填thin表示没有data:请通过 API 读取对象。可选值:
fullthindataobject字段
endpoint_idinteger必填messagestring必填requested_byinteger | null
testboolean必填由
POST /v1/webhooks/{webhook_id}/test发送的测试事件。
投递示例
{
"id": "evt_0123456789abcdef0123456789abcdef",
"type": "webhook.ping",
"created_at": "2026-10-24T10:00:03Z",
"org_id": 1,
"api_version": "1.62.0",
"object": {
"type": "webhook",
"id": "4"
},
"payload": "full",
"data": {
"endpoint_id": 4,
"message": "Test event from the knowledge platform",
"requested_by": 7
},
"test": true
}接收事件
每次投递都是向 Webhook 接收地址发送的 POST 请求,请求体就是这个 JSON。先验证 webhook-signature 头(Standard Webhooks),再信任请求体;在几秒内返回 2xx 状态,之后再处理。投递到同一个 Webhook 的事件保持原有顺序;投递失败时按逐渐拉长的间隔重试。
随时可能新增事件类型和字段:跳过不认识的类型和字段。