Growth Station
DocumentaçãoAPI (Desenvolvedores)Sem códigoReceitas prontas

Receitas prontas

Catálogo de automações no-code copiáveis para conectar formulários, RD Station, Google Sheets e Slack ao GS Engage.

Receitas prontas

Automações prontas para copiar: conecte formulários, RD Station, planilhas e Slack ao GS Engage sem escrever código.

Cada receita abaixo é uma automação completa e testada. Você escolhe a ferramenta no-code (Zapier, Make ou n8n), copia os campos e adapta para o seu processo. Pense em cada uma como um pequeno robô: quando algo acontece (o gatilho), ele executa uma ação no GS Engage ou em outro sistema.

Como usar este catálogo

Comece pela receita que resolve a sua dor de negócio. Em cada uma você encontra: o gatilho, a ação, os campos a preencher, o resultado esperado e o link para o guia técnico completo.

Toda chamada é real (não existe ambiente de teste)

O GS Engage não tem sandbox. Qualquer automação que cria ou altera dados afeta a produção de verdade. Ao montar uma receita nova, dispare com um único lead de teste antes de ligar o fluxo para todo mundo.

Todas as receitas usam a mesma autenticação. A chave de API (apiKey) é como uma senha que autoriza a automação a falar com o GS Engage.

1

Copie a sua chave

Na plataforma, vá em ConfiguraçõesConfigurações de API e copie a chave (cerca de 40 caracteres).

2

Guarde como segredo

A chave viaja na URL, no formato ?apiKey=SUA_CHAVE. Ela aparece em logs e históricos. Guarde no cofre de credenciais da sua ferramenta no-code, nunca cole em canais públicos.

3

Valide antes de automatizar

Faça uma chamada leve de leitura para conferir que a chave funciona. Um 200 com uma lista confirma tudo certo.

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

Um retorno 200 (mesmo que seja uma lista vazia []) significa: a chave é válida e você pode seguir para as receitas. Um 401 significa que a chave está ausente ou incorreta.

A base é sempre a mesma

Todos os caminhos ficam sob https://api.gsengage.com/api/v1. A palavra endpoint significa apenas "endereço de uma operação" — cada linha de código abaixo aponta para um deles.


Persona: você recebe leads por um formulário (site, landing page, evento) e quer que cada um entre automaticamente numa Cadência e seja distribuído a um vendedor (SDR), sem digitação manual.

ItemValor
GatilhoNova resposta de formulário (Typeform, Google Forms, RD, etc.)
AçãoAdiciona o lead à cadência e inicia a prospecção com responsável
EndpointPOST /api/v1/routines/{routineId}/lead
Ferramenta recomendadaZapier ou Make
ResultadoLead na cadência, prospecção iniciada, atividade no topo da fila do SDR
1

Escolha a cadência de destino

Liste as suas cadências para descobrir o routineId (o identificador da Cadência). Guarde esse valor — ele vai na URL da ação.

curl "https://api.gsengage.com/api/v1/routines?apiKey=SUA_CHAVE"
2

Configure o gatilho na ferramenta

No Zapier ou Make, crie um Zap/Cenário com o gatilho Nova resposta do formulário. Mapeie os campos do formulário (nome, e-mail, telefone) para usar no próximo passo.

3

Adicione o lead à cadência com um responsável

A ação é uma requisição HTTP (o próprio Zapier tem o passo Webhooks by Zapier → POST; no Make use o módulo HTTP → Make a request).

curl -X POST "https://api.gsengage.com/api/v1/routines/{routineId}/lead?apiKey=SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "lead": {
      "name": "Maria Souza",
      "emails": [{ "value": "maria@empresa.com", "label": "Trabalho" }],
      "mobiles": [{ "value": "+5511999998888", "label": "Celular" }]
    },
    "responsibleId": "ID_DO_SDR"
  }'
Contato do leadobrigatório

Obrigatório pelo menos um contato. Os contatos vão em arrays: emails, phones e mobiles. Cada item tem o formato { "value": "...", "label": "..." }.

