Webhooks
Webhooks são notificações enviadas por um serviço para um endereço da web previamente cadastrado pelo usuário quando alguma mudança acontece, tornando possível que o sistema do cliente possa consumir os dados enviados e tomar uma ação a partir deles; tais mudanças são chamadas de eventos[1] e é a partir da definição deles que cada notificação é enviada.
Como configurar seu webhook
Para que seja possível receber as notificações, é necessário criar um endpoint no seu sistema para consumir os dados enviados pela nossa API. É possível registrar apenas uma URL para cada tipo de recurso notificável[2], todavia é possível modificá-las depois caso seus endpoints mudem de endereço.
As etapas para configurar seu webhook são as descritas abaixo:
- Defina para qual tipo de recurso você quer receber notificações. A lista de eventos pode ser consultada aqui.
- Desenvolva seu endpoint responsável por consumir a notificação, utilizando o verbo HTTP POST.
- Cadastre o seu webhook no painel de controle da DFranquias Pay.
- Salve a ID do seu webhook e implemente a verificação de segurança no seu endpoint.
Cadastrando seu webhook no painel de controle
- No menu lateral, na seção Desenvolvedores, selecione o item Webhooks.
- Na tela que se abrirá, selecione "Novo", no canto superior direito.
- Preencha a URL e selecione o tipo de recurso que deseja monitorar.
- Clique no botão "Salvar".
Salvando a ID do seu webhook
Na tela Desenvolvedores > Webhooks, copie a ID do webhook mostrada no índice e salve-a em um lugar seguro, como por exemplo em uma variável de ambiente no seu sistema. A ID será necessária para realizar a verificação de segurança, que abordaremos na próxima página.
Conteúdo da notificação
Cada notificação envia como payload um objeto JSON. Confira aqui os detalhes de cada uma.
Resposta esperada
Esperamos uma resposta com o código HTTP 200 OK. Caso a resposta seja diferente, tentaremos enviar a notificação mais duas vezes.
Em caso de erro nas três tentativas, o envio da notificação será cancelado.