O que são Webhooks?
Webhooks permitem que você receba notificações automáticas e em tempo real sempre que um evento relevante ocorre na API Pagou, como o pagamento, estorno ou cancelamento de uma transação PIX ou Boleto. Diferente do polling, onde sua aplicação consulta periodicamente a API, o webhook envia a informação assim que o evento acontece.Webhooks são essenciais para integrar eventos da API Pagou de forma eficiente, imediata e escalável.
Por que usar Webhooks?
- Eficiência: Elimina a necessidade de múltiplas requisições GET para verificar o status de transações.
- Imediatismo: Você recebe notificações assim que o evento ocorre, reduzindo latência e melhorando a experiência do usuário.
- Escalabilidade: Evita sobrecarga e picos de requisições ao servidor, já que não há consultas contínuas.
Nunca utilize polling para verificar atualizações de pagamentos. O uso excessivo de consultas via API pode resultar em bloqueio temporário ou permanente do seu acesso. Sempre utilize webhooks para receber atualizações.
Como configurar e usar Webhooks
1
Defina a URL do seu Webhook
No painel da Pagou, acesse a seção de Webhooks e cadastre a URL onde sua aplicação irá receber as notificações.
2
Valide a conexão
Configure sua aplicação para responder com HTTP status 200 (OK) em até 5 segundos após receber uma notificação.
3
Receba eventos em tempo real
Sempre que uma transação mudar de status, a Pagou enviará um payload JSON para a URL cadastrada.
4
Implemente tratamento de falhas
Se seu endpoint não responder ou retornar erro, a API tentará reenviar a notificação algumas vezes. Como fallback, você pode consultar manualmente o endpoint GET de transações.
Ao seguir esse fluxo, sua aplicação se torna mais leve, reativa e pronta para processar eventos em tempo real sem sobrecarregar seus recursos.