DocumentaçãoComeçar
Início rápido
Do zero ao primeiro evento na Holdy em quatro passos: crie a API key, escolha a porta de entrada, envie eventos e identifique usuários e contas.
Existem três portas de entrada, e todas convergem no mesmo endpoint — escolha a que encaixa no seu caso:
- SDK — o caminho primário. Instrumenta seu produto direto, no browser e no servidor.
- Conectores — se você já usa PostHog ou Mixpanel, a Holdy puxa os eventos de lá. Sem código.
- API REST — para qualquer outra stack, um
POSTsimples.
1. Gere o token de instalação
Em Configurações → SDK, clique em Gerar token. Ele tem o formato hol_live_… e é uma chave pública: pode ir no código do browser. Chaves secretas (pra backend e API REST) ficam em Configurações → API.
2. Instale o SDK
O caminho mais curto é o script tag: não precisa de build e está sempre na versão mais nova.
<script src="https://holdy.chat/sdk/v1/holdy.js"></script>
<script>Holdy.init({ apiKey: 'hol_live_...' })</script>
Se preferir o pacote no seu build:
npm install @holdyapp/sdk
Sem acesso ao registro npm? O mesmo pacote é servido pela Holdy: npm install https://holdy.chat/sdk/holdyapp-sdk-1.9.0.tgz.
import { initHoldy } from '@holdyapp/sdk/web'
export const holdy = initHoldy({ apiKey: 'hol_live_...' })
Há também um comando que detecta o framework e insere o SDK no lugar certo: npx @holdyapp/install hol_live_...
Pronto: pageviews, sessões e fricção começam a chegar sozinhos. A instância também fica em window.Holdy, pra chamar de qualquer arquivo.
3. Identifique pessoa e empresa
Depois do login, diga quem é a pessoa e a que empresa ela pertence, com os ids do seu produto:
holdy.identify(user.id, { email: user.email, name: user.name })
holdy.group(company.id, { name: company.name, plan: company.plan })
A Holdy resolve a identidade do lado dela, incluindo o merge do histórico anônimo quando a pessoa se identifica. Se o seu produto não tem o conceito de empresa, pule o group(): a Holdy agrupa as pessoas pela empresa do e-mail corporativo.
4. Envie os momentos de valor
holdy.track('report.created', { template: 'weekly' })
Use o vocabulário do seu produto. Evento se registra sozinho no primeiro envio; não precisa declarar nada antes.
O que acontece depois
Com eventos fluindo, a Holdy começa a compor behaviors (você define os principais em minutos, com sugestões da IA), observa o estado por conta e passa a detectar signals. As primeiras opportunities aparecem no Overview — com a evidência de onde vieram.