Události · Servisní události webhooků
webhook.ping
Testovací událost
Testovací událost odeslaná operací POST /v1/webhooks/{webhook_id}/test. Nelze ji odebírat a nezapisuje se do kanálu událostí.
- Typ objektu
- webhook
- Komu se doručuje
- Webhookům s rolí administrátora
Obsah události
idstringpovinnéID události (
evt_…), posílá se také jako hlavičkawebhook-id. Podle něj zahazujte duplicitní doručení.typestringpovinnéPovolené hodnoty:
webhook.pingcreated_atstring (date-time)povinnéKdy ke změně došlo (UTC).
org_idintegerpovinnéapi_versionstringpovinnéVerze kontraktu schématu
data.sequenceintegerPořadové číslo doručení v rámci webhooku (u testovací události chybí).
payloadstringpovinnéthinznamená bezdata: objekt si přečtěte přes API.Povolené hodnoty:
fullthindataobjectPole
endpoint_idintegerpovinnémessagestringpovinnérequested_byinteger | null
testbooleanpovinnéTestovací událost odeslaná pomocí
POST /v1/webhooks/{webhook_id}/test.
Ukázka doručení
{
"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
}Příjem událostí
Každé doručení je požadavek POST s tímto tělem JSON na adresu vašeho příjemce. Než tělu začnete důvěřovat, ověřte hlavičku webhook-signature (Standard Webhooks), do několika sekund odpovězte stavovým kódem 2xx a samotnou práci udělejte až potom. Doručení na jeden webhook zachovávají pořadí událostí; neúspěšné doručení se opakuje s rostoucími pauzami.
Nové typy událostí a nová pole se mohou objevit kdykoli: typy a pole, které neznáte, přeskočte.