Waxum

WhatsApp API with a test console; unofficial, numbers can be banned.

Replaces WhatsApp Business API Some setup Free app

No server needed to start: Cloudgate can provide one. What happens when you click Deploy

Waxum
The Waxum console overview, with a fleet status card reading 0 of 1 sessions on the line, 1 offline and 0 events per minute, cards for active webhooks and open circuits both at 0, a sessions table listing one offline session named design-preview with an Open button and a New session button, and an empty live events panel
The console overview: each WhatsApp number, its status and live events. Waxum · MIT
The Waxum session page for design-preview, marked offline, with a pair session panel offering a QR code to scan from WhatsApp's Linked devices or a phone number field with a Request pair code button, tabs for Send, Chat, Contacts, Groups, Calls, Blocking, Webhooks, Scheduled, Media and more, and the Contacts tab open with calls to list contacts, check a number is on WhatsApp and get a profile picture, a Send request button and a response panel
One number's page: link it by QR or pair code and try each call. Waxum · MIT

What is Waxum?

Self-hosted Waxum: an open-source WhatsApp API to send and receive messages from your apps by webhook. Unofficial; WhatsApp can ban numbers.

Waxum is a free, self-hosted WhatsApp API that lets your own apps send and receive WhatsApp messages, as a low-cost alternative to the WhatsApp Business API. By default it is unofficial: it links to your number as a WhatsApp Web device, and WhatsApp can ban a number used this way.

You scan a QR code once with WhatsApp on your phone, and from then on your website or app can send texts, pictures, documents and voice notes through a simple web API, and receive replies through webhooks. A dental practice, for example, could have its booking system send appointment reminders the day before and pass patients' replies back to the front desk.

Waxum is built for developers. It is a single small program that talks to WhatsApp without a web browser, with a console to try every call first. Unlike WAHA and WuzAPI, it can also schedule messages, place voice calls and switch a number to Meta's official Cloud API, so the same code keeps working if you move to the official route. Test with a spare number, and message only people who expect to hear from you.

Cloudgate installs Waxum on a server Cloudgate provides or one you connect and gives it a secure web address, protected by an admin token.

What you can do with Waxum

  • Send any kind of message Send texts, pictures, videos, voice notes, documents, stickers, locations, contact cards and polls, and react to, edit, forward or delete messages.
  • Get incoming messages by webhook Every new message and event is posted to your own web address, signed so your app can check it came from your server, and failed deliveries can be sent again.
  • Link a number by QR or pair code Connect an ordinary number from WhatsApp's Linked devices screen, by scanning Waxum's QR code or typing the 8-character pair code it shows.
  • Several numbers on one server Run a separate session for each WhatsApp number and see at a glance which ones are online.
  • Try every call in the console The web console has a playground for each number where you can send messages, look up contacts, manage groups and check webhooks before writing any code.
  • Scheduled messages and voice calls Set a time for a message to go out, or ring a contact and play a recording or a text read aloud by a computer voice.
  • Official Cloud API too A session can use Meta's official WhatsApp Cloud API instead of a linked phone, with the same calls and webhooks, if you have a Meta business account.

Replaces WhatsApp Business API

Waxum does the same job as WhatsApp Business API. Here is what changes when you switch.

What you gain
  • No fee per message or conversation in linked-phone mode, and no templates to get approved
  • Uses the WhatsApp number you already have, linked in a minute
  • Messages and media stay on your server
  • Open source under the MIT licence, with no paid edition
What is different
  • The default mode is unofficial, and WhatsApp can ban a number used this way
  • No green tick or Meta support unless you use the official Cloud API mode, where Meta's prices apply
  • A WhatsApp update can break it until Waxum catches up
  • It is built for developers, so you need some code to use it

What happens when you click Deploy?

You do not need a server or any technical knowledge. Four steps, and Waxum is running at its own web address.

  1. Step 1 Click Deploy and create your account

    Deploy takes you to Cloudgate. Create an account, or log in if you have one. Waxum itself is free.

  2. Step 2 Choose a server

    No server? Get one from Cloudgate: pick a size and a country, and Cloudgate gets it ready. Already have one? Connect it instead.

  3. Step 3 Cloudgate sets up Waxum

    It prepares the server, makes the passwords the app needs and starts it. There is nothing to install and nothing to write down.

  4. Step 4 Open your app and sign in

    Your app gets a free web address to start, without https. Add your own domain, like app.yourshop.com, and Cloudgate secures it with https for you.

Run Cloudgate yourself? Deploy from your own console

In your Cloudgate console, open Templates and choose Waxum.

Questions

Is Waxum an official WhatsApp API?

No. Waxum is independent software, not made by or connected to WhatsApp or Meta. By default it links to your number as a linked device using the unofficial WhatsApp Web protocol. A session can instead use Meta's official WhatsApp Cloud API, which needs a Meta business account and is billed by Meta.

Can WhatsApp ban my number if I use Waxum?

Yes. WhatsApp does not allow unofficial clients, and Waxum's own documentation says WhatsApp rate-limits and bans aggressive senders. Never send spam or bulk messages, test with a spare number, and use the official Cloud API for a number you cannot risk losing.

Is Waxum free?

Yes. Waxum is free and open source under the MIT licence, with no paid edition or locked features. You pay only for your server, plus Meta's message charges if you use the official Cloud API mode.

Is Waxum a good alternative to the WhatsApp Business API?

Yes for internal tools, notifications to people who expect them and testing, where no per-message fee and a quick QR setup matter most. For customer messaging at scale, approved templates or a verified business name, use the official API, which Waxum can also connect to.

How do I connect my WhatsApp number to Waxum?

Open the Waxum console and sign in with the admin token Cloudgate shows. Add a new session, open it and press Connect, then scan the QR code with WhatsApp on your phone, under Settings, Linked devices, or request a pair code and type it in instead.

What is the difference between Waxum, WAHA and WuzAPI?

All three link a WhatsApp number unofficially and offer a web API with webhooks. Waxum and WuzAPI are single small programs that talk to WhatsApp without a web browser; Waxum adds a test console, scheduled messages, voice calls and an official Cloud API mode. WAHA has ready-made connections to n8n and Chatwoot, and WuzAPI is the simplest of the three.

What server size does Waxum need?

A small server is enough for one or a few numbers. Waxum is a single program that does not run a copy of WhatsApp Web in a browser, so each extra number adds little load.

Do I need technical skills to run Waxum?

No. Click Deploy, create your Cloudgate account and choose a server, and Cloudgate sets up Waxum and gives it a web address. You use it in your browser like any other online tool.

Do I need my own server for Waxum?

No. When you deploy Waxum, hosted Cloudgate can provide a server. If you already rent one, you can connect it instead.

Can I move my data from WhatsApp Business API to Waxum?

Most people export from WhatsApp Business API and import into Waxum. The official guides at waxum.imtaqin.id walk through it.

WaxumFree app
Deploy Waxum