Přejít na obsah
Sursa Developers

Události · Servisní události webhooků

webhook.ping

Testovací událost

Testovací událost odeslaná operací POST /v1/webhooks/{webhook_id}/test. Nelze ji odebírat a nezapisuje se do kanálu událostí.

Typ objektu
webhook
Komu se doručuje
Webhookům s rolí administrátora

Obsah události

Objekt: EventWebhookPing

  • idstringpovinné

    ID události (evt_…), posílá se také jako hlavička webhook-id. Podle něj zahazujte duplicitní doručení.

  • typestringpovinné

    Povolené hodnoty: webhook.ping

  • created_atstring (date-time)povinné

    Kdy ke změně došlo (UTC).

  • org_idintegerpovinné
  • api_versionstringpovinné

    Verze kontraktu schématu data.

  • sequenceinteger

    Pořadové číslo doručení v rámci webhooku (u testovací události chybí).

  • objectWebhookEventObjectpovinné
  • payloadstringpovinné

    thin znamená bez data: objekt si přečtěte přes API.

    Povolené hodnoty: fullthin

  • dataobject
    Pole
    • endpoint_idintegerpovinné
    • messagestringpovinné
    • requested_byinteger | null
  • testbooleanpovinné

    Testovací událost odeslaná pomocí POST /v1/webhooks/{webhook_id}/test.

Ukázka doručení

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

Příjem událostí

Každé doručení je požadavek POST s tímto tělem JSON na adresu vašeho příjemce. Než tělu začnete důvěřovat, ověřte hlavičku webhook-signature (Standard Webhooks), do několika sekund odpovězte stavovým kódem 2xx a samotnou práci udělejte až potom. Doručení na jeden webhook zachovávají pořadí událostí; neúspěšné doručení se opakuje s rostoucími pauzami.

Nové typy událostí a nová pole se mohou objevit kdykoli: typy a pole, které neznáte, přeskočte.

Stejné události najdete 30 dní v kanálu událostí →