> For the complete documentation index, see [llms.txt](https://docs.caf.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caf.io/caf-api/caf-api-pt-br/connect/webhook/managing-webhooks.md). # Gerenciando 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](/files/c828c52d8ce6177a4da495d4d5609723da911c8e) * **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](/files/906ba398e1eb41f82025e82e50f28c945b9708be) 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 {% hint style="info" %} 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`. {% endhint %} ### Detalhes do evento Clique em **Detalhes do evento** para qualquer entrega de webhook e veja informações completas: ![Detalhes do evento](/files/fd117c02c7328c16280a37f118ab29eb71f352f5) 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 {% hint style="info" %} **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. {% endhint %} ### Editando webhooks Clique no botão "Editar" para modificar as configurações do webhook: ![Editar Webhook](/files/765e8640608bc0e431f3b5e1e6c7d99a6ade011d) 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 {% hint style="success" %} **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 {% endhint %} {% hint style="info" %} **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 {% endhint %} ## Próximos passos * [Saiba mais sobre eventos de webhook](/caf-api/caf-api-pt-br/connect/webhook/events.md) para entender as estruturas de payload * [Implementar verificação de assinatura](/caf-api/caf-api-pt-br/connect/webhook/signature.md) para segurança * [Siga as melhores práticas](/caf-api/caf-api-pt-br/connect/webhook/best-practices.md) para um tratamento confiável de webhooks --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.caf.io/caf-api/caf-api-pt-br/connect/webhook/managing-webhooks.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.