Explicação sobre uso e configuração dos webhooks
A criação de webhooks é realizado na rota POST /v1/webhooks/
Para exemplos de requisição e resposta da API, verifique a seção: Webhooks > Criar
Sobre os webhooks
Webhook é um recurso que possibilita o envio de dados entre sistemas.
Através de um ou mais webhooks, é possível manter a sincronia entre todos os sistemas, de forma que fiquem interligados e mantenham a comunicação em tempo real.
Esse recurso é muitas vezes utilizado por integradores que possuem aplicações, interfaces ou sistemas ERP, onde precisam receber informações em tempo real sobre vendas e cobranças.
Requisitos importantes
- A URL deve utilizar HTTPS.
- O endpoint deve aceitar requisições
POST.- O servidor deve responder rapidamente
(200 OK).- O endpoint deve estar acessível publicamente.
Envio
Efetuamos o envio de webhook sempre que: houver a criação ou atualização de uma Venda.
Reenvio
Em caso de falha no envio, gerado por algum erro ou indisponibilidade da URL configurada; onde recebemos retornos HTTPs 4xx ou 5xx, efetuaremos 10 retentativas com intervalo de 20 segundos entre cada uma.
Em situações em que houve falha, o recomendado é que:
- Verifique a disponibilidade da URL.
- Consulte o registro de atividades da venda: haverá detalhes do retorno do webhook.
- Após análise e correção, fazer o envio manualmente.
É possível reenviar o webhook de uma venda, através da rota POST /v1/charges/"charge_uuid"/webhooks/resend
Consultar status de envio e retorno
É possível consultar o status e mensagem recebido pelo webhook através da consulta do registro de atividades de uma venda.
Verifique a seção: Vendas - OPERAÇÕES E GESTÃO > Registro de Atividades