Esta página é o dicionário oficial do GS Engage. Sempre que aparecer uma palavra estranha em outra doc, volte aqui. Organizamos por assunto para você achar rápido, mas se preferir, use o índice do navegador (Ctrl+F / Cmd+F) e busque pelo termo.

Estes são os termos que aparecem quando falamos em conectar dois sistemas. Não se assuste: cada um tem uma tradução simples.

Aqui moram os termos ligados a "provar quem é você" e proteger seus dados. Vale a leitura com calma.

Termos que explicam "quantas chamadas posso fazer" e "como a resposta vem organizada".

Quando exceder o limite, a resposta é um HTTP 429 e traz estes cabeçalhos para você se organizar:

{
  "X-RateLimit-Limit": "200",
  "X-RateLimit-Remaining": "0",
  "X-RateLimit-Reset": "1721232000",
  "Retry-After": "37"
}

Uma resposta paginada tem sempre este formato — a lista fica em data e o resumo em meta:

{
  "data": [ /* ... seus itens ... */ ],
  "meta": {
    "limit": 20,
    "count": 20,
    "total": 137,
    "page": 1,
    "totalPages": 7
  }
}

Webhook é como pedir para o GS Engage te avisar sozinho quando algo acontece — sem você ficar perguntando o tempo todo.

Estes são os eventos que você pode assinar:

Cada aviso que chega na sua URL vem embrulhado neste "envelope":

{
  "id": "65a1f2c3d4e5f6a7b8c9d0e1",
  "test": false,
  "event": "prospection.won",
  "data": { /* ... detalhes do que aconteceu ... */ },
  "retries": 0,
  "manualRetries": 0,
  "createdAt": "2026-07-17T12:00:00.000Z"
}

Ao ler esse envelope, confira a assinatura HMAC SHA-256 antes de confiar no conteúdo — é ela que garante que o aviso veio mesmo do GS Engage.

Agora os termos que você já conhece do app, com o nome que a API usa por trás. Sempre que houver diferença entre o rótulo técnico e o rótulo que aparece na tela, mostramos os dois.

"Enum" é só uma lista fechada de opções possíveis. A API guarda um valor técnico (em inglês, maiúsculas), mas no app você vê o rótulo em português. Aqui estão os dois lado a lado.

Situação da prospecção

Origem do lead (sourceType)

Modo de execução da cadência (executionMode)

Tipo de aquisição (acquisitionType)

De onde o lead surgiu, do ponto de vista comercial. É um dos filtros de cadências e leads.

Antes de sair integrando, vale confirmar que sua apiKey funciona. O jeito mais leve é pedir a lista de campos personalizados — é uma leitura, não muda nada.

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

Se voltar um 200 com uma lista (mesmo que seja [], caso o projeto ainda não tenha campos), sua chave está valendo. Se voltar 401, a chave está ausente ou errada — confira em Configurações de API.