Siirry sisältöön
Sursa Developers

Tapahtumat · Webhook-palvelun tapahtumat

webhook.ping

Testitapahtuma

Testitapahtuma, jonka lähettää POST /v1/webhooks/{webhook_id}/test. Sitä ei voi tilata, eikä sitä kirjata tapahtumasyötteeseen.

Objektin tyyppi
webhook
Vastaanottavat webhookit
Webhookit, joilla on admin-rooli

Hyötykuorma

Objekti: EventWebhookPing

  • idstringpakollinen

    Tapahtuman tunnus (evt_…), joka lähetetään myös webhook-id-otsakkeena. Käytä sitä kaksoistoimitusten pudottamiseen.

  • typestringpakollinen

    Sallitut arvot: webhook.ping

  • created_atstring (date-time)pakollinen

    Milloin muutos tapahtui (UTC).

  • org_idintegerpakollinen
  • api_versionstringpakollinen

    data-skeeman sopimusversio.

  • sequenceinteger

    Toimituksen järjestysnumero webhookin sisällä (puuttuu testitapahtumalta).

  • objectWebhookEventObjectpakollinen
  • payloadstringpakollinen

    thin tarkoittaa, ettei data-kenttää ole: lue objekti API:n kautta.

    Sallitut arvot: fullthin

  • dataobject
    Kentät
    • endpoint_idintegerpakollinen
    • messagestringpakollinen
    • requested_byinteger | null
  • testbooleanpakollinen

    POST /v1/webhooks/{webhook_id}/test-toiminnon lähettämä testitapahtuma.

Esimerkkitoimitus

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

Tapahtumien vastaanottaminen

Jokainen toimitus on POST-pyyntö webhookisi URL-osoitteeseen, ja sen runkona on tämä JSON. Tarkista webhook-signature-otsake (Standard Webhooks) ennen kuin luotat runkoon, vastaa 2xx-tilalla muutaman sekunnin kuluessa ja tee varsinainen työ vasta sen jälkeen. Saman webhookin toimitukset säilyttävät tapahtumien järjestyksen; epäonnistunutta toimitusta yritetään uudelleen yhä pidemmin tauoin.

Uusia tapahtumatyyppejä ja uusia kenttiä voi ilmestyä milloin tahansa: ohita tyypit ja kentät, joita et tunne.

Samat tapahtumat ovat tapahtumasyötteessä 30 päivän ajan →