Seu sistema chama o Whatsplaid para validar conta, gerenciar contatos, tags, campos, conversas, carrinho, mensagens e atendimento humano.
API pública e documentação
Conecte sistemas próprios ao Whatsplaid com API, conectores e webhooks.
Use a API pública quando outro sistema precisar acionar o Whatsplaid. Use o conector externo quando o assistente precisar consultar produtos, pedidos ou dados do seu sistema durante a conversa. Use webhooks para receber eventos capturados no WhatsApp.
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.
O Whatsplaid envia eventos para uma URL sua. O evento disponível no painel é o lead capturado durante a conversa.
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
/modules
Lista módulos ativos, como leads, consultor de vendas, pós-venda, base de conhecimento e carrinho.
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
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
Contratos técnicos
A documentação cobre API, conector externo e webhooks.
O menu de integrações do ADMIN usa a mesma separação: API pública do Whatsplaid, conector externo para consultas em sistemas próprios e webhook de saída para leads capturados.
Valida conta, módulos, contatos, tags, campos personalizados, mensagens, conversas, carrinho e atendimento humano.
Seu sistema expõe endpoints como `/products/search` e `/orders/search` para o Whatsplaid consultar durante a conversa.
Retorno esperado com `products`, incluindo ID, nome, descrição, preço, disponibilidade, estoque, URL e imagem.
Retorno esperado com `orders`, incluindo número, status, pagamento, entrega, total, cliente, rastreio e itens.
O evento `LEAD_CAPTURE` envia dados do lead para a URL configurada. O endpoint deve responder HTTP 200 ou 204.
Use `Authorization: Bearer` nas chamadas. Tokens não devem ser expostos no frontend público.
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`.