Public API Docs

Waappa WhatsApp API Documentation

Build WhatsApp automations with sessions, messages, groups, labels, contacts, LIDs, channels, events, webhooks, n8n nodes, MCP tools, and AI-agent workflows.

0. How to Use Waappa

Choose the integration path that matches your workflow before using the endpoint reference.

Create a Waappa Account

Start by creating your Waappa workspace. Open https://dev.waappa.com/signup, enter your email address, set a secure password, and click **Create Workspace**. This creates your Waappa login and takes you into the plan selection flow.

Waappa signup screen
Create your Waappa workspace with email and password.

On the checkout page, choose the plan that matches how many WhatsApp connections you need. If you only want to test the product first, use the available Starter trial. If you choose a paid plan, Waappa opens Razorpay so you can complete payment using UPI, card, or net banking.

Waappa checkout plan selection
Choose a plan or start the available trial before entering the dashboard.
After checkout or trial activation, Waappa redirects you to the dashboard. From there, you can create your first WhatsApp session/connection.

Create and Connect a WhatsApp Session

A session is one WhatsApp connection in Waappa. In the dashboard, click **Create connection** to add a new WhatsApp account. Give the connection a clear name, add the phone number for your reference, and submit the form.

Waappa dashboard before creating a connection
The dashboard shows your current connections and the create connection action.
Waappa create connection form
Enter a connection name and phone number, then create the connection.

After the connection appears on the dashboard, open **Manage connection**. Start the session so Waappa can prepare the QR code. When the QR code appears, open WhatsApp on your phone, go to **Linked Devices**, and scan the QR code.

Waappa dashboard with created connection
Open the connection details from the dashboard.
Waappa QR code for WhatsApp linked device
Scan the QR code from WhatsApp Linked Devices to connect the session.

If you cannot scan a QR code, switch the connection card to **Pairing code**, enter the WhatsApp number with its country code, and request a code. On the phone choose **Linked Devices -> Link with phone number instead** and type the code shown in the dashboard.

Once connected, use the test message area to confirm that the session can send messages. Enter a known WhatsApp number and send a simple test message before using the session in automation.

Waappa test message area
Send a test message from the connected session before production use.

To receive incoming messages and status updates, open the webhook settings for the session. Add your webhook URL, select the events your app needs, optionally add a webhook secret key, save the settings, and click **Test** to confirm delivery.

Waappa webhook settings
Configure webhook URL, events, optional secret key, and test the webhook.
Use a real reachable HTTPS webhook URL for production. If you add a webhook secret, configure your receiver to validate the same value from the **X-Api-Key** header.

REST API

Use REST API when you are building a backend, SaaS product, dashboard, internal tool, or custom automation service.

StepAction
1Create or choose a WhatsApp session.
2Start the session and scan the QR code.
3Call message, contact, group, label, or channel endpoints.
4Listen to webhook events for replies, delivery, and session status.

n8n Nodes

Use Waappa n8n nodes when you want WhatsApp automation without writing a custom backend. A typical workflow connects Waappa to CRM tools, Google Sheets, databases, AI agents, reminders, support routing, payment alerts, or monitoring flows.

First, open your n8n workspace and go to **Settings → Community Nodes**. Click **Install a community node**, enter n8n-nodes-waappa, accept the community node notice, and install it.

n8n community nodes settings
Open Community Nodes from n8n settings.
Install n8n-nodes-waappa community node
Install the `n8n-nodes-waappa` package.

After installation, create a workflow and search for **Waappa**. You can use Waappa action nodes to send messages, send media, check sessions, and build process automation from other n8n apps.

Waappa nodes available in n8n
Search Waappa inside n8n and choose the action or trigger you need.

Next, add Waappa credentials. Use the session name from your Waappa dashboard and the matching session API key. If you are building account-level automation for Business or Partner plans, use the master key only for supported admin operations.

Waappa n8n credentials screen
Add the Waappa Session ID and API key in n8n credentials.
Waappa n8n credentials tested successfully
Test the credentials before using them in production workflows.
Workflow typeHow to build it
Sales assistantUse a Waappa trigger for new WhatsApp messages, classify the lead with AI, update the CRM, and send a reply or handoff message.
Reminder workflowRead reminders from Google Sheets, database, or CRM, wait until the due time, then send WhatsApp text/media with safe delays.
WhatsApp CRMOn new inbound messages, create or update contacts, labels, lead stage, notes, and follow-up tasks.
Support routingDetect intent, route billing/support/sales messages to the right team, and notify internal groups.
Process automationTrigger invoices, order updates, appointment confirmations, documents, polls, or location sharing from business systems.
Monitoring alertsSend alerts to WhatsApp groups/channels when uptime, payment, server, or workflow checks fail.

For inbound automation, add the **Waappa Trigger** node and select the shared **Waappa API** credential. Open **Configure in Waappa**, select the session, choose the events and any ignore options, and save the configuration. Then activate the n8n workflow: n8n automatically registers its production webhook URL and generated secret with Waappa. You do not need to copy a URL or configure header authentication manually.

For production workflows, add delay nodes, rate limits, error branches, logging, and human approval for sensitive outgoing messages. This helps keep WhatsApp behavior natural and easier to monitor.

MCP Tools

Use MCP when an AI assistant needs controlled WhatsApp tools instead of full backend access.

StepAction
1Expose safe WhatsApp actions as tools.
2Limit tool permissions by session and action type.
3Require human approval for sensitive sends when needed.
4Log every assistant action for audit and debugging.

AI Agents

Use AI agents when WhatsApp messages should be classified, summarized, answered, routed, or escalated.

StepAction
1Receive inbound message events through webhooks.
2Classify intent and retrieve context from CRM or database.
3Generate or draft a reply with the AI agent.
4Send the response through Waappa or hand off to a human.

Webhooks

Use webhooks when your app needs to react to WhatsApp events in real time.

StepAction
1Set the webhook URL in session config.
2Select event types like message, message.ack, and session.status.
3Verify, store, and retry event processing safely.
4Trigger sales, support, CRM, monitoring, or AI workflows from payloads.

Groups & Channels

Use groups and channels for internal operations, community workflows, field teams, monitoring alerts, and broadcast-style updates where supported.

StepAction
1Use a group @g.us or channel @newsletter chatId.
2Send alerts, updates, documents, images, or videos.
3Track participants, group events, and message status.
4Use pacing, opt-in context, and safe automation practices.

Safe Automation Guidance

Use opt-in contacts, add delays between messages, avoid repetitive cold bulk sends, personalize content, and monitor reports or disconnections. Linked-device automation is flexible, but WhatsApp accounts can be blocked if used like spam.

Workflow Guides