responsibleIdopcional

Se você informar o responsibleId (ou se a distribuição automática estiver ativa na cadência), a prospecção inicia na hora e cai para aquele SDR. Sem responsável e sem distribuição automática, o lead entra na cadência mas não começa a ser trabalhado.

O que a resposta significa: o lead entra marcado como Levantada de Mão (o cliente pediu contato) e aparece no topo da fila de atividades do vendedor. Ou seja: o SDR abre o app e a primeira tarefa já é falar com esse lead quente.

Já tem o lead criado?

Se o lead já existe no GS Engage, você pode iniciar a prospecção direto com POST /api/v1/prospections informando leadId, routineId e o responsibleId.


Persona: toda vez que um negócio é ganho, você quer registrar a venda numa planilha (para o financeiro/BI) e comemorar no canal do time no Slack — automaticamente.

Aqui o gatilho não é um formulário: é o próprio GS Engage avisando você. Isso funciona com webhook (um "aviso automático": o GS Engage faz uma chamada para a sua URL quando o evento acontece).

ItemValor
GatilhoEvento de webhook prospection.won (prospecção Ganha)
AçãoCria linha no Google Sheets + envia mensagem no Slack
Endpoint (setup)POST /api/v1/webhooks
Ferramenta recomendadaZapier ou Make (ambos recebem webhooks)
ResultadoCada venda ganha aparece na planilha e no canal do time
1

Crie o gatilho na ferramenta e pegue a URL

No Zapier use o gatilho Webhooks by Zapier → Catch Hook; no Make use Webhooks → Custom webhook. A ferramenta te dá uma URL única. Copie-a.

2

Registre o webhook no GS Engage

Diga ao GS Engage para avisar aquela URL quando uma prospecção for ganha.

curl -X POST "https://api.gsengage.com/api/v1/webhooks?apiKey=SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Venda ganha para planilha e Slack",
    "url": "https://hooks.zapier.com/hooks/catch/000000/abcde/",
    "events": ["prospection.won"]
  }'
3

Guarde o secret na hora

A resposta traz um campo secret. Ele é retornado uma única vez. Copie e guarde no cofre de credenciais — você vai usá-lo para confirmar que cada aviso veio mesmo do GS Engage.

4

Ligue as ações: Sheets e Slack

De volta na ferramenta, adicione duas ações após o gatilho: Google Sheets → Create Spreadsheet Row e Slack → Send Channel Message. Mapeie os campos do corpo do webhook (data) para as colunas da planilha e para o texto da mensagem.

Cada aviso chega no seguinte envelope (o campo data traz os detalhes da prospecção ganha):

{
  "id": "evt_123",
  "test": false,
  "event": "prospection.won",
  "data": { },
  "retries": 0,
  "manualRetries": 0,
  "createdAt": "2026-07-17T14:03:00.000Z"
}

Confirme a autenticidade (HMAC SHA-256)

Cada entrega vem assinada com HMAC SHA-256 — uma "impressão digital" calculada a partir do corpo da mensagem e do seu secret. No app oficial de Zapier e no Make você costuma poder validar isso automaticamente; em fluxos customizados, recalcule a assinatura com o seu secret e compare com o header de assinatura. A assinatura migrou de SHA-1 para SHA-256.

O que isso entrega ao negócio: o financeiro e o BI param de depender de exportação manual, e o time vê cada vitória no Slack em tempo real — sem ninguém copiar e colar nada.

Rótulos que o cliente vê

No app, o status da prospecção aparece assim: Em andamento (IN_PROGRESS), Congelada (FROZEN), Ganha (WON) e Perdida (LOST). Esta receita reage à Ganha.


Persona: seus leads nascem no RD Station (marketing) e você quer que eles apareçam automaticamente no GS Engage para o time comercial trabalhar.

ItemValor
GatilhoNovo lead / conversão no RD Station
AçãoCria o lead no GS Engage
EndpointPOST /api/v1/leads
Ferramenta recomendadaZapier, Make ou n8n
ResultadoLead disponível no GS Engage, pronto para entrar numa cadência
1

