WaPulse
Sign InStart Now

API Documentation

Complete guide to integrating WhatsApp messaging into your applications with our powerful REST API

API Features

Everything you need to build powerful WhatsApp integrations

REST API

Simple HTTP requests with JSON responses

Real-time Webhooks

Instant notifications for incoming messages

Secure Authentication

Token-based security for all requests

44 Endpoints

Complete API coverage for all features

API Endpoints Overview

5
Connection & Status
9
Messaging
20
Group Management
9
Info & Users

Getting Started

1

Get Your Token

Sign up and get your unique API token from the console

2

Create Instance

Set up a WhatsApp instance and pair your phone

3

Start Sending

Make your first API call and send messages

Getting Started
1

Get Your Token

Required

Go to Developers → Product ID & Token to get your unique userid token

2

Create an Instance

Setup

Use the addInstance endpoint to create a new WhatsApp instance

3

Get QR Code & Connect

Connect

Retrieve the QR code and scan it with WhatsApp mobile app

4

Start Your Instance

Activate

Start the instance to begin sending and receiving messages

Webhooks & Real-time Events

Setting Up Webhooks

Configure your webhook URL to receive real-time notifications for incoming messages, message status updates, and other events.

1.Go to the Webhooks page in the sidebar
2.Add your webhook URL (e.g., https://yourapp.com/webhook)
3.Configure event filters and phone number filters
4.Save and test your webhook configuration
Event Types
Incoming Messagesmessage_received
Message Statusmessage_status
Read Statusread_status
Instance Statusinstance_status
Filtering Options
Phone NumbersFilter by specific numbers
User/GroupIndividual or group messages
Read Status EventsInclude/exclude read receipts
Own MessagesInclude messages you send
Pro Tip

Use ngrok for local development: ngrok http 3000to create a public URL for testing webhooks locally.

API Reference
Response Examples

Base URL

https://api.wapulse.com

All API endpoints should be prefixed with this base URL

Authentication

All API requests require authentication using your Retailer ID and Secret. These are included in the URL path for each request:

POST https://api.wapulse.com/api/YOUR_RETAILER_ID/YOUR_SECRET/YOUR_INSTANCE_ID/COMMAND

Important: Never expose your Retailer ID and Secret in client-side code. Always make API calls from your backend server.