Anar al contingut
Sursa Developers

Esdeveniments · Esdeveniments de servei dels webhooks

webhook.ping

Esdeveniment de prova

Esdeveniment de prova enviat per POST /v1/webhooks/{webhook_id}/test. No s’hi pot subscriure i no s’anota al canal d’esdeveniments.

Tipus d’objecte
webhook
Es lliura a
Webhooks amb el rol admin

Càrrega útil

Objecte: EventWebhookPing

  • idstringobligatori

    ID de l’esdeveniment (evt_…), que també s’envia com a capçalera webhook-id. Feu-lo servir per descartar els lliuraments duplicats.

  • typestringobligatori

    Valors permesos: webhook.ping

  • created_atstring (date-time)obligatori

    Moment en què es va produir el canvi (UTC).

  • org_idintegerobligatori
  • api_versionstringobligatori

    Versió del contracte de l’esquema de data.

  • sequenceinteger

    Número de seqüència del lliurament dins del webhook (no hi és en un esdeveniment de prova).

  • objectWebhookEventObjectobligatori
  • payloadstringobligatori

    thin vol dir sense data: llegiu l’objecte a través de l’API.

    Valors permesos: fullthin

  • dataobject
    Camps
    • endpoint_idintegerobligatori
    • messagestringobligatori
    • requested_byinteger | null
  • testbooleanobligatori

    Esdeveniment de prova enviat per POST /v1/webhooks/{webhook_id}/test.

Exemple de lliurament

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

Recepció d’esdeveniments

Cada lliurament és una sol·licitud POST amb aquest cos JSON a l’URL del vostre webhook. Verifiqueu la capçalera webhook-signature (Standard Webhooks) abans de confiar en el cos, responeu amb un estat 2xx en pocs segons i feu la feina després. Els lliuraments a un mateix webhook mantenen l’ordre dels esdeveniments; un lliurament fallit es reintenta amb pauses cada vegada més llargues.

En qualsevol moment poden aparèixer tipus d’esdeveniment i camps nous: ometeu els tipus i els camps que no conegueu.

Els mateixos esdeveniments són al canal d’esdeveniments durant 30 dies →