Your system calls Whatsplaid to query capabilities, manage contacts, track conversations, send messages, control the AI agent, and request human support.
Public API and documentation
Connect your systems to Whatsplaid with APIs, connectors, and webhooks.
Use the public API to integrate contacts, conversations, messages, human support and the AI agent. Use the external connector to query data from your system and webhooks to receive real-time events.
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.
Whatsplaid calls your system to query products, orders, customers, or real-time availability during a conversation.
Meet the external connector via APIWhatsplaid sends lead events, messages, delivery statuses, tickets and AI agent changes to a configured URL.
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
/capabilities
Shows which operations are actually available according to the account, plan, modules and integrations.
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
GET
/conversations
List of conversations started by contacts, with pagination, response window and AI agent status.
Conversations
GET
/conversations/{conversationId}/messages
Returns the paginated message history of a conversation.
Conversations
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
GET
/tickets
List of human support tickets with filters and pagination.
Tickets
POST
/tickets/{ticketId}/close
Closes the ticket, emits the corresponding event, and reactivates the conversation's AI agent.
Tickets
PATCH
/conversations/{conversationId}/ai-agent
Activate or pause the AI agent only for the specified conversation.
Conversations
GET
/ai-agent/prompt
Checks the editable prompt used as the AI agent's base instruction.
AI Agent
PATCH
/ai-agent/prompt
Update the editable prompt with revision control to prevent concurrent overwrites.
AI Agent
Technical contracts
The documentation covers API, external connector, and webhooks.
Contracts separate calls made to Whatsplaid, queries made by the agent in external systems, and events sent by Whatsplaid.
Checks account and capabilities, manages contacts, tags and custom fields, tracks conversations and sends messages within the allowed window.
View and update the editable prompt, and separately enable or pause the agent in each conversation.
Access chat history, pagination, WhatsApp reply window, and current AI agent state.
Your system may expose product, order, customer, and availability queries for the agent's use during the conversation.
Available events: `lead.created`, `message.received`, `message.sent`, `message.status.updated`, `ticket.created`, `ticket.closed`, and `conversation.ai_agent.updated`.
Webhooks use `delivery_id` for deduplication and retries for transient failures. Delivery is considered complete only after an HTTP 2xx response.
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`.