Seu sistema chama o Whatsplaid para consultar capacidades, gerenciar contatos, acompanhar conversas, enviar mensagens, controlar o agente de IA e solicitar atendimento humano.
API pública e documentação
Conecte sistemas próprios ao Whatsplaid com API, conectores e webhooks.
Use a API pública para integrar contatos, conversas, mensagens, atendimento humano e o agente de IA. Use o conector externo para consultar dados do seu sistema e webhooks para receber eventos em tempo real.
Três contratos
Escolha o sentido correto da integração.
A documentação Swagger separa os fluxos para evitar confusão entre chamadas para o Whatsplaid, consultas feitas pelo assistente e eventos enviados para o seu sistema.
O Whatsplaid chama o seu sistema para consultar produtos, pedidos, clientes ou disponibilidade em tempo real durante uma conversa.
Conheça o conector externo via APIO Whatsplaid envia eventos de leads, mensagens, estados de entrega, chamados e mudanças no agente de IA para uma URL configurada.
O Swagger em `api.whatsplaid.com/docs/` contém os schemas, exemplos, respostas esperadas e contratos técnicos completos.
Referência rápida dos principais endpoints.
Esta visão resume os recursos que aparecem na documentação oficial. A implementação final deve seguir o Swagger.
GET
/store
Retorna dados da conta, e-commerce conectado e módulos ativos.
Account
GET
/capabilities
Informa quais operações estão realmente disponíveis conforme conta, plano, módulos e integrações.
Account
GET
/ecommerce/products/search
Busca produtos nas integrações nativas conectadas, como Nuvemshop, Wix ou Shopify.
Ecommerce
GET
/ecommerce/orders/search
Busca pedidos por número, e-mail ou telefone nas integrações nativas conectadas.
Ecommerce
POST
/contacts
Cria ou atualiza contato usando telefone como chave principal.
Contacts
GET
/conversations
Lista conversas iniciadas pelos contatos, com paginação, janela de resposta e estado do agente de IA.
Conversations
GET
/conversations/{conversationId}/messages
Retorna o histórico paginado de mensagens de uma conversa.
Conversations
PATCH
/contacts/{contactId}/custom-fields
Atualiza campos personalizados para segmentação e contexto operacional.
Fields
POST
/messages/send
Envia mensagem de texto dentro da janela de atendimento de 24 horas do WhatsApp.
Messaging
POST
/handoffs
Solicita atendimento humano usando a configuração atual da empresa.
Handoff
GET
/tickets
Lista chamados de atendimento humano com filtros e paginação.
Tickets
POST
/tickets/{ticketId}/close
Encerra o chamado, emite o evento correspondente e reativa o agente de IA da conversa.
Tickets
PATCH
/conversations/{conversationId}/ai-agent
Ativa ou pausa o agente de IA somente para a conversa informada.
Conversations
GET
/ai-agent/prompt
Consulta o prompt editável usado como instrução-base do agente de IA.
AI Agent
PATCH
/ai-agent/prompt
Atualiza o prompt editável com controle de revisão para evitar sobrescritas concorrentes.
AI Agent
Contratos técnicos
A documentação cobre API, conector externo e webhooks.
Os contratos separam chamadas feitas ao Whatsplaid, consultas feitas pelo agente em sistemas externos e eventos enviados pelo Whatsplaid.
Consulta conta e capacidades, gerencia contatos, tags e campos personalizados, acompanha conversas e envia mensagens dentro da janela permitida.
Consulta e atualiza o prompt editável, além de ativar ou pausar o agente separadamente em cada conversa.
Acessa histórico, paginação, janela de resposta do WhatsApp e estado atual do agente de IA.
Seu sistema pode expor consultas de produtos, pedidos, clientes e disponibilidade para uso do agente durante a conversa.
Eventos disponíveis: `lead.created`, `message.received`, `message.sent`, `message.status.updated`, `ticket.created`, `ticket.closed` e `conversation.ai_agent.updated`.
Webhooks usam `delivery_id` para deduplicação e novas tentativas para falhas temporárias. A entrega é concluída somente após resposta HTTP 2xx.
Precisa implementar ou validar uma integração?
Abra a documentação interativa para alternar entre `Whatsplaid Public API`, `Custom Data Connector Contract` e `Outgoing Webhooks`.