WhatsApp Gateway for Home Assistant (app)

About

WhatsApp Gateway is an app that runs a Baileys-based Node.js backend to connect Home Assistant with WhatsApp. It works as a bridge: the WhatsApp custom component connects to it over HTTP, and the app talks to WhatsApp Web. Poll votes in WhatsApp fire a message-received event of type poll update, which automations can react to. The app also includes a group moderation, defender and command engine. Its web interface opens from the sidebar and can be protected with a username and password. It needs Home Assistant OS, runs on aarch64 and amd64, uses the host network and can access the Supervisor API.

Automatic summary of the docs and configuration of FaserF/hassio-addons. Something wrong, or are you the maintainer and want your own text here? Get in touch

Supports

Opens in the sidebar Its own page opens inside Home Assistant.
Actively maintained Its author released or pushed a change in the last six months.

Setting it up

Add its app repository under Settings, Apps, then install and start it.

From the docs

Home Assistant WhatsApp Backend (Baileys/Node.js)

From the docs of FaserF/hassio-addons, MIT License. Shortened.

Permissions

Host networkUses the host's network directly instead of its own.
Supervisor APICan talk to the Supervisor, which manages apps and the system.

Network

8066/tcpInternal API port the integration connects to.

Configuration

Log LevelControls the verbosity of the logs.
Reset Session⚠️ DANGER: Enabling this will delete your WhatsApp session data on the next startup. The toggle will automatically disable itself after reset.
Mask Sensitive DataIf enabled, phone numbers in logs will be partially hidden (e.g. 4917*123). Useful when sharing logs.
Send Timeout (ms)Time in milliseconds to wait for a WhatsApp acknowledgement before timing out (Default: 25000).
Keep-Alive Interval (ms)How often (in ms) to check the connection to detect stale connections (Default: 30000).
Webhook EnabledIf enabled, incoming WhatsApp messages will be forwarded to the specified Webhook URL.
Webhook URLThe destination URL for forwarded messages (e.g. your Rocket.Chat app endpoint).
Webhook TokenA secret token sent with the webhook request (X-Webhook-Token header) to secure the communication.
UI AuthenticationEnables Basic Authentication for the Web UI (Port 8066). Recommeded if exposed to the internet.
UI PasswordThe password for the Web UI (Username is always 'admin').
Media FolderPath to a public folder (e.g. /media/whatsapp) to save received media. If set, automatic cleanup is DISABLED.
Mark OnlineWhether to mark the bot as online in WhatsApp.
Admin NotificationsIf enabled, the bot will send connection status and failure notifications to the listed admin numbers.
Admin Phone NumbersA comma-separated list of phone numbers (with country code, e.g. 491701234567) that should receive admin notifications.
Welcome MessageWhether to send a one-time welcome message to users who message the bot for the first time.