Como realizar a integração via Webhook com o GS Engage?
A integração via Webhook no GS Engage é uma funcionalidade essencial para automatizar e otimizar fluxos de trabalho, permitindo que diferentes sistemas se comuniquem de forma eficiente. Webhooks são uma maneira de receber notificações em tempo real sobre eventos ocorridos em um sistema, sem a necessidade de consultas constantes. Isso é particularmente útil em ambientes de vendas e marketing, onde a agilidade na troca de informações pode fazer uma grande diferença.
O que é um Webhook?
Um Webhook é um método de comunicação entre sistemas que permite que um aplicativo envie dados automaticamente para outro aplicativo quando um evento específico ocorre. Ao contrário das APIs tradicionais, que exigem que um sistema solicite informações, os webhooks enviam informações assim que um evento é acionado.
Como funcionam os Webhooks?
- Configuração: Primeiramente, você deve configurar o sistema para enviar dados para uma URL específica sempre que um evento ocorrer.
- Evento: Quando o evento ocorre (por exemplo, um lead é dado como agendado), o sistema dispara o webhook.
- Envio de Dados: O sistema envia os dados do evento para a URL configurada. As informações enviadas geralmente é um objeto JSON que contem detalhes sobre o evento.
- Processamento: A aplicação receptora processa os dados e realiza as ações configuradas (como atualizar uma base de dados ou enviar uma notificação).
Quais são os eventos disponíveis para a integração via Webhook no GS Engage?
Os eventos disponíveis para integração via Webhook no GS Engage são:
- prospection.won: Envia informações quando um lead é considerado uma conversão bem-sucedida, ou seja, quando um lead recebe o status de Agendado no GS Engage.
- prospection.lost: Envia informações quando que um lead for marcado como Perdido no GS Engage.
Como configurar Webhooks no GS Engage?
Para configurar a integração via Webhook no GS Engage, siga os seguintes passos:
Acesse Ajustes e Permissões
Acesse a página de Ajustes de Permissões, através da navbar clique no atalho Ajustes e Permissões.
Selecione Configurações de Webhook
Selecione a seção de Configurações de Webhook.
Clique em +Novo Webhook
Clique no botão +Novo Webhook para configurar o Webhook.
Preencha as informações
No modal de criação de Webhook, preencha as informações de "Nome do Webhook" e "URL".
Atenção
Para saber mais sobre os eventos e configuração da integração do GS Engage via Webhook acesse a documentação de Webhook do GS Engage.
Selecione o evento
No modal de criação de Webhook, selecione o evento que acionará o envio de informações par a URL informada.
Clique em Criar
Clique em Criar para finalizar a criação do Webhook.
Copie a chave secreta
Após criar o Webhook será geraada a chave secreta vinculada ao Webhook criado, clique em Copiar para guardar a chave e, em seguida, clique em Fechar.
Como acessar os Webhooks criados?
Para acessar os Webhook criados no GS Engage, siga os seguintes passos:
Acesse Ajustes e Permissões
Acesse a página de Ajustes de Permissões, através da navbar clique no atalho Ajustes e Permissões.
Selecione Configurações de Webhook
Selecione a seção de Configurações de Webhook.
Selecione o evento
Nesta seção é possível visualizar os Webhooks criados, juntamente aos eventos associados a cada Webhook.
Como editar um Webhook criado?
Para editar as informações do Webhook criado, siga os seguintes passos:
Acesse Ajustes e Permissões
Acesse a página de Ajustes de Permissões, através da navbar clique no atalho Ajustes e Permissões.
Selecione Configurações de Webhook
Selecione a seção de Configurações de Webhook.
Localize o webhook
Localize o Webhook que deseja editar as informações.
Clique em Editar
Clique no menu de ações, localizado a direita do nome do Webhook criado, e selecione a opção Editar.
Clique em Salvar
No modal exibido altere as informações que deseja e, em seguida, clique em Salvar para que as edições realizadas sejam guardadas.
Como pausar o envio de informações para um Webhook?
Para pausar o envio de informações para um Webhook criado, siga os seguintes passos:
Acesse Ajustes e Permissões
Acesse a página de Ajustes de Permissões, através da navbar clique no atalho Ajustes e Permissões.
Selecione Configurações de Webhook
Selecione a seção de Configurações de Webhook.
Localize o webhook
Localize o Webhook que pausar o envio de informações.
Clique em Pausar
Clique no menu de ações, localizado a direita do nome do Webhook criado, e selecione a opção Pausar.
Atenção
Após pausar o envio de informações para o Webhook, ele receberá o status de Pausado para sinalizar que os dados associados aos eventos não estão sendo enviados para a URL configurada.
Como reativar o envio de informações para um Webhook pausado?
Para reativar o envio de informações para um Webhook pausado, siga os seguintes passos:
Acesse Ajustes e Permissões
Acesse a página de Ajustes de Permissões, através da navbar clique no atalho Ajustes e Permissões.
Selecione Configurações de Webhook
Selecione a seção de Configurações de Webhook.
Localize o webhook
Localize o Webhook que deseja reativar.
Clique em Ativar
Clique no menu de ações, localizado a direita do nome do Webhook criado, e selecione a opção Ativar.
Atenção
Após reativar o envio de informações, o Webhook receberá o status de Ativo sinalizando que as informações associadas aos eventos estão sendo enviadas para a URL configurada.
Como regerar a chave secreta do Webhook?
Para regerar a chave secreta associada a um Webhook criado, siga os seguintes passos:
Acesse Ajustes e Permissões
Acesse a página de Ajustes de Permissões, através da navbar clique no atalho Ajustes e Permissões.
Selecione Configurações de Webhook
Selecione a seção de Configurações de Webhook.
Localize o webhook
Localize o Webhook que deseja regerar a chave secreta.
Clique em Editar
Clique no menu de ações, localizado a direita do nome do Webhook criado, e selecione a opção Editar.
Copie a chave secreta
Copie e Salve a nova chave secreta gerada e, em seguida, clique em Fechar.
Como excluir um Webhook criado no GS Engage?
Para excluir um Webhook criado, siga os seguintes passos:
Acesse Ajustes e Permissões
Acesse a página de Ajustes de Permissões, através da navbar clique no atalho Ajustes e Permissões.
Selecione Configurações de Webhook
Selecione a seção de Configurações de Webhook.
Localize o webhook
Localize o Webhook que deseja excluir.
Clique em Excluir
Clique no menu de ações, localizado a direita do nome do Webhook criado, e selecione a opção Excluir.
Confirme a exclusão
Confirme a exclusão do Webhook clicando em Excluir Webhook.
Casos de uso comuns
- Integração com CRM: Ao integrar o GS Engage com um CRM via webhook, você pode automaticamente criar ou atualizar registros de leads no CRM sempre que um lead no GS Engage atingir um determinado estágio.
- Notificações em Tempo Real: Configure webhooks para enviar notificações a um sistema de mensagens ou e-mail sempre que um lead é atualizado, garantindo que sua equipe de vendas esteja sempre informada sobre mudanças importantes.
Atenção
Através da API do GS Engage é possível listar webhooks criados, criar novos webhooks e excluir webhook, para saber mais sobre esse método acesse a Documentação da API do GS Engage.
Ainda tem dúvida? Abra uma solicitação para o nosso time.
Este artigo foi útil?