Notikumi · Webhook pakalpojuma notikumi
webhook.ping
Testa notikums
Testa notikums, ko sūta POST /v1/webhooks/{webhook_id}/test. To nevar abonēt, un tas netiek ierakstīts notikumu plūsmā.
- Objekta tips
- webhook
- Kam piegādā
- Galapunktiem ar administratora lomu
Saturs
idstringobligātsNotikuma ID (
evt_…), tiek sūtīts arī kā galvenewebhook-id. Izmantojiet to, lai atmestu dublētas piegādes.typestringobligātsAtļautās vērtības:
webhook.pingcreated_atstring (date-time)obligātsKad notika izmaiņas (UTC).
org_idintegerobligātsapi_versionstringobligātsdatashēmas līguma versija.sequenceintegerPiegādes kārtas numurs galapunktā (testa notikumam nav).
payloadstringobligātsthinnozīmē, kadatanav: nolasiet objektu caur API.Atļautās vērtības:
fullthindataobjectLauki
endpoint_idintegerobligātsmessagestringobligātsrequested_byinteger | null
testbooleanobligātsTesta notikums, ko nosūta
POST /v1/webhooks/{webhook_id}/test.
Piegādes piemērs
{
"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
}Notikumu saņemšana
Katra piegāde ir POST pieprasījums ar šo JSON saturu uz jūsu galapunktu. Pirms uzticaties saturam, pārbaudiet galvenes webhook-signature parakstu (Standard Webhooks), dažu sekunžu laikā atbildiet ar 2xx statusu un darbu veiciet pēc tam. Piegādes vienam galapunktam saglabā notikumu secību; neizdevusies piegāde tiek atkārtota ar pieaugošām pauzēm.
Jauni notikumu tipi un jauni lauki var parādīties jebkurā laikā: tipus un laukus, ko nepazīstat, izlaidiet.