Skip to content
nodje edited this page Feb 22, 2019 · 12 revisions

Welcome to the mautrix-whatsapp wiki!

Quick Guide

For a more detailed list click the titles.

Bridge Setup

  1. Clone repo
  2. Compile with go build
  3. Copy example-config.yaml to config.yaml and update it to your liking.
  4. Run ./mautrix-whatsapp -g to generate the appservice registration.
  5. Add the path to the registration file to your synapse config.
  6. Run ./mautrix-whatsapp to start the bridge


  1. Start a chat with the bridge bot (@whatsappbot:<domainofyourmatrixerver> by default, see The bot should say "This room has been registered as your bridge management/status room."
  2. Type login.
  3. Scan the QR code. Using WhatsApp - in the Chats screen > Menu > WhatsApp Web.
  4. the bot should inform you of a successful login and the bridge should start creating portal rooms.


All commands are interpreted by the bridge bot, type them in a people chat with the bot

  1. start with login: you'll get a QR code you can scan to access your Whatsapp account. (you can use logout, restart the bridge if you're having problems like time out and running login again doesn't show the QR code anymore)
  2. the bot will propose to import contacts. This will import each of your contacts as an individual people invite which you'll have to accept one by one...
  3. sync will help you sync the name of your contact with the invites you've received.
  4. then you can open chats with contacts using pm <phone number> and create portals for specific groups chats with open <jid> (get list of jids with list) or import all group chats with sync --create


Matrix room:

In case you need to upload your logs somewhere, be aware that they contain your contacts' and your phone numbers. Strip them out with | sed -r 's/[0-9]{10,}/📞/g'

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.