Todas as categorias > API > Como utilizar o Webhook da Huggy?

Como utilizar o Webhook da Huggy?

CRIADO por Calebe Ribeiro

O Webhook é um recurso que permite a uma aplicação enviar informações para outra sempre que determinados eventos acontecerem.

Na Huggy, esses eventos vão desde o recebimento de uma mensagem à criação de um contato, alteração de status de um agente, e muito mais.

Você tem sempre a liberdade de escolher quais eventos monitorar e os sistemas que deseja conectar, seja para:

Desenvolver relatórios em tempo real;
Integrar a Huggy com seu CRM;
Automatizar o disparo de mensagens pós-evento;
Entre outros.

Neste artigo, você vai aprender como configurar nosso Webhook e as diferentes maneiras de usá-lo.

Ainda não tem familiaridade com essa tecnologia? Clique aqui e dê seus primeiros passos.

Quais eventos podem ser monitorados?

Confira abaixo a lista de eventos que podem ser monitorados na Huggy:

Mensagem recebida
Mensagem recebida (todas)
Mensagem enviada (todas)
Chat criado
Chat fechado
Contato criado
Chat de widget iniciado
Flow iniciado
Flow finalizado
Agente inserido
Atualização de contato
Agente alterou status
Workflow do chat atualizado
Chat criado
Chat saiu da fila

Como funcionam as notificações de Webhook?

A Huggy enviará uma requisição HTTP do tipo POST para o sistema destino quando um ou mais eventos selecionados ocorrerem. Essas requisições são automáticas e podem ser realizadas para diferentes sistemas de forma simultânea.

As informações contidas nas requisições variam de acordo com o tipo de evento.

Confira mais detalhes sobre o formato e informações dos eventos clicando aqui.

Devido à natureza da rede, as requisições podem chegar ao servidor de destino em uma ordem diferente da prevista no disparo. Quando necessário, você poderá utilizar a API para validar a ordem dos eventos.

O que ocorre se o sistema de destino estiver fora do ar?

Caso o sistema de destino esteja fora do ar, ou responda às requisições do Webhook com um código diferente da faixa 2XX (que indica sucesso), a Huggy fará mais três tentativas de envio do evento em um intervalo de 10 segundos.

Como utilizar o Webhook de forma segura?

Para garantir mais segurança em suas soluções, todas as notificações feitas pelo Webhook da Huggy são autenticadas. Você verá mais sobre esse procedimento neste artigo.

O disparo das notificações acontece apenas nas portas já padronizadas para servidores web — 80 (HTTP) ou 443 (HTTPS). Outras portas não são suportadas.

Recomendamos o uso do protocolo HTTPS para a comunicação, pois ele é mais seguro e criptografado.

A Huggy utiliza IPs dedicados para realizar as notificações.

Como configurar o Webhook na Huggy?

Confira agora as duas opções para a configuração do Webhook na plataforma:

Pela configuração padrão

Nesta abordagem, todos os eventos que você escolher serão enviados para um único sistema externo.

Acesse Configurações > Webhook e clique no ícone de lápis para editar as configurações.

Em URL, adicione o endereço do seu sistema e clique em Salvar.

Nesse momento, a Huggy enviará uma requisição para o seu sistema. Essa requisição será do tipo POST e conterá um Token único. É importante que o seu sistema responda com o mesmo token para confirmar a autenticidade da requisição.

Aqui está um exemplo de implementação da autenticação no Google Apps Script:

function doPost(e) {
var params = JSON.parse(e.postData.contents);

if (params.hasOwnProperty('validToken')) {
return ContentService.createTextOutput(params.token);
    };
};

A forma de configurar o retorno do token varia de acordo com a plataforma ou linguagem que você está utilizando. Clique aqui para ver o exemplo acima com detalhes, incluindo informações específicas sobre a implementação no Google Apps Script.

Por aplicativos Huggy

A Huggy facilita o desenvolvimento e gerenciamento de suas integrações por meio de aplicativos. Eles permitem a utilização dos recursos tanto da API quanto do Webhook.

Os aplicativos criados na plataforma possuem credenciais dedicadas e devem ser autenticados separadamente. Isso traz muitas vantagens, como um maior controle das operações efetuadas em sua conta e o desenvolvimento de integrações independentes.

Como configurar o Webhook em um aplicativo da Huggy?

Crie um aplicativo

O primeiro passo é criar um aplicativo acessando Configurações > Seus aplicativos > Adicionar aplicativo. Dê um nome para seu Aplicativo e clique em Adicionar.

Autentique seu aplicativo

Para ativar a API e utilizar o Webhook, você precisa seguir um fluxo de autenticação OAuth 2.0.

Você pode implementar o fluxo na linguagem que desejar, mas disponibilizamos uma solução pronta que funciona no Google Planilhas. Com ela, você pode autenticar o aplicativo e iniciar seus testes e validações.

Clique aqui para acessar a solução de autenticação. Se quiser saber mais sobre o fluxo de autenticação, consulte a nossa documentação.

Adicione a URL do seu sistema

Depois de autenticar o aplicativo, indique a URL do sistema que receberá as notificações. Para isso, clique no ícone de edição do Aplicativo, digite a URL do seu sistema, selecione os eventos que quer monitorar e clique em Salvar.