sparkcrm dá acesso tipado à API do Spark a partir de TypeScript ou JavaScript no servidor. O código-fonte e o changelog ficam no repositório gepetojj/spark-typescript.
Requisitos
- TypeScript 4.9 ou superior, se você usa TypeScript.
- Node.js 20 LTS ou superior, ou outro runtime compatível: Bun 1.0+, Deno 1.28+, Cloudflare Workers, Vercel Edge Runtime ou Nitro 2.6+.
- React Native não é suportado.
- Uma chave secreta (
sk_…) da organização, com o ambiente de desenvolvedores habilitado. Veja Modo Desenvolvedores.
Instalação
Configurar o cliente
Crie o cliente uma vez por processo e reutilize. Em ambientes serverless, crie um por requisição.
Se você não passar
apiKey, o cliente lê SPARK_API_KEY do ambiente.
Primeira chamada
Liste os canais (entrypoints) da organização:Tipos exportados
Parâmetros e respostas de cada método são tipados. Use o namespaceSparkCRM para anotar variáveis:
client.entrypoints.list, para ver a descrição de cada campo.
Fluxos comuns
Criar ou atualizar um chat
Enviar mensagem de texto
Enviar mídia
Faça o upload do arquivo e use oid devolvido no envio:
Enviar modelo com variáveis
Envie as variáveis manuais emcommonVariables (var1, var2, …). As variáveis automáticas, como o nome do chat, são preenchidas pelo Spark. Veja Modelos de mensagem.
Enviar resposta a um formulário
Webhooks
O SDK não recebe nem envia webhooks. Ele exporta os tipos dos eventos (SparkCRM.MessagesReceivedWebhook e outros) para você tipar o handler depois de verificar a assinatura. Veja TypeScript: webhooks e tipos.
Próximos passos
- Referência de recursos: todos os métodos e tipos por recurso.
- Erros e uso avançado: retentativas, timeouts e logs.
- Introdução à API: chaves, limites de uso e erros.

