Webhooks

📄️ Listar webhooks cadastrados

Lista os webhooks cadastrados para o cliente autenticado. Use para conferir URLs, eventos assinados, status e dados de autenticação antes de criar ou alterar subscriptions. O token precisa incluir `read:webhooks`.

📄️ Cadastrar webhook

Cadastra um webhook para receber eventos enviados pela Destrava. Informe uma URL pública e segura para onde as notificações devem ser entregues. O token precisa incluir `manage:webhooks`.

📄️ Atualizar webhook

Atualiza uma subscription de webhook existente. Use para trocar URL, status, eventos assinados ou configuração de autenticação sem recriar a subscription. O token precisa incluir `manage:webhooks`.

📄️ Desativar webhook

Desativa uma subscription de webhook e cancela entregas pendentes relacionadas a ela. Use quando a integração não deve mais receber eventos por aquela URL. O token precisa incluir `manage:webhooks`.

📄️ Ver resumo de entregas de webhook

Resume as entregas de webhook por subscription e status HTTP. Use para identificar rapidamente falhas, sucesso de envio e subscriptions que precisam de atenção. O token precisa incluir `read:webhooks`.

📄️ Ver detalhes de entregas de webhook

Lista as entregas e tentativas de uma subscription de webhook. Use para investigar uma notificação específica, entender respostas HTTP recebidas e acompanhar tentativas de reenvio. O token precisa incluir `read:webhooks`.

📄️ Reenfileirar entregas com falha

Reenfileira entregas de webhook que chegaram a falha final, mantendo o mesmo `eventId`. Use para tentar novamente uma entrega depois de corrigir a URL ou o serviço consumidor. O token precisa incluir `manage:webhooks`.

📄️ Pausar webhook

Pausa as próximas entregas de webhook sem remover a configuração. O token precisa incluir `manage:webhooks`.

📄️ Reativar webhook

Reativa uma subscription pausada e retoma as próximas entregas conforme o contrato vigente da subscription. O token precisa incluir `manage:webhooks`.

📄️ Enviar evento sintético de teste para um endpoint

Exige o escopo OAuth `manage:webhooks`. Envia de forma síncrona uma carga sintética usando o HMAC e a autenticação opcional configurados no endpoint. A solicitação não é persistida nem contabilizada como entrega de negócio. Os trechos da resposta são ocultados e truncados.