Documentação do BeeZap

BeeZap é uma central multi-cliente pra envio e recebimento de mensagens WhatsApp via API. Ele roda em cima do WAHA e oferece autenticação por chave, webhooks assinados via HMAC, gestão de sessões e estratégias anti-ban (rotação, warmup, cooldown).

Quem usa o quê

• Operador do hub — gerencia clientes, sessões WhatsApp e supervisiona o tráfego. Acessa em /admin.
• Admin do cliente — gerencia o próprio sistema-cliente: configura URL de webhook, regenera chave de API, convida operadores, vê suas conversas e logs. Acessa em /app.
• Operador do cliente — usa as conversas e visualiza dados do cliente. Sem poder de mudar configurações.
• Sistema cliente — não loga; integra via API com a chave do cliente: envia mensagens (POST /api/v1/messages), cria contatos e leads (POST /api/v1/contacts, podendo disparar automações por tag) e recebe eventos por webhook — incluindo CONTACT_CREATED e LEAD_CREATED.

Por onde começar

Recém-chegou? Vai pro guia Como começar pra acessar o painel, configurar webhook e gerar a primeira chave.

É dev? Pula direto pra API REST ou Webhooks.

Convenções

• Endpoints da API ficam em https://app.bee-zap.com/api/v1/... — a mesma base pra todos os clientes. Quem identifica o seu cliente é a API key no header Authorization: Bearer (não há URL/subdomínio por cliente).
• Datas usam formato ISO 8601 em UTC (ex: 2026-04-27T13:42:01.123Z).
• Toda mensagem que sai pelo BeeZap é registrada em MessageLog e visível no painel.
• Eventos do BeeZap — mensagens, mudança de sessão e criação de contato/lead — são entregues ao webhook do cliente assinados com HMAC SHA-256.