Skip to main content
POST

Visão Geral

Envia um payload de teste para a URL do webhook para verificar conectividade e garantir que seu endpoint está configurado corretamente para receber eventos de webhook.

Endpoint

string
obrigatório
UUID do Agente
string
obrigatório
UUID do Webhook

Requisição

Payload de Teste

Quando você chama o endpoint de teste, o seguinte payload será enviado para sua URL de webhook:

Resposta

boolean
Indica se o webhook de teste foi enviado com sucesso
string
Mensagem de sucesso
object
Dados dos resultados do teste
integer
Código de status HTTP retornado pelo seu endpoint de webhook
integer
Tempo de resposta em milissegundos

Respostas de erro

Notas Importantes

  • O payload de teste usa o tipo de evento webhook.test para distingui-lo de eventos reais
  • Seu endpoint de webhook deve retornar um código de status HTTP 2xx para testes bem-sucedidos
  • O teste respeita o timeout configurado do webhook e configurações de nova tentativa
  • Use este endpoint para verificar conectividade antes de ir ao ar com eventos de webhook
  • Payloads de teste incluem o campo test: true para ajudar a identificá-los em seus logs

Requisitos do Endpoint de Webhook

Seu endpoint de webhook deve:
  1. Aceitar requisições POST com payloads JSON
  2. Retornar códigos de status 2xx para processamento bem-sucedido
  3. Responder dentro do timeout configurado (padrão: 30 segundos)
  4. Lidar com o tipo de evento de teste adequadamente
  5. Implementar verificação de assinatura adequada se usando segredos de webhook

Endpoints relacionados