Към съдържанието
Sursa Developers

Събития · Служебни събития на уебхуковете

webhook.ping

Тестово събитие

Тестово събитие, изпратено от POST /v1/webhooks/{webhook_id}/test. За него не може да се абонирате и то не се записва в лентата със събития.

Тип на обекта
webhook
Получатели
Уебхуковете с ролята admin

Тяло на доставката

Обект: EventWebhookPing

  • idstringзадължително

    ID на събитието (evt_…), изпраща се и като заглавката webhook-id. Използвайте го, за да отхвърляте дублираните доставки.

  • typestringзадължително

    Допустими стойности: webhook.ping

  • created_atstring (date-time)задължително

    Кога е настъпила промяната (UTC).

  • org_idintegerзадължително
  • api_versionstringзадължително

    Версия на API, на която отговаря схемата 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 дни в лентата със събития →