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

Escopo OAuth necessário: `manage:webhooks`. Pausa uma inscrição de webhook sem remover a configuração.

📄️ Reativar webhook

Escopo OAuth necessário: `manage:webhooks`. Reativa uma inscrição de webhook pausada e retoma entregas futuras elegíveis.

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

Requires OAuth scope `manage:webhooks`. Sends one synchronous, synthetic payload through the endpoint's configured HMAC and optional authentication. The request is never persisted or counted as a business delivery. Response excerpts are redacted and truncated.