MultiWA Documentation
Welcome to the MultiWA documentation. MultiWA is a free, open-source WhatsApp API Gateway designed for developers who need full control over their messaging infrastructure.
📚 Documentation Index
Getting Started
- 01 - Project Overview - Vision, mission, and architecture
- 02 - Requirements - System requirements and dependencies
- 03 - Quick Start - Get up and running in 5 minutes
Architecture
- 04 - System Architecture - Technical design and components
- 05 - Database Design - Prisma schema and relationships
- 06 - Engine Abstraction - Baileys and WhatsApp-Web.js adapters
API Reference
- 07 - API Specification - REST API endpoints
- 08 - WebSocket API - Real-time events
- 09 - Webhook Events - Event payloads
Features
- 10 - Messaging - Sending messages, media, polls
- 11 - Groups - Group management API
- 12 - Automation - Auto-reply and flow builder
SDKs & Integrations
- 13 - Python SDK - Installation and usage
- 14 - PHP SDK - Installation and usage
- 15 - n8n Integration - Workflow automation
Deployment
- 16 - Docker Deployment - Production setup
- 17 - Development Guide - Contributing to MultiWA
Operations
- 18 - Configuration Reference - Environment variables
- 19 - Database Backup - Backup & restore guide
Guides & Examples
- 20 - Examples - End-to-end usage examples
Releasing
- 21 - Releasing & Distribution - Release flow, publishing SDKs and Docker images
- 22 - Air-gapped Deploy - Deploying to a host with no registry access: build, verify, transfer, gate, roll back
🚀 Quick Links
- GitHub: github.com/ribato22/MultiWA
- Docker image (API): hub.docker.com/r/ribato/multiwa-api
- TypeScript SDK source:
packages/sdk - Python SDK source:
packages/sdk-python - PHP SDK source:
packages/sdk-php
The TypeScript SDK is live on npm (
npm install @multiwa/sdk), the Python SDK on PyPI (pip install multiwa), and the n8n community node on npm (npm install n8n-nodes-multiwa). The PHP SDK (multiwa/sdk) still ships as an in-repo package; its Packagist entry is tracked as a release follow-up — until then, install it from this repository or via the package's local path.
🆘 Support
Made with ❤️ by the MultiWA Community