Webhooks

Visão Geral

A tela Webhook é um registro, só de consulta, dos avisos que os provedores de pagamento enviam ao sistema. Cada registro mostra a integração, a transação, o provedor, o tipo de evento, se o aviso foi processado, a mensagem de erro (quando houver) e o conteúdo recebido. Não é possível incluir, alterar nem excluir registros.

Como Acessar

No menu lateral, acesse Vendas > Webhook. A tela de listagem será exibida com os avisos recebidos.

Configurando um Webhook

1. Na tela de listagem, clique no botão Novo.
2. Informe o Nome do webhook (ex: “Notificacao E-commerce”).
3. Insira a URL do endpoint que recebera as notificações.
4. Selecione os Eventos que devem disparar o webhook.
5. Configure opcoes adicionais como headers de autenticacao, se necessario.
6. Clique em Salvar.

Eventos Disponiveis

Os webhooks podem ser configurados para os seguintes eventos:

Evento	Descrição
Venda criada	Disparado quando um novo pedido de venda e criado.
Venda concluida	Disparado quando um pedido e finalizado (pago e faturado).
Venda cancelada	Disparado quando um pedido e cancelado.
Pagamento recebido	Disparado quando um pagamento e registrado.
NF emitida	Disparado quando uma nota fiscal e emitida para o pedido.

Integração com Sistemas Externos

Ao receber a notificação, o sistema externo recebe um payload JSON contendo os dados do evento, incluindo informações do pedido, cliente, produtos e valores. A URL configurada deve estar acessivel pela internet e responder com um status HTTP 200 para confirmar o recebimento.

Dicas

• Teste antes de produzir: utilize ferramentas como webhook.site para testar o payload antes de integrar com o sistema final.
• Autenticacao: configure headers de autorização para garantir que apenas o sistema possa enviar notificações ao seu endpoint.
• Monitoramento: acompanhe o histórico de envios para identificar falhas de comunicação.
• Retentativas: em caso de falha no envio, o sistema pode tentar novamente automaticamente. Verifique as configurações de retentativa.