Repository navigation
WhatsApp Web API v1.0.0
π WhatsApp Web API v1.0.0
A production-ready REST API for WhatsApp Web integration that enables programmatic sending of messages, QR code pairing, and webhook-based message reception.
β¨ Features
- π± QR Code Pairing: Generate QR codes to pair WhatsApp accounts
- π¬ Message Sending: Send text messages to any WhatsApp number via REST API
- πͺ Webhook Support: Receive incoming messages via HTTP webhooks
- ποΈ PostgreSQL Storage: Secure WhatsApp session persistence in PostgreSQL
- π Auto SSL Handling: Automatically configures PostgreSQL SSL mode
- π Complete Documentation: Full OpenAPI 3.0 / Swagger specification
- π Session Management: Automatic reconnection and session handling
- β‘ High Performance: Concurrent message handling and graceful shutdown
π§ Supported Platforms
- Linux (AMD64, ARM64, 386)
- macOS (Intel, Apple Silicon)
- Windows (64-bit, 32-bit)
π¦ Installation
Linux Deployment (Recommended)
Quick Start
- Set environment variables in file
- Run the binary for your platform
- Visit http://localhost:8080/health to verify
- Use http://localhost:8080/pair to pair with WhatsApp
For detailed installation and usage instructions, see the README.
π§ Configuration
- : PostgreSQL connection string (required)
- : Server port (default: 8080)
- : Webhook endpoint for incoming messages (optional)
π Documentation
- API Docs: http://localhost:8080/swagger
- OpenAPI Spec: http://localhost:8080/swagger.yaml
- Swagger UI: Use swagger.yaml file with https://editor.swagger.io/
β οΈ Requirements
- Go 1.24+ (for building from source)
- PostgreSQL 12+
- WhatsApp account with multi-device enabled
π Secure by default - All credentials stored securely in PostgreSQL
π Production ready - Includes systemd service setup and monitoring