Webhooks de Agente
Testar Webhook
Enviar um payload de teste para verificar conectividade do webhook
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
UUID do Agente
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
Indica se o webhook de teste foi enviado com sucesso
Mensagem de sucesso
Dados dos resultados do teste
Código de status HTTP retornado pelo seu endpoint de webhook
Tempo de resposta em milissegundos
Respostas de erro
Notas Importantes
- O payload de teste usa o tipo de evento
webhook.testpara 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: truepara ajudar a identificá-los em seus logs
Requisitos do Endpoint de Webhook
Seu endpoint de webhook deve:- Aceitar requisições POST com payloads JSON
- Retornar códigos de status 2xx para processamento bem-sucedido
- Responder dentro do timeout configurado (padrão: 30 segundos)
- Lidar com o tipo de evento de teste adequadamente
- Implementar verificação de assinatura adequada se usando segredos de webhook
Endpoints relacionados
- Listar Webhooks do Agente - Obter todos os webhooks de um agente
- Criar Webhook - Configurar um novo webhook
- Obter Detalhes do Webhook - Recuperar informações específicas do webhook
- Atualizar Webhook - Modificar configuração do webhook
- Excluir Webhook - Remover configuração do webhook
- Alternar Status do Webhook - Habilitar/desabilitar webhook