Webhook

Webhooks para receber notificações de eventos (como atualizações de boletos) em tempo real, com cadastro, ativação, teste e reenvio de eventos.

📄️Cadastrar webhook

Cadastra um novo webhook vinculado ao cliente autenticado. O secret é retornado apenas nesta resposta e não pode ser recuperado posteriormente.

📄️Listar webhooks

Retorna uma lista paginada de webhooks vinculados ao cliente autenticado.

📄️Buscar webhook

Retorna os detalhes de um webhook pelo identificador.

📄️Atualizar webhook

Substitui os dados de configuração do webhook. Não rotaciona o secret.

📄️Remover webhook

Remove permanentemente o webhook. Tentativas de entrega anteriores são também removidas.

📄️Ativar webhook

Marca o webhook como ativo. Eventos passam a ser entregues.

📄️Desativar webhook

Marca o webhook como inativo. Eventos deixam de ser entregues até reativação.

📄️Listar eventos disparados de um webhook

Retorna a lista paginada de eventos disparados para o webhook, com summary das tentativas de entrega. Filtros opcionais: status, eventType, from, to.

📄️Detalhar evento de webhook

Retorna detalhes de um evento de webhook (payload original e histórico completo de tentativas de entrega).

📄️Reenviar evento de webhook

Republica o evento no bus iniciando um novo ciclo de retentativas. Falha em 409 se o evento já foi entregue com sucesso ou está em entrega.

📄️Disparar teste sintético

Envia uma chamada de teste imediata ao endpoint do webhook com payload sintético. Não persiste evento nem agenda retentativas. Retorna o resultado da única tentativa.

📄️Listar tipos de eventos suportados

Retorna o catálogo de todos os tipos de eventos que podem ser assinados em um webhook (ex.: boleto.created, payment.completed).