Eventos · Eventos de serviço dos webhooks
webhook.ping
Evento de teste
Evento de teste enviado por POST /v1/webhooks/{webhook_id}/test. Não é possível se inscrever nele, e ele não é gravado no feed de eventos.
- Tipo de objeto
- webhook
- Entregue a
- Webhooks com a função admin
Payload
idstringobrigatórioID do evento (
evt_…), também enviado como cabeçalhowebhook-id. Use-o para descartar entregas duplicadas.typestringobrigatórioValores permitidos:
webhook.pingcreated_atstring (date-time)obrigatórioQuando a alteração aconteceu (UTC).
org_idintegerobrigatórioapi_versionstringobrigatórioVersão do contrato do esquema
data.sequenceintegerNúmero de sequência da entrega dentro do webhook (ausente em um evento de teste).
payloadstringobrigatóriothinsignifica semdata: leia o objeto pela API.Valores permitidos:
fullthindataobjectCampos
endpoint_idintegerobrigatóriomessagestringobrigatóriorequested_byinteger | null
testbooleanobrigatórioUm evento de teste enviado por
POST /v1/webhooks/{webhook_id}/test.
Exemplo de entrega
{
"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
}Recebimento de eventos
Cada entrega é uma requisição POST com este corpo JSON para a URL do seu webhook. Verifique o cabeçalho webhook-signature (Standard Webhooks) antes de confiar no corpo, responda com um status 2xx em poucos segundos e faça o processamento depois. As entregas a um mesmo webhook mantêm a ordem dos eventos; uma entrega com falha é tentada de novo, com pausas cada vez maiores.
Novos tipos de evento e novos campos podem aparecer a qualquer momento: ignore os tipos e campos que você não conhece.