Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Gerenciamento de webhooks

Depois de criar seus webhooks, você pode monitorar a atividade deles, ver os detalhes dos eventos e gerenciar a configuração por meio do portal Trust.

Gerenciando webhooks existentes

Visualizando a configuração do webhook

Na lista de webhooks, cada webhook exibe:

Gerenciamento de Webhooks

  • URL do payload: O endpoint para o qual os webhooks são enviados

  • Status: Se o webhook está Ativo ou Inativo

  • Ações: Opções para visualizar eventos, editar ou excluir o webhook

Para acessar os eventos do webhook, clique no Ver eventos botão de qualquer webhook.

Visualizando eventos do webhook

Lista de eventos do webhook

Depois de clicar Ver eventos na página de gerenciamento do webhook, você pode ver todas as entregas recentes desse webhook específico:

Eventos de webhook

A página de eventos do webhook exibe:

  • ID do evento: Identificador exclusivo de cada tentativa de entrega do webhook

  • Tipo de evento: O tipo de evento que acionou o webhook (por exemplo, COMMUNICATION.COMMUNICATIONCREATEDEVENT)

  • Data: Quando o webhook foi enviado

  • Status: Indicador visual que mostra entrega bem-sucedida (✓) ou com falha (✗)

  • Detalhes do evento: Link para ver informações detalhadas sobre a entrega do webhook

O Trust pode exibir o evento com seu prefixo de origem, como TRANSACTION.TRANSACTIONSTATUSUPDATEDEVENT. No payload CloudEvent entregue, esses valores são separados: source é TRANSACTION e Tipo é TRANSACTIONSTATUSUPDATEDEVENT.

Detalhes do evento

Clique em Detalhes do evento para qualquer entrega de webhook e veja informações completas:

Detalhes do evento

A página de detalhes do evento mostra:

Aba da requisição

  • Carga útil: A JSON carga útil completa enviada para o endpoint do seu webhook

  • Cabeçalhos: HTTP cabeçalhos incluídos na solicitação do webhook

Aba Respostas

  • Status da resposta: HTTP código de status retornado pelo seu endpoint

  • Cabeçalhos da resposta: Cabeçalhos retornados pelo endpoint do seu webhook

  • Corpo da resposta: O corpo da resposta do seu endpoint

Você pode usar o Reenviar botão para tentar novamente as entregas de webhook com falha. Observe que o Reenviar botão está disponível apenas para webhooks que falharam (marcados com ✗).

Entendendo o status de entrega do webhook

  • ✓ Marca de verificação verde: O webhook foi entregue com sucesso (resposta HTTP 2xx)

  • ✗ X vermelho: Falha na entrega do webhook (resposta não 2xx, timeout ou erro de conexão)

Reenviando webhooks com falha

Para entregas de webhook com falha (marcadas com ✗), você pode tentar reenviar manualmente a entrega:

  1. Clique em Detalhes do evento para o webhook com falha

  2. Revise o motivo da falha na aba Respostas

  3. Clique no Reenviar botão para tentar reenviar a entrega

  4. O webhook será enviado novamente com o mesmo payload e os mesmos cabeçalhos

Disponibilidade do Reenvio

O Reenviar botão está disponível apenas para entregas de webhook com falha. Webhooks entregues com sucesso (marcados com ✓) não podem ser reenviados, pois já foram processados com sucesso.

Editando webhooks

Clique no botão "Editar" para modificar as configurações do webhook:

Editar Webhook

Você pode atualizar:

  • URL do payload: Alterar o endpoint de destino

  • Segredo: Atualizar o segredo da assinatura do webhook

  • Tipo de autenticação: Modificar o método de autenticação (Nenhum, Básico, Chave de API)

  • Seleção de eventos: Alterar quais eventos acionam o webhook

  • Status ativo: Ativar ou desativar o webhook

Solução de problemas de webhooks com falha

Quando os webhooks falham (marcados com ✗), verifique os detalhes do evento para entender o motivo:

  1. Erros 4xx: Normalmente indicam problemas com seu endpoint

    • 404: URL do webhook não encontrada

    • 401/403: Problemas de autenticação

    • 400: Seu endpoint rejeitou o formato do payload

  2. Erros 5xx: Erros de servidor no seu endpoint

    • 500: Erro interno do servidor no seu manipulador de webhook

    • 502/503: Seu servidor está indisponível

  3. Tempo limite: Seu endpoint demorou demais para responder (> 2 segundos)

Melhores práticas para gerenciamento de webhooks

Recomendações de monitoramento

  • Verifique regularmente a página de eventos do webhook para entregas com falha

  • Configure alertas de monitoramento para seus endpoints de webhook

  • Use o recurso "Reenviar" para tentar novamente webhooks com falha depois de corrigir problemas no seu endpoint

  • Mantenha as URLs dos webhooks atualizadas quando sua infraestrutura mudar

  • Lembre-se de que "Reenviar" está disponível apenas para entregas com falha - as bem-sucedidas não precisam ser reenviadas

Retenção de eventos

Os detalhes dos eventos do webhook são mantidos para fins de monitoramento e depuração. Use estes dados para:

  • Depurar problemas de integração

  • Monitorar as taxas de sucesso na entrega de webhooks

  • Entender padrões e horários dos eventos

Próximos passos

Atualizado