REST API · v1

API Aberta.
Integre tudo.

Conecte a HUB Growth MKT aos seus sistemas existentes via API REST. Webhooks em tempo real, autenticação JWT e documentação completa.

🔗 Base URL

https://app.hubgrowth.com.br/api

Todos os endpoints são prefixados com /api. Use HTTPS sempre.

🔑 Autenticação

// Header obrigatório Authorization: Bearer SEU_JWT_TOKEN X-Tenant-Slug: seu-workspace

Token JWT obtido via POST /auth/login. Expira em 15 minutos.

Endpoints principais

Autenticação

POST
/auth/login

Autenticar usuário e obter token JWT

// Body { "tenantSlug": "meu-workspace", "email": "user@email.com", "password": "senha" } // Response { "accessToken": "eyJ...", "user": { "id": "...", "name": "...", "role": "ADMIN" } }

CRM — Contatos & Deals

GET
/crm/contacts?search=&limit=50&offset=0

Listar contatos com busca e paginação

POST
/crm/contacts

Criar novo contato no CRM

{ "name": "João Silva", "email": "joao@email.com", "phone": "11999999999", "channel": "manual", "tags": ["lead"] }
GET
/crm/deals?search=&stageId=

Listar deals do funil com filtros

POST
/crm/deals

Criar deal em uma etapa do funil

{ "contactId": "...", "stageId": "...", "title": "Proposta João", "value": 1500, "notes": "Interesse no plano Growth" }

Inbox Unificado

GET
/inbox/conversations?status=open&channel=whatsapp

Listar conversas com filtros (status, canal, atendente)

POST
/inbox/conversations/:id/messages

Enviar mensagem em uma conversa

{ "content": "Olá! Como posso ajudar?", "type": "text" }
PATCH
/inbox/conversations/:id

Atualizar status (open/bot/closed) ou atribuir atendente

Webhooks (eventos em tempo real)

Configure um endpoint no seu sistema para receber eventos em tempo real. Configure em Configurações → Integrações → Webhooks.

Eventos disponíveis
new_message — nova mensagem recebida
new_lead — novo lead pelo formulário
new_appointment — novo agendamento
conversation_assigned — atribuição
Payload de exemplo
{ "type": "new_message", "title": "Nova mensagem", "body": "Olá, preciso de ajuda", "meta": { "convId": "...", "channel": "whatsapp" }, "createdAt": "2025-06-01T..." }

Server-Sent Events (SSE)

Receba eventos em tempo real sem polling. A HUB Growth MKT usa SSE internamente para notificações instantâneas — você pode se conectar ao mesmo stream.

// Conectar ao stream de eventos const es = new EventSource('/api/events?token=SEU_TOKEN'); es.addEventListener('new_message', (e) => { const data = JSON.parse(e.data); console.log('Nova mensagem:', data); }); es.addEventListener('new_lead', (e) => { const data = JSON.parse(e.data); console.log('Novo lead:', data); });
1.000
req/min por IP
99.9%
Uptime garantido
REST
JSON · HTTPS · JWT

Pronto para integrar?

Acesse a plataforma, gere sua API key em Configurações → API e comece a integrar.