ContextQMD
Back to Zulip

Desktop notifications

starlight_help/src/content/docs/desktop-notifications.mdx

12.05.8 KB
Original Source

import {Steps, TabItem, Tabs} from "@astrojs/starlight/components";

import FlattenedSteps from "../../components/FlattenedSteps.astro"; import NavigationSteps from "../../components/NavigationSteps.astro"; import ZulipNote from "../../components/ZulipNote.astro"; import ZulipTip from "../../components/ZulipTip.astro";

import PlayCircleIcon from "~icons/fa/play-circle";

Zulip can be configured to send visual and audible desktop notifications for DMs, mentions, and alerts, as well as channel messages and followed topics.

<FlattenedSteps> <NavigationSteps target="settings/notifications" />
  1. Toggle the checkboxes in the Desktop column of the Notification triggers table. </FlattenedSteps>

Notification sound

You can select the sound Zulip uses for audible desktop notifications. Choosing None disables all audible desktop notifications.

Change notification sound

<FlattenedSteps> <NavigationSteps target="settings/notifications" />
  1. Under Desktop message notifications, configure Notification sound. </FlattenedSteps>
<ZulipTip> To hear the selected sound, click the <PlayCircleIcon /> to the right of your selection. </ZulipTip>

Unread count badge

By default, Zulip displays a count of your unmuted unread messages on the desktop app sidebar and on the browser tab icon. You can configure the badge to only count direct messages and mentions, or to include messages in followed topics but not other channel messages.

Configure unread count badge

<FlattenedSteps> <NavigationSteps target="settings/notifications" />
  1. Under Desktop message notifications, configure Unread count badge. </FlattenedSteps>

Disable unread count badge

<FlattenedSteps> <NavigationSteps target="settings/notifications" />
  1. Under Desktop message notifications, select None from the Unread count badge dropdown. </FlattenedSteps>

Testing desktop notifications

<ZulipNote> This does not make an unread count badge appear. </ZulipNote> <Tabs> <TabItem label="Desktop/Web"> <FlattenedSteps> <NavigationSteps target="settings/notifications" /> 
  1. Under **Desktop message notifications**, click **Send a test notification**.
     If notifications are working, you will receive a test notification.
</FlattenedSteps>
</TabItem> </Tabs>

Troubleshooting desktop notifications

Desktop notifications are triggered when a message arrives, and Zulip is not in focus or the message is offscreen. You must have Zulip open in a browser tab or in the Zulip desktop app to receive desktop notifications.

Visual desktop notifications appear in the corner of your main monitor. Audible desktop notifications make a sound.

To receive notifications in the desktop app, make sure that Do Not Disturb mode is turned off.

Check notification settings for DMs or channels

If you have successfully received a test notification, but you aren't seeing desktop notifications for new messages, check your Zulip notification settings. Make sure you have enabled desktop notifications for DMs or for the channel you are testing. Messages in muted topics will not trigger notifications.

Check platform settings

The most common issue is that your browser or system settings are blocking notifications from Zulip. Before checking Zulip-specific settings, make sure that Do Not Disturb mode is not enabled on your computer.

<Tabs> <TabItem label="Chrome"> <Steps> 1. Click on the site information menu to the left of the URL for your Zulip organization. 1. Toggle **Notifications** and **Sound**. If you don't see those options, click on **Site settings**, and set **Notifications** and **Sound** to **Allow**. </Steps> 
Alternate instructions:

<Steps>
  1. Select the Chrome menu at the top right of the browser, and select
     **Settings**.
  1. Select **Privacy and security**, **Site Settings**, and then
     **Notifications**.
  1. Next to **Allowed to send notifications**, select **Add**.
  1. Paste the Zulip URL for your organization into the site field, and
     click **Add**.
</Steps>
</TabItem> <TabItem label="Firefox"> <Steps> 1. Select the Firefox menu at the top right of the browser, and select **Settings**. 1. On the left, select **Privacy & Security**. Scroll to the **Permissions** section and select the **Settings** button next to **Notifications**. 1. Find the URL for your Zulip organization, and adjust the **Status** selector to **Allow**. </Steps> </TabItem> <TabItem label="Desktop app"> **Windows** 
<Steps>
  1. Click the **Start** button and select **Settings**. Select **System**,
     and then **Notifications & actions**.
  1. Select **Zulip** from the list of apps.
  1. Configure the notification style that you would like Zulip to use.
</Steps>

**macOS**

<Steps>
  1. Open your Mac **System Preferences** and select **Notifications**.
  1. Select **Zulip** from the list of apps.
  1. Configure the notification style that you would like Zulip to use.
</Steps>
</TabItem> </Tabs>