Guides
What the gateway is, how to use it, and how to send and receive WhatsApp messages over HTTP.
This gateway turns a WhatsApp number into a REST API. You pair a phone once, then send and receive messages over HTTP — from your own code or from the dashboard.
This can get your number banned
The gateway talks to WhatsApp through an unofficial client — software that connects to WhatsApp without using its official Business API. WhatsApp prohibits bots and unofficial clients; automated use may violate its Terms and get the number banned. The built-in rate limiting and human-mimicry (read receipts, typing presence) reduce that risk but do not remove it. Use a number you can afford to lose, and use it at your own risk.
Start here
Read these top to bottom the first time through. Each page builds on the one before it.
Getting started
Sign in to your dashboard and find your organization.
Connect a number
Create a session and link a phone with a QR code or pairing code.
Send messages
Send text, media, grouped albums, polls, locations, and contact cards.
Receive events
Receive events over a realtime WebSocket or webhooks.
Event shape
The event envelope and a field-by-field catalog of every payload.
API keys
Create org-scoped keys for programmatic access.
Organizations
Share a connection by inviting collaborators into an org.
Import chat history
Load older chats and messages from a WhatsApp backup.
Attachment storage
Keep received photos, videos, and documents in your own bucket.
Sign in with WhatsApp
Let people log in to your app with their WhatsApp number.
The dashboard
Home, chats, contacts, and your account settings.
For exact request and response shapes, follow the links into the API reference.