Criação e atualização por Danilo de Araújo e Felipe Sales
Olá, espero que esteja tudo bem!! 🙂
Também conhecido como retorno de chamada web, HTTP (Protocolo de Transferência de Hipertexto) ou até mesmo impulso API, Webhooks são notificações automatizadas que informam outros aplicativos, plataformas ou sites sobre os eventos que acontecem em sua conta quase em tempo real.
É uma ferramenta de envio e recebimento de informações entre dois sistemas de uma forma passiva, ou seja, totalmente automatizada. Com ela é possível trocar informações entre ferramentas, sites e aplicativos sempre que houver uma alteração de status de uma compra, por exemplo.
Dessa forma, sempre que uma venda tiver seu status atualizado (Pago, Cancelado, Reembolsado etc.), a ferramenta envia esses e outros dados previamente escolhidos para a aplicação de destino. Para procurar o que deseja saber sobre a ferramenta, verifique os tópicos abaixo:
- Como funciona o Webhook na Eduzz?;
- Quais configurações posso realizar no meu Webhook?;
- Os filtros para identificação do Webhook;
Como funciona o Webhook na Eduzz?
Na Eduzz você pode enviar e receber webhooks de diferentes tipos de eventos referentes aos status das suas vendas, como um pagamento concluído, um novo boleto gerado, cancelamento de assinatura etc;
A partir da notificação gerada por esse vínculo você pode segmentar e enviar e-mails para seus usuários com base nas alterações de status dos pedidos, receber atualizações de assinaturas pagas ou vencidas, atualizar sistemas contábeis e muitas outras possibilidades;
Assim, o webhook funciona como gatilho para determinadas ações como, por exemplo, se uma fatura é alterada para o status “Pago”, o sistema vinculado pode criar um novo usuário em sua plataforma ou portal conforme os parâmetros enviados;
O mesmo vale para a situação contrária, onde se uma fatura é passada para o status “Cancelado” ou “Aguardando o Reembolso”, o disparo do webhook pode avisar sobre a necessidade da remoção dessa conta ou início de uma recuperação de vendas;
Como crio o Webhook na Eduzz?
No menu principal, clique em "Avançado" depois clique em "Webhook", na versão White e em Integrações, para versão Unity:
(Versão Unity) (Versão White)
Clique no botão "+ Nova URL":
Preencha o formulário com as seguintes informações:
- Nome: Nome de identificação do webhook a ser cadastrado;
- Tipo: Atualização de status de fatura e criação de contrato (invoice) e abandono de carrinho (abandonment);
- Produto: Escolha de qual produto deseja receber o webhook na URL cadastrada. Poderá ser escolhido um produto ou todos. Não é possível escolher múltiplos produtos, somente 1 ou todos.
- URL: Neste campo coloque a URL gerada na ferramenta a ser vinculada e que receberá o webhook.
Obs.: quando utilizando o webhook, para que você possa receber as duas integrações, é necessário cadastrar duas vezes a mesma url para os tipos de fatura e abandono.
Após concluir, clique no botão "Salvar" e seu webhook estará salvo e ativo.
Quais configurações posso realizar no meu Webhook?
Na tela inicial, na aba Webhooks, são exibidos todos os webhooks que você cadastrou. Você pode ativar ou desativar o webhook ao clicar no botão de habilitar . Clicando no botão de três pontinhos você terá as opções de "Alterar", "Enviar teste" e "Remover" o webhook selecionado:
Ao clicar em "Enviar teste", será pedido um número de fatura e o status da mesma. Caso a fatura pertença ao seu cadastro, o webhook será enviado com dados reais. Caso contrário, serão enviados dados fictícios:
Na aba de "Histórico" serão mostrados todos os disparos feitos pelo webhook. Será mostrado o "Retorno HTTP" da URL cadastrada e caso o retorno não seja de sucesso ficará habilitado o botão "Tentar Novamente" para uma nova tentativa de disparo. Ao clicar no botão "..." você verá as "Tentativas de envio" (sem disparo manual) do webhook, com detalhes de data do disparo, resposta da URL e a data/hora que será realizada a próxima tentativa de disparo. Também serão mostrados os dados enviados:
A documentação completa com a lista de parâmetros, tabela de status das faturas, tabela de formas de pagamentos e demais detalhes você encontra clicando aqui.
Os filtros para identificação do Webhook
Por padrão a Eduzz exibe o filtro das faturas. Dessa forma, você consegue verificar todas as integrações que foram criadas com o tipo faturas:
Caso queira verificar as integrações no Webhook de "abandono de carrinho", troque o assunto em "tipo" e clique em filtrar:
Após filtrar, aparecerão todas as integrações para os abandonos de carrinho realizados.
Ficamos muito felizes em te ajudar!😃
Ainda precisa de ajuda? Estamos prontos para te atender!!! 🙂
Caso ainda hajam dúvidas, envie uma solicitação para nossa equipe de suporte pelo link do Formulário
Neste link será pedido algumas informações para que sua identidade seja validada e será onde você poderá relatar o seu problema, para que assim sua dúvida seja encaminhada para a equipe de atendimento, garantindo que sua solicitação seja atendida 😉