Įvykiai · Webhook tarnybiniai įvykiai

webhook.ping

Bandomasis įvykis

Bandomasis įvykis, išsiųstas per POST /v1/webhooks/{webhook_id}/test. Jo prenumeruoti negalima, ir jis neįrašomas į įvykių juostą.

Objekto tipas: webhook
Kam pristatoma: Galiniams taškams su vaidmeniu admin

Turinys

Objektas: EventWebhookPing

idstringprivalomas
Įvykio ID (evt_…), taip pat siunčiamas antraštėje webhook-id. Naudokite jį pristatymų dublikatams atmesti.
typestringprivalomas
Leidžiamos reikšmės: webhook.ping
created_atstring (date-time)privalomas
Kada įvyko pakeitimas (UTC).
org_idintegerprivalomas
api_versionstringprivalomas
data schemos kontrakto versija.
sequenceinteger
Pristatymo eilės numeris galiniame taške (bandomajam įvykiui jo nėra).
objectWebhookEventObjectprivalomas
payloadstringprivalomas
thin reiškia, kad data nėra: objektą perskaitykite per API.
Leidžiamos reikšmės: fullthin
dataobject
Laukai
- endpoint_idintegerprivalomas
- messagestringprivalomas
- requested_byinteger | null
testbooleanprivalomas
Bandomasis įvykis, išsiųstas per POST /v1/webhooks/{webhook_id}/test.

Pristatymo pavyzdys

{
  "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
}

Įvykių gavimas

Kiekvienas pristatymas – POST užklausa su šiuo JSON turiniu jūsų galiniam taškui. Pirmiausia patikrinkite antraštės webhook-signature parašą (Standard Webhooks) ir tik tada pasitikėkite turiniu, per kelias sekundes atsakykite 2xx būsena, o darbą atlikite vėliau. Pristatymai vienam galiniam taškui išlaiko įvykių tvarką; nepavykęs pristatymas kartojamas vis ilgesnėmis pauzėmis.

Nauji įvykių tipai ir nauji laukai gali atsirasti bet kada: nežinomus tipus ir laukus praleiskite.

Tie patys įvykiai 30 dienų pasiekiami įvykių juostoje →