Pular para o conteúdo principal

Evento de teste (webhook.test)

Disparado sob demanda via POST /api/v1/webhook-endpoints/{id}/test — não é assinável e não aparece no catálogo de assinatura. A entrega percorre o pipeline real (fila, assinatura HMAC, captura de request/response, retry) e é enviada somente ao endpoint alvo, independente da lista de eventos assinados.

Use para validar o consumidor fim a fim antes do primeiro evento de negócio: assinatura, autenticação do request, parsing do envelope e o 2xx rápido.

webhook.test

{
"event": "webhook.test",
"timestamp": "2026-07-23T12:00:00.000Z",
"organizationId": "0f7a3c1e-2b4d-4e6f-8a9b-1c2d3e4f5a6b",
"data": {
"test": true,
"endpointId": "9e1f3a5b-7d2c-4e6a-8b0f-5c7e9a1d3f5b",
"url": "https://example.com/webhooks/kobana",
"triggeredAt": "2026-07-23T12:00:00.000Z"
}
}

A resposta do disparo (202 Accepted) traz eventId e deliveryId — acompanhe a entrega em GET /api/v1/webhook-endpoints/{id}/deliveries ou na tela de entregas. Se o endpoint estiver inativo, o disparo falha com 409 ENDPOINT_INACTIVE.

Checklist do que validar no seu lado:

  • A assinatura t=,v1= confere e o t está dentro da tolerância (Segurança).
  • O consumidor responde 2xx em menos de 10 segundos.
  • data.test === true é tratado sem efeitos colaterais no seu sistema (não crie registros de negócio a partir dele).