Перейти до вмісту
Sursa Developers

Події · Службові події вебхуків

webhook.ping

Тестова подія

Тестова подія, яку надсилає POST /v1/webhooks/{webhook_id}/test. На неї не можна підписатися, і вона не записується до стрічки подій.

Тип об’єкта
webhook
Кому доставляється
Вебхукам із роллю адміністратора

Вміст події

Об’єкт: EventWebhookPing

  • idstringобов’язково

    ID події (evt_…), також надсилається в заголовку webhook-id. За ним відкидайте дублікати доставок.

  • typestringобов’язково

    Допустимі значення: webhook.ping

  • created_atstring (date-time)обов’язково

    Коли сталася зміна (UTC).

  • org_idintegerобов’язково
  • api_versionstringобов’язково

    Версія договору для схеми data.

  • sequenceinteger

    Порядковий номер доставки в межах вебхука (немає для тестової події).

  • objectWebhookEventObjectобов’язково
  • payloadstringобов’язково

    thin означає, що data немає: читайте об’єкт через API.

    Допустимі значення: fullthin

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

Нові типи подій і нові поля можуть з’явитися будь-коли: пропускайте типи й поля, яких ви не знаєте.

Ті самі події 30 днів зберігаються в стрічці подій →