Skip to content

Relay Documentation

Relay is a self-hosted WhatsApp team inbox. Inbound messages land in a shared queue, agents claim and reply to them, and every customer's phone number stays masked from agents. One installation runs multiple isolated workspaces (one per team or brand).

This is the documentation index — start with Get Started, then dip into the feature guides as you need them.

Get Started

Page What it covers
Introduction What Relay is, the three account types, and how the pieces fit
Installation Install Relay with Docker Compose and complete first-time setup
Create a workspace Set up a workspace and its Admin account
Connect a number Link a WhatsApp number by scanning its QR
Best practices Getting the most out of Relay from day one

Using the Inbox

Page What it covers
Inbox overview The Queue and the conversation lifecycle
Replying to customers Accept, reply, resolve, and re-open a chat
Media Viewing inbound media and sending image replies
Templates Create and use quick-reply templates
Customer directory Import customers, link chats, statuses, number pinning
Topics & statuses Auto-tag conversations and label customers
Reports Filter, review, and export conversation history

Team & Privacy

Page What it covers
Agents & permissions Create agents and grant capabilities
Masking & privacy How Relay keeps customer numbers hidden

Reference & Operations

Page What it covers
Architecture How Relay is built (components, data flow, isolation)
Operations Backup, restore, health checks, logging, updating
Migration Import an existing team's data into a workspace
Limitations Known boundaries of the current release
Troubleshooting Common problems and their fixes
Changelog Release notes

Note: These guides use the English interface labels. Relay's interface also runs in Turkish (use the language toggle in the top bar); the buttons and menus are the same in the same places.