Configure o gatilho do RD Station

Na sua ferramenta, use o gatilho de novo lead/conversão do RD Station. Mapeie nome, e-mail e telefone do contato.

2

Crie o lead no GS Engage

A ação é uma requisição HTTP de criação. Lembre: é obrigatório pelo menos um contato.

curl -X POST "https://api.gsengage.com/api/v1/leads?apiKey=SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "João Pereira",
    "company": "ACME Ltda",
    "emails": [{ "value": "joao@acme.com", "label": "Trabalho" }],
    "mobiles": [{ "value": "+5521988887777", "label": "Celular" }]
  }'
3

(Opcional) Já jogue na cadência

Se quiser que o lead entre direto numa cadência, encadeie a Receita R1 usando o id retornado nesta criação.

Pelo menos um contatoobrigatório

A criação falha sem contato. Preencha ao menos um item em emails, phones ou mobiles, sempre no formato { "value": "...", "label": "..." }.

Origem do lead

Um lead criado via API fica com a origem via API (API). Leads que vêm do RD Station dentro do próprio GS Engage aparecem como RD Station (RD_MARKETING); listas importadas aparecem como lista importada (FILE).

O que a resposta significa: o retorno traz o id do novo lead. A partir daí, ele já existe no GS Engage e pode ser distribuído, colocado em cadência ou trabalhado normalmente.


Fazer
  • Dispare cada receita nova com um único lead de teste antes de ligar para todo o fluxo — não existe sandbox.
  • Guarde a apiKey e o secret do webhook no cofre de credenciais da sua ferramenta no-code.
  • Respeite o header Retry-After quando receber 429 e use recuo (backoff) entre tentativas.
Não fazer
  • Não cole a apiKey em canais públicos, prints ou mensagens — ela viaja na URL e vaza fácil.
  • Não ignore o secret do webhook: ele é mostrado uma única vez, na resposta da criação.
  • Não dispare centenas de chamadas de uma vez sem controle — há limite por minuto.

Limite de requisições (rate limit)

O rate limit é o teto de chamadas por minuto. A janela é de 60s: 200 leituras/min (GET) e 100 escritas/min (POST, PUT, PATCH, DELETE). Ao estourar, você recebe 429 com o header Retry-After (segundos até liberar). Automações que processam muitos leads devem esperar esse tempo antes de tentar de novo.

Quando algo dá errado

As mensagens de erro do GS Engage já vêm em português e podem ser reaproveitadas direto na sua automação.

CódigoO que houveComo corrigir
400Corpo inválido (ex.: lead sem contato)Leia o array errors[] — ele diz o field e a message do problema
401apiKey ausente ou inválidaConfira a chave em Configurações → Configurações de API
404Recurso não encontrado (ex.: routineId errado)Reliste as cadências ou leads para pegar o ID certo
429Estourou o limite por minutoAguarde o Retry-After e tente de novo com backoff

Preciso saber programar para usar estas receitas?

Não. Zapier e Make montam tudo com passos visuais. O n8n é um pouco mais técnico, mas também dispensa código. Os blocos curl acima servem para você conferir o formato dos campos, não para digitar num terminal.

Qual ferramenta escolher: Zapier, Make ou n8n?

O GS Engage expõe gatilhos nativos de Zapier, então é o caminho mais rápido para começar. Make é ótimo para fluxos com muitas ramificações e costuma sair mais barato em volume. n8n é a opção para quem quer hospedar o próprio ambiente e ter controle total.

Como testo um webhook sem esperar uma venda real acontecer?

O envelope de entrega tem um campo test. Entregas de teste chegam com test: true, então você consegue diferenciar um disparo de teste de um evento real na sua automação.

Perdi o secret do webhook. E agora?

O secret só aparece na resposta da criação (POST /api/v1/webhooks). Se você o perdeu, remova o webhook antigo (DELETE /api/v1/webhooks/{webhookId}) e crie um novo para receber um secret fresco.


Este artigo foi útil?

Nesta página

Última atualização