GWhats
    API & Desenvolvedores

    API de atendimento WhatsApp, webhooks e MCP para desenvolvedores

    Integre, estenda e automatize o GWhats: API REST documentada em OpenAPI 3.1, webhooks com entrega durável, canal de API com conteúdo estruturado, servidor MCP nativo para Claude Code, Cursor e VS Code, Dashboard Apps e provisionamento multi-tenant.

    referência em ReDoc, Swagger-UI e JSON
    OpenAPI 3.1
    módulos expostos via MCP em 12 áreas
    100+
    grupos de eventos de webhook por módulo
    14

    O que é a camada de API & Desenvolvedores do GWhats

    A camada de API & Desenvolvedores permite ligar o GWhats a CRMs, ERPs, data warehouses, n8n e agentes de IA sem depender do time do produto. A API REST cobre contatos, conversas, mensagens, atribuição atômica de conversas e mensagens agendadas, documentada em OpenAPI 3.1 com ReDoc, Swagger-UI e JSON para Postman ou Insomnia. Webhooks assinados entregam eventos de cada módulo com histórico, retentativas e reenvio, e o canal de API transforma qualquer aplicativo em uma caixa de entrada de primeira classe.

    Para IA, o MCP nativo cria perfis de acesso com usuário de execução, seleção de módulos e modo somente leitura, prontos para Claude Code, Cursor, VS Code e Windsurf, enquanto os Robôs do Maestro consomem servidores MCP externos como Linear, Notion, Stripe e GitHub com aprovação humana. Dashboard Apps embutem seus apps na tela de conversa com contexto seguro, Custom Scripts injetam JS e CSS, e a API de Plataforma provisiona contas, usuários e bots em cenários multi-tenant.

    Tudo o que um integrador precisa, com governança

    REST, webhooks, MCP e SDKs com idempotência, segredos exibidos uma única vez e privilégio mínimo.

    API REST com referência OpenAPI 3.1

    Contatos, conversas, mensagens, atribuição atômica e agendamentos navegáveis em ReDoc, testáveis no Swagger-UI com Try it out e importáveis no Postman ou Insomnia.

    Tokens e webhooks duráveis

    Token de acesso por usuário ou conta e webhooks assinados. Cada entrega é registrada antes da fila, com retentativas com backoff, histórico pesquisável e reenvio em lote.

    Catálogo de eventos por módulo

    Catorze grupos de eventos: conversas, CRM, Catálogo e Commerce, pedidos, pagamentos, follow-ups, contratos, WhatsApp Hub, Ads, Flow Builder, Gestão de Equipe e mais.

    Canal de API com conteúdo estruturado

    Conecte seu app como caixa de entrada. Botões, CTAs de pagamento, cards de catálogo, eventos de agenda, reações e templates chegam estruturados e as respostas voltam simétricas.

    Bots de atendimento via webhook

    Agent bots atribuídos a qualquer inbox recebem eventos no outgoing_url e respondem pela API, com token e segredo rotacionáveis e verificação HMAC do contato.

    Servidor MCP nativo para atendimento

    Perfis de acesso com usuário de execução, 100+ módulos em 12 áreas, modo somente leitura e segredo próprio. Conecte Claude Code, Cursor, VS Code, Windsurf e MCP Inspector.

    Robôs com servidores MCP externos

    Linear, Notion, Stripe, GitHub, Sentry ou um ERP interno como ferramentas do Robô, com descoberta prévia, allowlist, aprovação humana (HITL) e segredos por referência.

    Dashboard Apps SDK V2 e Custom Scripts

    Apps HTTPS embutidos na conversa ou na barra lateral com contexto por capacidades e asserção de identidade de 2 minutos. JS e CSS por superfície com contexto e teardown.

    API de Plataforma multi-tenant

    Crie contas, usuários, vínculos com papel administrator ou agent, agent bots e links de login SSO a partir de um Platform App com lista de permissíveis.

    API REST

    Um contrato para mensagens, atribuição e agendamentos

    Endpoints sob /api/v1/accounts/{account_id} autenticados por api_access_token. Envie mensagens com content_type e content_attributes, troque responsável e equipe em uma única transação com PUT .../assignment e crie mensagens agendadas com prévia, X-Idempotency-Key e lock_version.

    • Atribuição atômica: assignee_type User ou AgentBot, idempotente, com 422 para IDs desconhecidos.
    • Mensagens agendadas one_time, sequence e recurring com prévia de blockers e ferramentas MCP geradas do OpenAPI.
    • source_id em mensagens para deduplicar reentregas; sem token universal, cada operação declara sua segurança.
    Webhooks

    Eventos de cada módulo com entrega que não se perde

    Assine eventos por conta em Configurações, Integrações, Webhooks. O segredo de assinatura aparece uma única vez, cada entrega é registrada antes de entrar na fila e erros de rede ou 5xx geram retentativas com backoff. O histórico permite buscar, filtrar e reenviar uma ou várias entregas.

    • Cabeçalho de entrega único como chave de idempotência, reutilizado em reenvios manuais.
    • Payload de Commerce com opt-in Incluir dados comerciais; nunca credenciais nem payload bruto do gateway.
    • Eventos como ctwa_conversation_started, wfm_break_breached, whatsapp_broadcast_completed e flow_session_completed.
    MCP nativo

    Conecte Claude Code, Cursor e VS Code ao atendimento

    Crie uma conexão MCP com usuário de execução, módulos escolhidos entre 100+ em 12 áreas e modo somente leitura. A lista efetiva de ferramentas é a interseção entre a seleção, o teto do Super Admin e as permissões do usuário: o assistente nunca faz mais que quem o executa.

    • Teto de 512 ferramentas na lista; search_tools e call_tool alcançam todas as demais.
    • Servidor MCP do Maestro expõe departamentos como ask_departamento para clientes externos.
    • Robôs consomem servidores MCP externos com allowlist, HITL, proteção SSRF e OAuth para Notion.
    Dashboard Apps

    Embuta seu app na tela de conversa com segurança

    Um app HTTPS roda em iframe nas superfícies conversation ou sidebar. Com o SDK V2 ele recebe conta, usuário, conversa e contato conforme as capacidades concedidas, assina eventos como conversation.changed e nunca vê tokens. Para escrever no seu backend, use getIdentityAssertion() e valide na introspection_url.

    • Capacidades como account:read, conversation:read, contact:phone e identity:assertion, concedidas por instalação.
    • Público por papel, equipe ou usuário; 8 categorias e 22 ícones de barra lateral; instalações geridas por REST e MCP.
    • Custom Scripts injetam JS e CSS no dashboard, no portal da Central de Ajuda e no widget, com ctx e teardown.

    Como funciona

    1. 1

      Gere credenciais de privilégio mínimo

      Token de acesso para REST, perfil MCP com módulos e somente leitura, ou Platform App para provisionamento.

    2. 2

      Consulte o contrato

      Navegue a referência OpenAPI 3.1, leia a segurança de cada operação e importe o JSON no Postman ou gere um SDK.

    3. 3

      Integre nas duas direções

      Chame a API e receba eventos por webhooks assinados ou pelo webhook do canal de API, deduplicando por chave de idempotência.

    4. 4

      Conecte IA e apps

      Aponte Claude Code, Cursor ou VS Code para a URL MCP, dê servidores externos aos Robôs com HITL e embuta Dashboard Apps.

    Perguntas frequentes

    Onde está a documentação da API?

    Na referência OpenAPI 3.1: ReDoc para leitura, Swagger-UI para testar chamadas com Try it out e o JSON para importar no Postman ou Insomnia ou gerar SDKs. Em instalações self-hosted o operador habilita a documentação com ENABLE_API_DOCS.

    Preciso programar para conectar o Claude ou uma IDE ao GWhats?

    Não. Em Configurações, MCP, você cria um perfil com usuário de execução, módulos e modo somente leitura, copia a URL e o segredo mcp_ e cola no Claude Code, Cursor, VS Code ou Windsurf com Authorization: Bearer. O cliente faz initialize, tools/list e tools/call.

    O assistente de IA pode fazer mais do que o usuário que o executa?

    Nunca. A lista efetiva de ferramentas é a interseção entre a seleção do perfil, o teto do Super Admin e as permissões do usuário de execução. O modo somente leitura remove tudo que cria, atualiza ou apaga.

    Como garanto que não processo um webhook duas vezes?

    Cada entrega traz um cabeçalho de identificação único, reutilizado em reenvios manuais. Use-o como chave de idempotência no receptor; retentativas por erro de rede ou 5xx e reenvios pelo histórico mantêm o mesmo identificador.

    Posso conectar meu próprio aplicativo como um canal de atendimento?

    Sim, com o canal de API: crie a inbox do tipo API, envie mensagens de entrada via REST e receba as respostas dos agentes no seu webhook_url, incluindo botões, pagamento, catálogo, agenda e reações. Você também devolve recibos de entrega e reações.

    Dá para provisionar contas e usuários automaticamente para meus clientes?

    Sim, pela API de Plataforma em /platform/api/v1 com o token de um Platform App. Ela cria contas, usuários, vínculos com papel administrator ou agent, agent bots e gera link de login SSO. O app só toca nos objetos da sua lista de permissíveis.
    Comece hoje mesmo

    Pronto para transformar
    seu atendimento?

    Junte-se a mais de 1.000 empresas que já usam o GWhats para atender, automatizar e vender mais pelo WhatsApp.

    7 dias grátis, sem cartão
    API Oficial da Meta
    Suporte em português
    Cancele quando quiser