openwa
Installation
SKILL.md
OpenWA
OpenWA is a self-hosted, open-source WhatsApp API Gateway (MIT, NestJS 11 / TypeScript / Node 22). It wraps whatsapp-web.js (Puppeteer + Chromium) behind a REST API on port 2785, ships a React dashboard on 2886, and supports multi-session WhatsApp automation with webhooks, Socket.IO real-time events, pluggable storage/cache/database, and a plugin hook system.
Product surface
| Component | Port | Role |
|---|---|---|
openwa-api (NestJS) |
2785 |
REST + WebSocket + webhook dispatcher |
dashboard (React 19 + Vite) |
2886 |
Session/API-key/webhook UI |
| Swagger UI | 2785 |
/api/docs |
| Traefik (optional) | 80, 8080 |
Reverse proxy + dashboard (profile with-proxy) |
| PostgreSQL (optional) | 5432 |
Profile postgres |
| Redis (optional) | 6379 |
Profile redis, gates BullMQ queue |
| MinIO (optional) | 9000, 9001 |
Profile minio (S3-compatible storage) |
Global API prefix is /api (src/main.ts:128 app.setGlobalPrefix('api')). All paths below are relative to <baseUrl>/api.