Public API and documentation

Connect your systems to Whatsplaid with APIs, 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 the integration.

The Swagger documentation separates the 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 a URL you provide. The event shown in the dashboard is the lead captured during the conversation.

04 Documentation

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

Quick reference for the main endpoints.

This view summarizes the features that appear in the official documentation. The final implementation must follow the Swagger.

GET /store

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

Account

GET /modules

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

Account

GET /ecommerce/products/search

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

Ecommerce

GET /ecommerce/orders/search

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

Ecommerce

POST /contacts

Creates or updates a contact using the phone number as the primary key.

Contacts

PATCH /contacts/{contactId}/custom-fields

Updates custom fields for targeting and operational context.

Fields

POST /messages/send

Sends a text message within WhatsApp’s 24-hour messaging window.

Messaging

POST /handoffs

Request human support using the company’s current configuration.

Handoff

Technical contracts

The documentation covers API, external connector, and webhooks.

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

API pública

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

External connector

Your system exposes endpoints such as `/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 response with `orders`, including number, status, payment, shipping, total, customer, tracking and items.

Webhooks

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

Security

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

Do you 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