Disponível para: Empresa. Somente contas do tipo Empresa podem cadastrar e gerenciar webhooks.
- Cadastrar uma ou mais URLs para receber notificações
- Escolher exatamente quais eventos você quer monitorar
- Consultar o histórico de disparos para ver o que foi entregue e o que falhou
Como cadastrar uma URL de webhook
1
Acesse a seção de webhooks
No menu lateral, vá em Integrações → Webhooks.
2
Adicione um novo webhook
Clique em Novo webhook.
3
Informe a URL
Digite a URL do seu servidor que vai receber as notificações. Ela precisa estar acessível publicamente e aceitar requisições do tipo POST.
4
Escolha os eventos
Selecione na lista os eventos que você quer monitorar. Você pode escolher um ou vários ao mesmo tempo. Veja a seção abaixo para conhecer os eventos disponíveis.
5
Salve o webhook
Clique em Salvar. A partir daí, toda vez que um dos eventos selecionados ocorrer, a Autorizou enviará uma notificação para a sua URL.
Eventos disponíveis
A lista completa e atualizada de eventos aparece no próprio painel, na tela de criação do webhook. Alguns exemplos do que pode ser monitorado:A lista completa de eventos e o formato exato dos dados enviados estão na documentação para desenvolvedores da Autorizou.
Como consultar o histórico de disparos
O histórico mostra cada vez que a Autorizou tentou enviar uma notificação para a sua URL, com o resultado de cada tentativa.1
Acesse a lista de webhooks
Vá em Integrações → Webhooks e clique no webhook que deseja consultar.
2
Abra o histórico
Clique em Histórico de disparos.
3
Analise os resultados
Cada linha mostra o evento, a data e hora do disparo e o status da entrega: sucesso (sua URL respondeu corretamente) ou falha (sua URL não respondeu ou retornou erro).
Boas práticas
- Responda rápido: sua URL deve retornar o código de sucesso o mais rápido possível. Se o processamento for demorado, confirme o recebimento primeiro e processe depois.
- Confirme na fonte: trate a notificação como um aviso, não como a verdade final. Antes de executar ações críticas no seu sistema, confirme a informação consultando o painel ou a sua integração.
- Monitore o histórico: consulte o histórico regularmente para identificar falhas e corrigir antes que virem problema.
- Eventos específicos: selecione apenas os eventos que o seu sistema realmente precisa. Isso reduz o volume de notificações desnecessárias.
Dúvidas comuns
Posso cadastrar mais de uma URL de webhook?
Posso cadastrar mais de uma URL de webhook?
Sim. Você pode ter múltiplos webhooks com URLs diferentes, cada um monitorando eventos distintos ou os mesmos eventos. Isso é útil quando sistemas diferentes precisam ser notificados.
O que acontece se minha URL estiver fora do ar?
O que acontece se minha URL estiver fora do ar?
A Autorizou tenta reenviar a notificação algumas vezes. Se todas as tentativas falharem, o disparo fica registrado como falha no histórico, com o detalhe do erro para você diagnosticar.
Quantas tentativas de reenvio automático são feitas?
Quantas tentativas de reenvio automático são feitas?
A Autorizou realiza um número limitado de tentativas automáticas. Para o número exato e os intervalos entre tentativas, consulte a documentação para desenvolvedores.
Como sei se o webhook que recebi é legítimo?
Como sei se o webhook que recebi é legítimo?
Use a notificação apenas como um aviso de que algo aconteceu. Antes de executar ações críticas no seu sistema, confirme a informação na fonte, consultando o painel ou a sua integração. Assim, um aviso duplicado ou inesperado não gera efeito indevido.
Posso testar o webhook antes de ir para produção?
Posso testar o webhook antes de ir para produção?
Sim. Você pode usar serviços de inspeção de webhook para ver as notificações em tempo real enquanto testa. Cadastre uma URL temporária de teste e troque pela URL de produção quando estiver tudo certo.
Veja também
Chaves de Integração
Crie e gerencie as chaves que autenticam sua conta nas integrações.
Colaboradores
Controle quem da sua equipe pode acessar e configurar as integrações.