Webhooks: o que são e como usar

Modified on: 2019-09-20 09:50:04 -0300


Dentro do módulo de Automações, uma das ações disponíveis é a de Webhook. Nesse artigo explicaremos quem é ele e como usá-lo na Edools.


De maneira conceitual, uma pesquisa rápida ao Google sobre o que são os Webhooks:


O webhook (também conhecido como retorno de chamada web ou HTTP e, ainda, impulso API) é uma maneira prática para um app ou sistema fornecer outras aplicações com informações em tempo real. O webhook fornece dados para outros aplicativos.


Ou seja, o Webhook é uma ferramenta para conectar aplicações. Pensando de maneira completamente metafórica, os Webhooks para a gente são mensageiros que levam pacotes de informações da Edools para algum lugar.


Configuração do Webhook


Após escolher o gatilho, filtro e setar a ação como Webhook, o último passos será a configuração



No campo URL, digite o endereço onde o Webhook realizará a ação. Esse endereço pode ser o endpoint de uma API, por exemplo.


Logo abaixo você encontrará outros dois campos: Método e Headers



O método dependerá muito do objetivo da sua automação, podendo ser utilizado para retornar apenas dados (GET), criar um recurso (POST), atualizá-lo (PUT), etc.


Nos headers você terá espaço para inserir chave e valor, clicando no ícone ao lado. Exemplo:



Nesse caso, a sua requisição estará enviando o header:



Nos headers também geralmente são enviadas as autorizações da requisição, como um token de API, por exemplo.


Por último, temos Liquid Key e o Body e esses campos são alternativos entre si. Ou seja, você pode escolher um ou outro já que eles cumprem a mesma função. De maneira resumida, os dois campos serão o corpo da sua requisição. Ou seja, a mensagem que você quer enviar através do webhook.


O Liquid Key é uma chave que está disponível no código-fonte do seu tema, na pasta Hashes. Cada arquivo dentro dessa pasta tem um liquid key e variáveis que podem ser usadas no momento do envio de informações.


 

Por exemplo, o liquid key confirmed_order carrega variáveis do usuário, dos produtos que ele comprou, pagamento e dados da Escola. 


Caso você queira configurar sua automação com o Body, basta preencher o campo com o json que você deseja enviar na requisição. 


O poder dos Webhooks


Preparamos um case sobre como o nosso cliente Clint Hub utilizou os Webhooks para automatizar sua operação e, mais do que isso, gerar engajamento nos seus usuários. Confira aqui!



Isso foi útil para você? Sim Não

Você pode nos dizer como podemos melhorar este artigo?