Menu

Guias

SDK, n8n, Zapier e Make

Integrações prontas: SDK TypeScript, node do n8n e apps do Zapier e do Make.

Ver em Markdown

Para usar a API sem escrever código (ou escrevendo menos), a ConverZAP tem integrações prontas. Todas usam a mesma chave (czk_live_…) criada em Configurações → API pública e seguem as mesmas regras da API (escopos, plano, janela de 24 h).

SDK TypeScript

npm install @converzap/sdk
import { ConverZap } from "@converzap/sdk";

const cz = new ConverZap({ apiKey: process.env.CONVERZAP_API_KEY! });
const contato = await cz.upsertContact({ body: { name: "Ana", phone: "+5511987654321", labels: ["lead"] } });
for await (const negocio of cz.paginate(cz.listDeals, { query: { status: "open" } })) console.log(negocio.title);

Um método tipado por endpoint, sem dependências (Node 18+, Deno, Bun e edge). Erros viram ConverZapError com o code estável; verifyWebhook confere a assinatura dos webhooks.

n8n

Em Settings → Community Nodes → Install, instale n8n-nodes-converzap e crie a credencial ConverZAP API com a sua chave.

  • ConverZAP: contatos, conversas, mensagens (texto, template, nota, agendada), negócios, campanhas, automações e agentes de IA. Pode ser usado como ferramenta de um AI Agent do n8n.
  • ConverZAP Polling Trigger: novo contato, contato atualizado, novo negócio, nova conversa, conversa aguardando humano — em todos os planos com API.
  • ConverZAP Trigger (instantâneo): mensagem recebida/enviada/status e eventos de conversa, nos planos com webhooks. O webhook é criado e removido sozinho ao ativar/desativar o workflow.

Zapier (em breve)

O app ConverZAP está em revisão no Zapier. Enquanto isso, use o passo Webhooks by Zapier ("Custom Request") com o header Authorization: Bearer czk_live_… para chamar qualquer endpoint. Gatilhos previstos: novo contato, novo negócio, nova conversa e conversa aguardando humano. Ações: criar/atualizar contato, etiquetar, enviar texto ou template, nota interna, criar e mover negócio, inscrever em automação.

Make (em breve)

O app ConverZAP para o Make está sendo preparado. Enquanto isso, use o módulo HTTP → Make a request com o header Authorization: Bearer czk_live_….

Boas práticas

  • Uma chave por integração, só com os escopos necessários — fica fácil revogar uma sem parar as outras.
  • Envios de mensagem já levam Idempotency-Key automaticamente: repetir um passo não manda duas vezes.