README

Dual-backend WhatsApp integration for Laravel — Meta Cloud API (pure PHP) + whatsapp-web.js sidecar (full personal-account access), with a polished Livewire admin UI and a single WhatsApp:: facade across both.

📖 Full documentation: kstmostofa.github.io/laravel-whatsapp

What you get

Layer	What it does
Cloud API client	Pure PHP. Templates, media, business profile, phone-number management, webhooks with HMAC verification.
Web sidecar (~300 LOC Node)	`whatsapp-web.js` wrapped in a thin HTTP service. Personal-number QR pairing, groups, status, free-form messages anytime, contact lookup.
Unified facade	`WhatsApp::messages()->sendTemplate(...)` for Cloud, `WhatsApp::web('main')->messages()->sendText(...)` for sidecar. `WhatsApp::send($to, $body)` auto-picks.
Livewire + Flux UI	Drop-in admin at `/whatsapp` — Dashboard, Sessions+QR, Compose, Conversations (chat-bubble UI with media, edit/delete, search, sound, ack ticks), Groups, Contacts, Webhooks log, Status. Works with Tailwind, Bootstrap, or no CSS framework at all.
Eloquent models	Opt-in `WaSession` / `WaMessage` / `WaContact` with separate-DB support via `WHATSAPP_DB_CONNECTION`.
Background bridge	`whatsapp:web:listen` daemon turns sidecar SSE events into Laravel events.
Health monitoring	`WhatsApp::status` page + `php artisan whatsapp:health [--json]` for CI/monitoring.

Quick install

composer require kstmostofa/laravel-whatsapp
php artisan vendor:publish --tag=laravel-whatsapp-config
php artisan vendor:publish --tag=laravel-whatsapp-migrations
php artisan migrate

For the Cloud API — set in .env:

WHATSAPP_ACCESS_TOKEN=EAAG...permanent-token
WHATSAPP_PHONE_NUMBER_ID=123456789012345
WHATSAPP_BUSINESS_ACCOUNT_ID=987654321098765
WHATSAPP_APP_SECRET=your-meta-app-secret
WHATSAPP_VERIFY_TOKEN=any-string-you-make-up

For the Web sidecar — pair your phone:

composer require livewire/livewire livewire/flux           # for the UI
php artisan whatsapp:sidecar:install                       # one-time, ~600 MB Chrome download
php artisan whatsapp:sidecar:start                         # boots in background
php artisan whatsapp:web:listen main &                     # SSE → Laravel events (run under Supervisor in prod)
# Open http://your-app.test/whatsapp/sessions and click "Start" → scan QR with your phone

Quick example

use Kstmostofa\LaravelWhatsApp\Facades\WhatsApp;
use Kstmostofa\LaravelWhatsApp\Jobs\SendMessage;

// One-line send — picks backend by recipient shape
WhatsApp::send('+9665XXXXXXXX', 'Hello from Laravel');           // → Cloud API
WhatsApp::send('966512345678@c.us', 'Hello via personal number'); // → Web sidecar

// Templated business message (Cloud API)
WhatsApp::messages()->sendTemplate('+9665XXXXXXXX', 'order_ready', 'en_US', [
    ['type' => 'body', 'parameters' => [['type' => 'text', 'text' => 'Munir']]],
]);

// Personal-number flow (Web sidecar — works for any chat your paired phone can see)
WhatsApp::web('main')->groups()->create('Project X', ['9665XXXXXXXX@c.us']);
WhatsApp::web('main')->messages()->sendImage('9665XXXXXXXX@c.us', ['url' => 'https://…/photo.jpg', 'caption' => 'Hi']);

// Or queue it
SendMessage::dispatch('+9665XXXXXXXX', 'Queued hello');

// Inbound — listen via Laravel events
Event::listen(\Kstmostofa\LaravelWhatsApp\Events\Web\MessageReceived::class, function ($event) {
    Log::info('Got message', ['from' => $event->from(), 'body' => $event->body()]);
});

