Webhooks
Se o seu sistema precisa saber na hora que um cliente pagou, para liberar um acesso, dar baixa em outro sistema ou disparar um processo, consultar a Ada de tempos em tempos é lento e desperdiça. O webhook faz o contrário: a Ada avisa o seu sistema, chamando o endereço que você informar, no instante do evento, com os dados do pagamento.
O que você ganha
- Integração em tempo real, sem ficar perguntando à Ada se algo mudou.
- Você decide o conteúdo. O corpo da mensagem (o payload) é seu, com os dados do lançamento, do contrato, da organização e do cliente.
- Um teste antes de valer. Você executa um webhook com o número de um lançamento e vê a resposta do seu sistema.
Como configurar
Em Configurações, Webhooks, crie um novo e preencha:
- Nome e organização: a identificação.
- Url: o endereço do seu sistema que a Ada vai chamar.
- Executa: hoje, No pagamento.
- Autenticação: como o seu sistema reconhece a Ada, por Basic (key e secret) ou Bearer token.
- Payload: o corpo da mensagem. Veja abaixo.
- Ativo: liga e desliga.
O método é POST e o conteúdo, application/json.
O conteúdo da mensagem (payload)
Aceita variáveis entre chaves duplas, como {{event_name}}, {{invoice.id}} e {{contract.id}}. Os dados do lançamento, do contrato, da organização e do cliente estão disponíveis. Se você deixar em branco, a Ada usa um modelo padrão.
Testar antes de ligar
Na ficha do webhook, informe o número de um lançamento e execute. A Ada chama o seu endereço e mostra a resposta. Só ligue o Ativo quando a resposta estiver como o seu sistema espera.
Consulta rápida
| Campo | Valores |
|---|---|
| Nome, Organização | Identificação |
| Url | O endereço chamado |
| Executa | No pagamento |
| Método | POST |
| Content type | application/json |
| Autenticação | Basic (key e secret) ou Bearer token |
| Payload | O corpo, com variáveis |
| Ativo | Liga e desliga |
Se deu errado
| Sintoma | Causa | O que fazer |
|---|---|---|
| Não autorizado | Autenticação errada | Abra Configurações, Webhooks, o webhook, e confira a Autenticação: Basic com key e secret, ou Bearer token, iguais aos que o seu sistema espera |
| Nada chega | Webhook inativo, ou URL inacessível | Abra Configurações, Webhooks, o webhook: confira se Ativo está ligado e se a Url está acessível de fora. Teste na ficha informando o número de um lançamento |
Onde acessar
Endereços a partir do domínio da sua conta.
| Onde | Endereço | Acesso direto |
|---|---|---|
| Lista de webhooks | /config/webhook | Sim |
| Ficha do webhook | /config/webhook/{id} | Sim |
| Novo webhook | /config/webhook/new | Sim |