Ugrás a tartalomra
Sursa Developers

Események · A webhookszolgáltatás eseményei

webhook.ping

Tesztesemény

A POST /v1/webhooks/{webhook_id}/test által küldött tesztesemény. Nem lehet rá feliratkozni, és nem kerül be az eseménycsatornába.

Objektumtípus
webhook
Címzett webhookok
Az admin szerepkörű webhookok

Adattartalom

Objektum: EventWebhookPing

  • idstringkötelező

    Az esemény azonosítója (evt_…), amely webhook-id fejlécként is érkezik. Ezzel szűrheted ki az ismétlődő kézbesítéseket.

  • typestringkötelező

    Megengedett értékek: webhook.ping

  • created_atstring (date-time)kötelező

    Mikor történt a változás (UTC).

  • org_idintegerkötelező
  • api_versionstringkötelező

    A data séma szerződésverziója.

  • sequenceinteger

    A kézbesítés sorszáma a webhookon belül (tesztesemény esetén hiányzik).

  • objectWebhookEventObjectkötelező
  • payloadstringkötelező

    A thin azt jelenti, hogy nincs data: az objektumot az API-n keresztül olvasd ki.

    Megengedett értékek: fullthin

  • dataobject
    Mezők
    • endpoint_idintegerkötelező
    • messagestringkötelező
    • requested_byinteger | null
  • testbooleankötelező

    A POST /v1/webhooks/{webhook_id}/test által küldött tesztesemény.

Példa kézbesítésre

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

Események fogadása

Minden kézbesítés egy ilyen JSON-törzsű POST kérés a webhookod URL-jére. Mielőtt megbíznál a törzsben, ellenőrizd a webhook-signature fejlécet (Standard Webhooks), néhány másodpercen belül válaszolj 2xx állapotkóddal, és a feldolgozást csak ezután végezd el. Az egy webhooknak szóló kézbesítések megtartják az események sorrendjét; a sikertelen kézbesítést a rendszer egyre hosszabb szünetekkel újrapróbálja.

Új eseménytípusok és új mezők bármikor megjelenhetnek: hagyd figyelmen kívül azokat a típusokat és mezőket, amelyeket nem ismersz.

Ugyanezek az események 30 napig az eseménycsatornában is megtalálhatók →