A integração do NotifyPay tem duas mãos: pela API, o seu sistema (ERP, loja, agenda) manda cadastros, cobranças e campanhas; pelos webhooks, o NotifyPay avisa o seu sistema quando algo acontece, como mensagem lida ou modelo aprovado. As chaves têm permissão por recurso e os avisos levam assinatura HMAC SHA-256.
Prefere ver a tela? Veja a seção de API na página inicial ou explore o mapa do sistema.
Você manda para o NotifyPay: a API
Em Configurações, você gera chaves de API e escolhe o que cada uma pode fazer. O sistema externo se identifica enviando a chave no cabeçalho X-Api-Key. A chave completa aparece uma única vez, no momento da criação.
Os escopos cobrem, entre outros: contatos, grupos, marcadores, modelos, disparos e campanhas, cobranças, pedidos, produtos, agenda e disponibilidade, funil, extrato e FAQs, com leitura e escrita separadas.
- Uma chave para o site e outra para o ERP: se uma vazar, você desativa só aquela, e ela para de funcionar na hora.
- Documentação dentro do painel, com exemplos prontos.
- Envio de campanha sem duplicar: repetir o mesmo pedido não manda a mensagem duas vezes.
O NotifyPay avisa o seu sistema: webhooks
Você cadastra o endereço do seu sistema e escolhe quais acontecimentos quer receber, no momento em que ocorrem. Entre eles: mensagem entregue, mensagem lida, mensagem com falha, contato que pediu para sair, campanha concluída e modelo aprovado ou rejeitado.
- Assinatura de segurança (HMAC SHA-256) em cada aviso, para o seu sistema confirmar que ele veio do NotifyPay.
- Novas tentativas automáticas se o seu sistema estiver fora do ar.
- Registro de cada tentativa, para ver o que foi entregue.
Dentro das automações, a ação de webhook externo das automações também envia um POST em JSON ao seu sistema com os dados do contato e as variáveis do chatbot.
Exemplos de integração
| Seu sistema | O que acontece |
|---|---|
| Loja ou site | Pedido pago? O site manda a confirmação pelo WhatsApp sozinho |
| ERP e financeiro | Boleto emitido no sistema de gestão vira cobrança e lembrete automático |
| Agenda e CRM externos | Consulta marcada em outra ferramenta? O aviso e a confirmação saem pelo NotifyPay |
| Sistema próprio | Recebe um webhook quando a mensagem é lida ou o contato pede para sair |
Segurança da integração
- Chaves com escopo mínimo: cada integração recebe só as permissões necessárias.
- Revogação imediata de qualquer chave.
- Webhooks com assinatura verificável.
- Registro de auditoria das ações na conta. Veja segurança e permissões.
O que considerar antes de integrar
- A integração via API faz parte dos planos que incluem esse recurso; confira a comparação na seção de planos da página inicial.
- As mensagens enviadas pela API também consomem os disparos do plano.
- O envio continua seguindo as regras da Meta: fora da janela de 24 horas, só mensagens-modelo aprovadas. Veja a janela de 24 horas.
- Para entender a base de tudo isso, leia sobre a API oficial do WhatsApp.
Perguntas frequentes
Como meu sistema se autentica na API?
Enviando a chave de API gerada no painel no cabeçalho X-Api-Key em cada requisição.
Posso limitar o que cada chave faz?
Sim. Ao criar a chave, você marca somente os escopos necessários, com leitura e escrita separadas por recurso.
Como sei que o webhook veio mesmo do NotifyPay?
Cada aviso leva uma assinatura HMAC SHA-256, que o seu sistema pode conferir.
E se o meu sistema estiver fora do ar quando o aviso for enviado?
O NotifyPay faz novas tentativas automáticas e mantém o registro de cada tentativa.
A API está disponível em todos os planos?
A integração via API faz parte dos planos que incluem esse recurso. Veja a comparação completa na seção de planos.
Continue explorando
Conecte o WhatsApp ao resto da empresa
Fale com a gente sobre a integração com o seu ERP, loja ou agenda.
Avise-me no lançamentoVer planos e preços