Referência

Visão geral sobre Webhooks

Notificamos eventos para o seu ambiente, possibilitando a integração e automação de seus processos. A notificação é feita pelo envio de uma requisição POST via protocolo HTTPS.

Exemplos:

Caso - Criando uma assinatura: Considerando que ao criar uma assinatura com um pagamento aprovado essa mesma assume o status ativo (ACTIVE), então será enviada uma notificação de evento para a URL configurada.

Caso - Cancelando uma assinatura: Considerando uma assinatura criada e ativa, no momento do cancelamento da assinatura a mesma assume o status de cancelada (CANCELED), então será enviada uma notificação de evento para a URL configurada.

⚠️

Atenção

Os casos acima são apenas exemplos determinar o que é um evento. Os eventos são enviados quando ocorrem atualizações de uma assinatura ou cobrança.

Configurando URL para recebimento de eventos

Para receber eventos é necessário informar o campo notificationUrl nas requisições de Assinatura ou Cobrança.

Exemplo de URL

📘

Conciliando Vendas via URL

Sugerimos que identifique as URLS de acordo com uma cobrança ou assinatura. Utilize um valor único.

📘

Eventos disponíveis

O Bempaggo só envia eventos para Assinaturas e Cobranças.

⚠️

Atenção

Recomendamos a utilização de URLs com o protocolo HTTPS para o recebimento dos alertas.

Recebendo eventos

As notificações de eventos enviadas não possuem qualquer identificação da assinatura ou cobrança. As requisições enviadas possuem a seguinte estrutura:

Método

POST

Header

Content-type: "text/plain"

Body

Bempaggo

👍

Confirmando autenticidade do evento

Utilize a API para consultar uma assinatura ou cobrança para verificar as alterações dos status.

Testes

Sugerimos a utilização da plataforma abaixo para testar o recebimento dos eventos da sua integração.

PipeDream

O Pipedream é uma plataforma poderosa para testar eventos de webhook e pode ser usado para depurar e testar webhooks em qualquer serviço.

  1. Acesse PipeDream
  2. Crie uma nova conta no Pipedream e faça login.
  3. Crie um workflow do tipo "HTTP / Webhooks" e clique em salvar.
  4. Copie a URL fornecida pelo Pipedream.
  5. Clique no botão Deploy para ativar o workflow criado.
  6. Especifique a URL copiada como o endpoint de destino no campo notificationUrl do seu payload.
  7. Faça um teste de transação via API.
  8. Volte ao Pipedream e verifique no workflow criado o evento recebido.