Você deseja criar uma automatização aqui na Pluga, mas a ferramenta que deseja integrar ainda não está disponível em nosso hub? Calma! O Pluga Webhooks pode te ajudar! 😊
Neste artigo vamos te explicar:
- O que é um webhook?
- Como o Pluga Webhooks funciona?
- E como criar uma automatização via Pluga Webhooks?
O que é um webhook?
Imagine o seguinte cenário: você quer enviar uma mensagem para um amigo e decide fazer isso através de um SMS!
- Você já sabe a mensagem que deseja enviar;
- Sabe qual amigo deve recebê-la;
- E sabe para qual número de celular quer encaminhar o SMS.
Tendo esses pontos definidos, a comunicação entre você e seu amigo será bem sucedida. 🕺
Essa lógica se mantém a mesma quando falamos em webhook!
Só que em vez de amigos, são as ferramentas que enviam mensagens entre si. O número do celular corresponde à URL que deve receber as informações. E o método de comunicação em si, o SMS, corresponderia ao webhook.
Com isso, a integração via webhook permite o envio de mensagens e execução de ações através de uma URL gerada pela ferramenta que recebe os dados e executa os comandos.
Como o Pluga Webhooks funciona?
O Pluga Webhooks é uma alternativa para criar automatizações com ferramentas ainda não integradas à Pluga.
Importante: Ao criar essa automatização no construtor antigo, utilizando os templates, pelo menos uma das ferramentas de sua automatização precisa estar integrada na Pluga! Mas, você consegue criar automatizações com Pluga Webhooks sendo origem e destino dos dados no novo construtor!
E isso pode acontecer de duas formas:
[1] Quando você deseja capturar informações de uma ferramenta ainda não integrada
Nesse caso, as informações serão enviadas para a Pluga (através do webhook), nós vamos processá-las e enviá-las para uma das ferramentas do nosso hub. Veja na imagem abaixo:
[2] Quando você quiser enviar informações para uma ferramenta ainda não integrada
Nesse outro cenário, nós vamos capturar as informações de uma das ferramentas do nosso hub, processar, e enviá-las para uma ferramenta não integrada à Pluga.
Com isso, para que a sua integração via Pluga Webhooks funcione como o esperado, é necessário que a ferramenta que você deseja integrar atenda a alguns requisitos:
- Permita integração via webhook;
- Tenha o JSON dos campos.
JSON é o formato no qual as informações precisam estar quando são enviadas através das automatizações da Pluga. Por isso, para criar as automatizações, você vai precisar dele! Normalmente, o JSON é algo assim:
{
"nome": "Yoda",
"pais": "lala",
"cargo": "Jedi Master",
"e-mail": "yoda@force.com"
}
Cada ferramenta possui seu próprio JSON que, dependendo, pode acabar sendo um pouco grande e complexo. Mas, com um pouquinho de dedicação, você consegue facilmente encontrá-lo e criar a automatização aqui na Pluga!
Dica: Você pode verificar diretamente com o suporte da ferramenta não integrada se eles já possuem um exemplo de JSON pronto para esses casos de integração via webhook.
E como criar uma automatização via Pluga Webhooks?
Se você chegou até aqui, certamente já percebeu que criar uma automatização com o Pluga Webhooks não é um bicho de sete cabeças. 🚫👾
Agora, você precisa definir se deseja:
- Capturar informações de uma ferramenta ainda não integrada;
- Enviar informações para uma ferramenta não integrada.
Tendo isso em mente, é só seguir os tutoriais abaixo.
Como configurar o Pluga Webhooks para capturar informações de uma ferramenta ainda não integrada
A criação de uma automatização com Pluga Webhooks sendo a origem dos dados segue o fluxo abaixo:
Basicamente, é preciso que você:
- Gere e copie a URL da Pluga;
- Cole a URL da Pluga na ferramenta não integrada (ferramenta de origem dos dados);
- Configure o gatilho da automatização na ferramenta não integrada (o gatilho é a ação que dispara um evento pra Pluga, por exemplo, um novo pagamento aprovado);
- *Cole o JSON com as informações que serão retornadas pela ferramenta não integrada na Pluga;
- Faça o mapeamento na Pluga e finalize a automatização.
Talvez você se perca um pouquinho na etapa 4 - principalmente se não encontrar o JSON na ferramenta que deseja integrar.
No geral, a própria ferramenta pode te auxiliar (seja através da documentação dela ou por suporte), mas, se você chegou até aqui e ainda não tem o JSON em mãos, em alguns casos o suporte da Pluga pode ajudar.
Mas, para isso, é necessário que você configure corretamente o webhook em sua ferramenta de origem, cole a URL da Pluga lá, finalize a automatização e envie uma notificação como teste.
Assim, nós receberemos as informações no formato de JSON que você precisa para configurar corretamente a automatização.
Daí, é só entrar em contato com o nosso time de suporte pelo e-mail suporte@pluga.co informando o ID da sua automatização e nós te enviamos o JSON. Depois disso, é só acessar o seu mapeamento novamente e atualizar o JSON!
Caso tenha ficado com alguma dúvida, também preparamos um vídeo que poderá te ajudar. Confira:
Como configurar o Pluga Webhooks para enviar informações para uma ferramenta não integrada
Já a configuração do Pluga Webhooks sendo o destino dos dados, segue o fluxo abaixo:
Nesse caso, você vai seguir os passos:
- Gere uma URL na ferramenta que deve receber as informações da Pluga (a ferramenta não integrada);
- Se necessário, configure o webhook lá na ferramenta, indicando qual ação você quer que seja executada;
- Cole a URL gerada na ferramenta não integrada na Pluga;
- *Monte o mapeamento com base no JSON esperado pela ferramenta de destino;
- Finalize a automatização e inicie o envio das informações!
*No passo 4, é fundamental que você monte o mapeamento preenchendo o campo “Chave” com a informação correta esperada pela ferramenta não integrada, geralmente indicada com um JSON exemplo.
Dessa forma, a ferramenta vai entender exatamente o que ela está recebendo da Pluga.
Por exemplo, se a ferramenta de destino chama o campo “nome do cliente” de “name”, então é esse “name” que deve ser preenchido no mapeamento da automatização.
Ainda no exemplo acima, se você tivesse escrito na chave “nome do cliente” a ferramenta destino não iria entender essa forma de escrita (a notação) e não conseguiria realizar determinada ação para você.
Por isso, o JSON de exemplo é muito importante nesse momento. :)
No vídeo abaixo você pode ver o passo a passo de como criar essa automatização, para enviar informações para uma ferramenta ainda não integrada!
Dúvidas?
Caso ainda tenha dúvidas, é só solicitar um atendimento que nosso time de suporte entrará em contato dentro de algumas horas ;)