Skip to main content

WhatsApp

Two modes are supported: Native (recommended) and Bridge.

Native mode connects directly to WhatsApp using the WhatsApp Web protocol. No third-party bridge needed.

1. Build with native WhatsApp support

make build-whatsapp-native

Or download a *-whatsapp binary from the releases page.

2. Configure

{
"channels": {
"whatsapp": {
"enabled": true,
"use_native": true,
"allow_from": []
}
}
}

3. Scan the QR code

On first run, a QR code will be displayed in the terminal. Scan it with WhatsApp:

WhatsApp → Settings → Linked Devices → Link a Device

The session is stored in <workspace>/whatsapp/ and persists across restarts.

Bridge Mode

Connect to an external WebSocket bridge:

{
"channels": {
"whatsapp": {
"enabled": true,
"bridge_url": "ws://localhost:3001"
}
}
}

Configuration Reference

FieldTypeDescription
enabledboolEnable/disable WhatsApp
use_nativeboolUse native WhatsApp Web protocol
bridge_urlstringWebSocket bridge URL (bridge mode)
allow_from[]stringWhitelist of phone numbers (empty = all)