Webhooks
Configure e receba notificações sobre atualizações
Webhooks permitem que sua aplicação receba notificações em tempo real sobre eventos importantes da AbacatePay.
Gerenciando webhooks
Gerencie seus webhooks diretamente em nossa plataforma. Você pode:
- Listar todos os webhooks ativos
- Criar novos webhooks
- Remover webhooks existentes
Ambientes e Webhooks
Os webhooks são específicos para cada ambiente:
- Webhooks criados em dev mode recebem notificações apenas do ambiente de testes
- Webhooks criados em produção recebem notificações apenas de dados reais
Saiba mais sobre o ambiente de desenvolvimento aqui.
Criando webhooks
Segurança dos Webhooks
- Configure um secret único para cada webhook
- Valide o secret em todas as requisições recebidas
- Use HTTPS para todas as URLs de webhook
- Implemente retry logic para lidar com falhas temporárias
Como criar seu webhook
Siga estes passos no dashboard da AbacatePay:
Acesse a Seção de Webhooks
Navegue até a seção Integrar e clique em Webhooks
Inicie o processo de configuração de um novo webhook
Inicie a Criação
Clique em 'Criar' e prepare-se para configurar
Você será direcionado ao formulário de configuração
Configure seu Webhook
Preencha os campos necessários:
- Nome: Identificador único para seu webhook (ex: “Notificações de Pagamento”)
- URL: Endpoint HTTPS que receberá as notificações
- Secret: Chave secreta para validar as requisições
Protegendo suas requisições
Cada notificação enviada para seu webhook inclui o secret configurado como parâmetro de query string para validação.
Exemplo de URL de Webhook
URL base do seu webhook:
URL com secret (como será chamado):
Exemplo de Implementação
Eventos Suportados
Atualmente, suportamos os seguintes eventos:
billing.paid
Este evento é disparado quando um pagamento é confirmado. O payload varia dependendo da origem do pagamento:
Pagamento via PIX QR Code
Pagamento via Cobrança
Nota Importante
- O campo
devMode
indica se o evento ocorreu no ambiente de desenvolvimento - Todos os valores monetários são expressos em centavos
- O campo
fee
representa a taxa cobrada pela AbacatePay - O campo
event
identifica o tipo de evento recebido
Precisa de ajuda?
Nossa equipe está disponível para auxiliar na implementação de webhooks. Entre em contato pelo e-mail ajuda@abacatepay.com