Não. Dá para integrar sem escrever nenhuma linha de código usando Zapier, Make ou n8n — você monta a automação arrastando blocos. Comece pela trilha Sem código. Se você (ou seu time de tecnologia) preferir programar, a API REST está toda na Referência.

Dentro da plataforma, em Configurações > Configurações de API. A chave tem cerca de 40 caracteres. Se estiver em dúvida sobre qual trilha seguir, veja Escolha seu caminho.

Faça uma leitura leve e segura: liste os campos personalizados. Um 200 com uma lista (mesmo vazia, []) confirma que a chave funciona.

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

Não existe GET /info nem GET /health — este é o teste de saúde recomendado.

Não. A chave continua válida enquanto existir na plataforma. Se precisar revogá-la, remova ou substitua em Configurações > Configurações de API.

A apiKey viaja na própria URL, no formato ?apiKey=SUA_CHAVE. Isso significa que ela pode aparecer em logs de servidor, no histórico do navegador e em links compartilhados. Por isso, trate-a como uma senha.

Não. Toda chamada é real e afeta os dados de produção — os mesmos que o time comercial usa. Ao experimentar, prefira operações de leitura (consultar dados) e avise sua equipe antes de qualquer escrita (criar, editar ou remover).

As duas coisas iniciam a prospecção, mas por caminhos diferentes:

• Adicionar lead à cadência coloca um lead já existente em uma cadência. Se a distribuição automática estiver ativa (ou você informar um responsável), a prospecção começa sozinha.
• Criar prospecção monta a prospecção diretamente, indicando o lead, a cadência e, opcionalmente, o responsável.

Na prática: use "adicionar à cadência" quando o gatilho é o lead entrar no fluxo; use "criar prospecção" quando você já sabe exatamente lead, cadência e vendedor. Veja o passo a passo em Adicionar um lead a uma cadência.

Um lead criado via API entra marcado como Levantada de Mão e aparece no topo da fila de atividades do vendedor. Lembrando que criar um lead exige pelo menos um contato (e-mail, telefone ou celular).

São os estados de uma prospecção. Sempre que for mostrar para alguém, use o rótulo em português que aparece no app:

Ao encerrar uma prospecção como LOST, o motivo da perda (lostReason) é obrigatório.

O 401 (não autorizado) quer dizer que a apiKey está ausente ou inválida. Por quê: a chave não foi enviada na URL, foi digitada errada ou foi revogada. Como corrigir: confira se você incluiu ?apiKey=SUA_CHAVE no fim da URL e se a chave está correta, copiando-a de novo em Configurações > Configurações de API.

O 429 significa que você passou do limite de requisições. Por quê: numa janela de 60 segundos, a API permite 200 leituras/min (GET/HEAD) e 100 escritas/min (POST, PUT, PATCH, DELETE). Como corrigir: espere e tente de novo respeitando o header Retry-After (em segundos), que vem na resposta. A boa prática é usar backoff exponencial — aumentar o intervalo entre tentativas. Os headers X-RateLimit-Remaining e X-RateLimit-Reset ajudam a saber quanto ainda resta e quando o contador zera.

Você cria um webhook — um aviso automático que o GS Engage envia para uma URL sua sempre que algo acontece. Para vendas ganhas, cadastre um webhook ouvindo o evento prospection.won (existem também prospection.lost, prospection.started, entre outros).

O passo a passo está em Avisos de venda por webhook.

Cada entrega é assinada com HMAC SHA-256 — uma assinatura calculada a partir do corpo da mensagem e do seu secret, que vem em um header. Do seu lado, você recalcula a assinatura com o mesmo secret e compara: se baterem, o aviso é autêntico. (A assinatura foi atualizada de SHA-1 para SHA-256.) Veja como validar em Validar a assinatura do webhook.

Sim. O envelope de cada entrega traz os campos retries e manualRetries, que indicam as tentativas automáticas e as manuais. Ou seja, uma mesma entrega pode ser reenviada — e o seu código deve estar preparado para receber o mesmo evento mais de uma vez sem duplicar o efeito.