Skip to main content

⚡ Quick Start

This guide will help you get Whinself running as quickly as possible.

Note: Whinself is an unofficial third-party tool and is not affiliated with WhatsApp or Meta Platforms, Inc.

Prerequisites​

  • Docker installed on your system
  • A WhatsApp account
  • Basic knowledge of terminal commands

Step 1: Run Whinself with Default Settings​

You can start Whinself immediately using only Docker. All configuration variables have default values, so you don't need to create any configuration file to get started:

docker run -d \
  --name whatsapp-bot \
  --restart unless-stopped \
  --pull always \
  -p 8888:8888 \
  inutil/whingo:latest

This will launch Whinself and expose the web dashboard on port 8888.

Step 2: Access the Dashboard​

Open a browser and navigate to:

http://localhost:8888

Step 3: Create an Account & Connect​

  1. Register a new account (or login if you already have one)
  2. Click "Subscribe" to activate your free trial (no payment info required)
  3. After subscribing (even for the free trial), a new category will appear in the web interface where you will see the QR code required to connect to the WhatsApp network.
  4. Scan the QR code with WhatsApp on your phone:
    • Open WhatsApp > Settings > Linked Devices > Link a Device
    • Scan the QR code from the Whinself dashboard

After scanning the QR code, you can go to the category called Service Status in the web interface. There you will see the status Connected to WhatsApp and the phone number you have enrolled with.

Step 4: Test Sending a Message​

curl -X POST http://localhost:8888/wspout \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Hello from Whinself!",
    "jid": "[email protected]"
  }'

Replace 1234567890 with the recipient's phone number (including country code).

If you want to customize Whinself's behavior (change ports, webhook URLs, device name, etc.), see the Advanced Configuration Guide for all available options.

Remember that you're responsible for ensuring your usage complies with WhatsApp's Terms of Service.