Public API and documentation

Connect your own systems to Whatsplaid with API, connectors, and webhooks.

Use the public API when another system needs to trigger Whatsplaid. Use the external connector when the assistant needs to query products, orders, or data from your system during the conversation. Use webhooks to receive events captured on WhatsApp.

Open documentation View integrations

Base URL https://api.whatsplaid.com/v1

# autenticação
Authorization: Bearer {"{api_token}"}

# validar conta, módulos e integrações
GET /store

# enviar mensagem dentro da janela do WhatsApp
POST /messages/send
{
  "phone": "5511999999999",
  "text": "Seu atendimento foi atualizado."
}

Three contracts

Choose the correct direction of integration.

The Swagger documentation separates flows to avoid confusion between calls to Whatsplaid, queries made by the assistant, and events sent to your system.

01 Public API

Your system calls Whatsplaid to validate accounts, manage contacts, tags, fields, conversations, cart, messages, and human support.

02 Custom Data Connector

Whatsplaid calls your system to query products, orders, customers, or real-time availability during a conversation.

03 Outgoing Webhooks

Whatsplaid sends events to your URL. The event available on the dashboard is the lead captured during the conversation.

04 Documentation

The Swagger at `api.whatsplaid.com/docs/` contains schemas, examples, expected responses, and complete technical contracts.

Quick reference of main endpoints.

This overview summarizes the resources that appear in the official documentation. The final implementation should follow Swagger.

GET /store

Returns account data, connected e-commerce, and active modules.

Account

GET /modules

List of active modules, such as leads, sales consultant, post-sale, knowledge base, and cart.

Account

GET /ecommerce/products/search

Search products in connected native integrations, such as Nuvemshop, Wix, or Shopify.

Ecommerce

GET /ecommerce/orders/search

Search orders by number, email, or phone in connected native integrations.

Ecommerce

POST /contacts

Create or update contact using phone as the primary key.

Contacts

PATCH /contacts/{contactId}/custom-fields

Update custom fields for segmentation and operational context.

Fields

POST /messages/send

Send text message within the 24-hour WhatsApp support window.

Messaging

POST /handoffs

Request human support using the company's current setup.

Handoff

Technical contracts

Documentation covers API, external connector, and webhooks.

The ADMIN integrations menu uses the same separation: Whatsplaid public API, external connector for queries in proprietary systems, and outbound webhook for captured leads.

API pública

Validate account, modules, contacts, tags, custom fields, messages, conversations, cart, and human support.

External connector

Your system exposes endpoints like `/products/search` and `/orders/search` for Whatsplaid to query during the conversation.

Products

Expected return with `products`, including ID, name, description, price, availability, stock, URL, and image.

Orders

Expected return with `orders`, including number, status, payment, delivery, total, customer, tracking, and items.

Webhooks

The `LEAD_CAPTURE` event sends lead data to the configured URL. The endpoint should respond with HTTP 200 or 204.

Security

Use `Authorization: Bearer` in calls. Tokens should not be exposed in the public frontend.

Need to implement or validate an integration?

Open the interactive documentation to switch between `Whatsplaid Public API`, `Custom Data Connector Contract`, and `Outgoing Webhooks`.

Open Swagger