Os webhooks são particularmente úteis para eventos como quando um banco confirma um pagamento, um cliente contesta uma cobrança, um pagamento recorrente é finalizado ou no recebimento de pagamentos de assinaturas.
- O que são webhooks
Um webhook permite que a Gen Business envie notificações em tempo real aos aplicativos. Você pode escolher os eventos sobre os quais deseja ser notificado, como mudanças de status em pedidos e pagamentos, e ao ocorrerem, enviamos uma requisição para um URL cadastrada por você.
Cadastrando um webhook
Neste guia você vai ver como cadastrar um webhook para receber notificações no seu sistema.
Acesse sua conta em ambiente de sandbox pelo link ou de produção pelo link , vá no menu lateral esquerdo, clique em Configurações -> Desenvolvedor -> Webhooks e Eventos -> + Webhook e informe os seguintes dados:
- URL: A url do seu sistema para onde devemos enviar a notificação. Será feita uma requisição POST neste endereço.
- Autorização: Um token de autenticação. Enviaremos esse token no cabeçalho Authorization e você pode usar esse token para validar quem está enviando a notificação.
- Eventos: A lista dos eventos que você deseja receber.
Conferindo os eventos ocorridos
Para listar os eventos ocorridos, vá em Configurações -> Desenvolvedor -> Webhooks e Eventos na aba Eventos. Você vai ver a lista de eventos já ocorridos, ao clicar em um evento você pode visualizar as tentativas de notificação já realizadas para aquele evento.
Outra forma de consultar os eventos e notificações enviadas é pela API:
curl -X GET 'https://api-dev.genpag.com.br/api/events \ |
Referência da API: Notificações
curl -X GET 'https://api-dev.genpag.com.br/api/notifications \ |
Realizando re-tentativas de notificações
Ao clicar em um evento e visualizar a lista de notificações, é possível conferir o status da resposta. Quando recebemos uma resposta 200 confirmamos a entrega na notificação, qualquer resposta diferente tratamos como erro e realizamos até 20 tentativas de entrega.
Você também pode re-enviar uma notificação manualmente clicando no ícone que fica à direita do status.