When to use which backend

Feature	Cloud API	Web sidecar
Personal-number QR pairing	❌	✅
Send to / receive from groups	❌	✅
Status / Stories	❌	✅
Free-form messages anytime	❌ (templates outside 24h)	✅
Approved business templates	✅	❌
Official, no ban risk	✅	❌ (browser automation — ToS gray area)
Scalable to millions	✅	⚠️ session-bound
No extra runtime on host	✅	❌ (Node + Chromium)

Most apps use both — Cloud API for transactional/template sends at scale, Web sidecar for the features Cloud API doesn't expose.

UI install paths

The admin UI under /whatsapp works on whatever your app already uses:

Your app uses…	Set in `.env`	What you get
Tailwind v4 + Vite	`WHATSAPP_UI_CSS_MODE=vite` (default)	Smallest tree-shaken bundle. Add 3 `@source` lines to your `app.css`.
Anything else (Tailwind v3 / Bootstrap / plain CSS / nothing)	`WHATSAPP_UI_CSS_MODE=standalone`	Pre-compiled CSS shipped with the package, served from `/whatsapp/_assets/laravel-whatsapp.css` (~32 KB gz). No npm/Tailwind needed. Loads only on `/whatsapp/*` pages — your main app stays untouched.
No UI at all	skip `composer require livewire/flux`	Headless. Full access to `WhatsApp::` facade, Events, Jobs, webhook receiver, all CLI commands.

Full setup details + dark mode + screenshots → docs site.

Artisan commands

Command	Purpose
`whatsapp:sidecar:install`	Clone whatsapp-web.js, `npm ci`, download Chromium
`whatsapp:sidecar:start` / `:stop` / `:status`	Lifecycle of the Node process
`whatsapp:web:listen [session]`	Long-running: sidecar SSE → Laravel events
`whatsapp:health [--json]` [`--exit-code`]	Health probe — pipe into cron / monitoring

Production checklist

Set strong WHATSAPP_WEB_TOKEN (shared secret between PHP and sidecar)
Set WHATSAPP_APP_SECRET (HMAC for Cloud webhook signatures)
Wrap /whatsapp/* routes in your own auth middleware: config/laravel-whatsapp.php → ui.middleware
Run whatsapp:web:listen under Supervisor / systemd, one process per session
Optional: isolate WA data on a separate DB connection (WHATSAPP_DB_CONNECTION=whatsapp)
Optional: enable broadcasting (WHATSAPP_BROADCAST=true) + run Laravel Reverb for instant UI updates

Detailed deployment guide → docs/production.

Roadmap

Cloud API: messages / templates / media / business profile / phone numbers / webhooks
Web sidecar: full whatsapp-web.js surface (text, media, groups, contacts, status)
Livewire + Flux admin UI with dark mode, 3 CSS install paths
Eloquent persistence with per-package DB connection
Health page + CLI command + cached snapshots
Avatar + media proxy with server-side caching
Bubble actions: edit, delete-for-me, delete-for-everyone, "you deleted this message" placeholder
Bulk send job with rate limiting
Native broadcasting integration with Echo channel listeners
Template builder UI (currently API-only)

Status

46 tests passing, 133 assertions (testbench + mocked Guzzle + Livewire smoke tests)
Compatible with Laravel 11 / 12 / 13 — tests run green against L13.11 + PHPUnit 12 on PHP 8.5
PHP minimum: 8.2 on Laravel 11/12, 8.4 on Laravel 13 (Symfony 8 transitive)
Verified end-to-end in Laravel 12: QR pairing, inbound webhook → DB → UI bubble, edit, delete, sound, attachments, dark-mode toggle

License

MIT. See LICENSE.

Contributing

Issues + PRs welcome at github.com/kstmostofa/laravel-whatsapp. Please run vendor/bin/phpunit locally before submitting.

kstmostofa / laravel-whatsapp

Maintainers

Package info

Statistics

Security