Події · Службові події вебхуків
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 протягом кількох секунд, а саму роботу виконуйте вже після відповіді. Доставки на один вебхук зберігають порядок подій; невдала доставка повторюється зі зростаючими паузами.
Нові типи подій і нові поля можуть з’явитися будь-коли: пропускайте типи й поля, яких ви не знаєте.