События · Служебные события вебхуков
webhook.ping
Проверочное событие
Проверочное событие, которое отправляет POST /v1/webhooks/{webhook_id}/test. На него нельзя подписаться, и оно не записывается в ленту событий.
- Тип объекта
- webhook
- Кому доставляется
- Вебхукам с ролью администратора
Тело доставки
idstringобязательноID события (
evt_…), передаётся также в заголовкеwebhook-id. По нему отбрасывайте повторные доставки.typestringобязательноДопустимые значения:
webhook.pingcreated_atstring (date-time)обязательноКогда произошло изменение (UTC).
org_idintegerобязательноapi_versionstringобязательноВерсия контракта схемы
data.sequenceintegerПорядковый номер доставки в пределах вебхука (нет у проверочного события).
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
}Получение событий
Каждая доставка — это POST-запрос с таким JSON-телом на адрес вашего вебхука. Прежде чем доверять телу, проверьте заголовок webhook-signature (Standard Webhooks), ответьте статусом 2xx в течение нескольких секунд, а саму работу выполняйте уже после ответа. Доставки на один адрес сохраняют порядок событий; неудачная доставка повторяется с нарастающими паузами.
Новые типы событий и новые поля могут появиться в любой момент: пропускайте типы и поля, которых не знаете.