Sündmused · Veebihaagiteenuse sündmused
webhook.ping
Testsündmus
Testsündmus, mille saadab POST /v1/webhooks/{webhook_id}/test. Seda ei saa tellida ja seda ei kirjutata sündmuste linti.
- Objekti tüüp
- webhook
- Vastuvõtvad veebihaagid
- Veebihaagid, millel on roll admin
Sisu
idstringkohustuslikSündmuse ID (
evt_…), mis saadetakse ka päisenawebhook-id. Kasutage seda topeltedastuste kõrvaldamiseks.typestringkohustuslikLubatud väärtused:
webhook.pingcreated_atstring (date-time)kohustuslikMillal muudatus toimus (UTC).
org_idintegerkohustuslikapi_versionstringkohustuslikSkeemi
datalepingu versioon.sequenceintegerEdastuse järjekorranumber veebihaagi piires (testsündmuse puhul puudub).
payloadstringkohustuslikthintähendab, et väljadataei ole: lugege objekti API kaudu.Lubatud väärtused:
fullthindataobjectVäljad
endpoint_idintegerkohustuslikmessagestringkohustuslikrequested_byinteger | null
testbooleankohustuslikTestsündmus, mille saatis
POST /v1/webhooks/{webhook_id}/test.
Näidisedastus
{
"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
}Sündmuste vastuvõtmine
Iga edastus on selle JSON-kehaga POST-päring teie veebihaagi URL-ile. Enne keha usaldamist kontrollige päist webhook-signature (Standard Webhooks), vastake mõne sekundi jooksul olekuga 2xx ja tehke töö ära hiljem. Ühe veebihaagi edastused säilitavad sündmuste järjekorra; ebaõnnestunud edastust proovitakse uuesti üha pikemate vahedega.
Uued sündmusetüübid ja uued väljad võivad ilmuda igal ajal: jätke tundmatud tüübid ja väljad vahele.