O Zapier é o caminho mais rápido para começar, mas ele não é a única opção. Se o seu time já usa Make (antigo Integromat) ou n8n, ótimo: os dois conseguem tanto chamar a API do GS Engage quanto receber avisos dela — sem que ninguém precise programar.

Nesta página você vai montar um cenário completo: quando uma prospecção é marcada como Ganha, o GS Engage avisa o Make ou o n8n, que então cria uma linha numa planilha e manda uma mensagem no Slack para o time comemorar.

As três ferramentas fazem o mesmo trabalho de base — apontar e clicar para integrar. A diferença está no bolso, na hospedagem e em quem cuida do servidor.

Antes de qualquer coisa, você vai precisar da sua apiKey — a chave (de cerca de 40 caracteres) criada na plataforma em Configurações > Configurações de API.

No GS Engage, a chave viaja na URL, como um parâmetro ?apiKey=SUA_CHAVE (não é um cabeçalho). Isso é prático, mas tem uma consequência: a chave aparece em logs de servidor, no histórico do navegador e em qualquer link compartilhado.

Antes de montar automações que criam ou alteram dados, confirme que a chave responde. Use uma operação leve e somente leitura: listar os campos personalizados.

O endpoint (o endereço de uma operação da API) é o GET /api/v1/custom-fields. Chame esta URL:

curl "https://api.gsengage.com/api/v1/custom-fields?apiKey=SUA_CHAVE"

Uma resposta 200 com uma lista confirma que a chave está válida. A lista pode vir vazia ([]) se o projeto ainda não tem campos personalizados — e está tudo certo assim.

Nenhuma das duas ferramentas tem um "app do GS Engage" pronto. Em vez disso, você usa o bloco genérico de requisição HTTP — o mesmo que serve para qualquer API REST.

Um exemplo de escrita: criar um lead. Um lead criado via API entra marcado como Levantada de Mão e aparece no topo da fila de atividades do vendedor. É obrigatório pelo menos um contato — os contatos vão nos arrays emails, phones e mobiles.

{
  "name": "Maria Souza",
  "emails": [
    { "value": "maria@empresa.com", "label": "Trabalho" }
  ]
}

Depois de enviar esse corpo para POST https://api.gsengage.com/api/v1/leads?apiKey=SUA_CHAVE, a API responde com o lead criado — e o vendedor já vê a Levantada de Mão no topo da fila.

Agora o principal: fazer o GS Engage avisar você. O objetivo de negócio é simples — toda vez que uma prospecção for marcada como Ganha, o time quer ver isso registrado numa planilha e comemorar no Slack. Sem ninguém copiar e colar.

O evento que dispara tudo é o prospection.won.

graph LR
A["Prospecção marcada como Ganha"] --> B["GS Engage envia webhook prospection.won"]
B --> C["Make / n8n recebe o aviso"]
C --> D["Cria linha na planilha"]
C --> E["Manda mensagem no Slack"]

Passo 1 — Crie a URL que vai receber os avisos

Primeiro você precisa de um endereço para o GS Engage chamar. Cada ferramenta gera esse endereço para você.

Passo 2 — Registre o webhook no GS Engage

Com a URL em mãos, diga ao GS Engage para avisar esse endereço quando houver uma venda ganha. Isso é uma chamada de escrita para o POST /api/v1/webhooks, com o nome, a sua URL e a lista de eventos que você quer ouvir.

{
  "name": "Venda Ganha -> planilha e Slack",
  "url": "https://SUA_URL_DO_MAKE_OU_N8N",
  "events": ["prospection.won"]
}

Envie esse corpo para POST https://api.gsengage.com/api/v1/webhooks?apiKey=SUA_CHAVE. Você pode fazer isso pelo próprio módulo HTTP do Make/n8n, ou por um curl avulso.

Passo 3 — Confira que o aviso está chegando

Marque uma prospecção de teste como Ganha (ou aguarde a próxima venda real) e veja o aviso chegar. Cada entrega é um POST para a sua URL com este envelope:

{
  "id": "...",
  "test": false,
  "event": "prospection.won",
  "data": { "...": "dados da prospecção" },
  "retries": 0,
  "manualRetries": 0,
  "createdAt": "..."
}

O campo event diz qual foi o gatilho (prospection.won) e o data traz os detalhes da prospecção. É desse envelope que você vai puxar as informações para a planilha e para o Slack.

Passo 4 — Confirme que o aviso é autêntico

Como a sua URL fica exposta na internet, qualquer um poderia tentar mandar um POST fingindo ser o GS Engage. Para evitar isso, cada entrega vem assinada com HMAC SHA-256 — uma assinatura calculada a partir do corpo do aviso e do seu secret, enviada num cabeçalho.

A ideia: você recalcula a assinatura do lado de cá, usando o mesmo secret, e compara com a que veio no cabeçalho. Se baterem, o aviso é legítimo. Se não, descarte.

Passo 5 — Registre na planilha e avise no Slack

Confirmado que o aviso é real, é só ligar os módulos de saída, puxando os campos de dentro de data:

Pronto: a partir daqui, toda venda Ganha registra sozinha uma linha na planilha e cai no Slack do time — sem trabalho manual.