The dashboard

The dashboard is the web app where you link WhatsApp numbers, create API keys and webhooks, and read and reply to chats. Everything you see belongs to your active organization, the shared workspace that owns your numbers, keys, and webhooks. Pick the active organization with the organization switcher in the header. See organizations.

Pages in the sidebar

The Workspace section of the sidebar follows the order you usually set things up in.

Documentation at the bottom of the sidebar opens these guides. Platform administrators also see an Admin section. Your gateway operator's documentation describes those pages.

Home

Home shows how your numbers are being used and what is left to set up.

The activity section has a time range selector: Last 24 hours, Last 7 days, Last 14 days, or Last 30 days. Times are in your local time zone. It shows:

• Sessions: how many numbers are connected, connecting, need attention, or stopped
• Messages received: incoming messages on your numbers
• Messages sent: messages sent from the API, the dashboard, and the phone
• Active chats: chats with at least one message in the range
• Send failures: sends that gave up after retrying
• Webhook deliveries: events posted to your webhook URLs, including failed deliveries

The Get started checklist has 4 steps. Each step is ticked off on its own once the dashboard sees it done:

1. Connect a WhatsApp number.
2. Create an API key.
3. Send your first message. The step shows a ready-to-run request with your first connected session filled in.
4. Receive messages with a webhook.

Use Hide to collapse the checklist and Show to open it again. It collapses on its own when every step is done. The close button removes it from Home for the current organization in this browser.

Inside a session

Open a session from the Sessions page. The bar at the top of the page shows the session's name and status, with a link back to All sessions. Under it are 3 tabs: Overview, Chats, and Contacts. The tabs look the same on a computer and on a phone.

A session without a name shows its phone number instead, or Untitled session before a phone is linked. To find its ID, open Overview and copy Session ID.

Overview

Before the phone is linked, the overview shows only the Link your phone card. See connect a number.

After the phone is linked, the overview shows:

• Next steps: shortcuts to create an API key, send a test message, add a webhook, and open chats. Hide it with the close button.
• Send a test message: a ready-to-run request with this session's ID filled in. Enter a phone number in Send to; it defaults to your own number, so the message arrives in "Message yourself".
• Attachment storage: where this session stores the media it receives. See link a session.
• Import chat history: load older messages from a WhatsApp backup. See import chat history.
• Details: the phone number, WhatsApp ID (JID), LID, send rate limit, auto-read and typing settings, and when the session last connected.

The Start or Stop button in the page header starts or stops the session. The … menu has Restart, Log out (only when a number is linked), and Delete session…. When a number is still linked, the delete item reads Log out and delete…. See log out or delete a session.

Chats

Chats is a two-pane messenger. The left pane lists the session's chats with a search box. Pinned, muted, archived, and unread chats are marked. The right pane shows the selected conversation and updates live as messages arrive.

You can reply from the dashboard:

• Type in the message box at the bottom. Press Enter to send and Shift + Enter for a new line. WhatsApp formatting such as *bold* and _italic_ works.
• Use the paperclip menu to send a Poll, a Location, or a Contact card.
• Open a message's actions menu to Reply, Copy text, or Copy message ID.
• Vote on a poll by tapping one of its options.
• Start a conversation with New chat. Pick a contact the session has seen, or type a phone number with its country code. The dashboard checks that the number is on WhatsApp before it opens the chat.

A message you send appears straight away. If the send fails, the message is marked Not sent and your text goes back into the message box. In a group where only admins can post, or in a channel, the box warns you that the send fails unless this number is an admin or owns the channel. When the session is not connected, the box is replaced by a prompt to start the session or to link the phone again.

Edited messages show an edited label. A message deleted for everyone shows "This message was deleted" and hides its content. An attachment shows a Download button once it is stored. See attachment storage.

The chat's options menu copies the chat ID (the JID you send to) or the phone number, and opens the person's contact page.

To send from your own code instead, see send messages.

Contacts

Contacts lists the people this session has seen in direct chats or groups. Search by name or phone number. Use the Seen in filter to show All, Direct chats, or Groups.

Open a contact to see:

• their phone number and LID, each with a copy button
• Shared groups: the groups you and they are both in, with the name they use in each group, their role, and when they were last seen
• Open chat (or Message if you have not chatted yet)
• a … menu with Block… and Unblock

Use Contacts to find a recipient's JID, the WhatsApp address you send a message to.

Your account

Open Account from the menu under your name at the bottom of the sidebar. These settings belong to you, not to an organization, so they apply in every organization you are a member of.

Profile

Change your display Name and select Save. Your Email is the address you sign in with. Ask your gateway operator if it needs to change.

Password

Enter your Current password, then the New password twice, and select Change password. Tick Sign out of other devices if you think someone else knows your password. The browser you are using stays signed in.

You cannot reset a forgotten password by email. Ask your gateway operator to set a new password for you, then change it here after you sign in.

Two-factor authentication

Two-factor authentication asks for a 6-digit code from an authenticator app after your password. A leaked password alone is then not enough to sign in. You need an authenticator app such as Google Authenticator, 1Password, Authy, or Microsoft Authenticator.

To turn it on:

1. Select Set up two-factor and confirm your password.
2. Scan the QR code with your authenticator app. If you cannot scan it, select Can't scan it? Enter a setup key instead and type the key into the app as a time-based code.
3. Enter the 6-digit code the app shows.
4. Save the backup codes. Copy them or select Download as .txt. Each code works once and lets you sign in if you lose the authenticator app.

When two-factor authentication is on, the sign-in page asks for a code after your password. Use the Authenticator app tab for a code from the app, or the Backup code tab for one of your backup codes. Tick Don't ask again on this device for 30 days to skip the code on that browser.

Select New backup codes to replace your backup codes. The old codes stop working. Select Turn off to switch two-factor authentication off. Both ask for your password.