Push
    • Dark
      Light
    • PDF

    Push

    • Dark
      Light
    • PDF

    Article summary

    Enable and configure push notifications for your workspace members using mobile devices.

    Workspaces on the community plan allow up to 10,000 free monthly push notifications. Get unlimited push notifications by subscribing to any of Rocket.Chat's premium plans.

    Configure push notifications

    To use push notifications, you must accept the Cloud Service Privacy Terms Agreement in the Administration > Workspace > Settings > Setup Wizard > Cloud Info settings.

    Next, to enable push notifications, go to Administration > Workspace > Settings > Push and update these settings:

    • Enable: Enable push notifications on your Rocket.Chat workspace.

    • Enable Gateway: Setting this to true allows you to use a custom push notification gateway. When disabled, it utilizes certificates and keys, allowing direct communication with Apple/Google instead of going through a gateway.

    • Rocket.Chat SaaS workspaces use the Rocket.Chat gateway by default and cannot be changed.

    • On self-managed workspaces, you can either use the default Rocket.Chat gateway or set up a custom notification gateway.

    • See the Configure Push Notifications section for more information.

    • Gateway: Specify the gateway to use. Multiple lines can be used to specify multiple gateways.

    • Production: Enable this for workspaces in production.

    With the configuration all done, click the Send a test push to my user button to send a test push to yourself. To successfully send a test push to your user, you need to be logged in to the workspace on your mobile device and then close or minimize the application.

    Certificate and keys

    If gateways are not enabled, the workspace relies on certificates and keys to configure push notifications. To configure push notification certifications and keys on Android and iOS, refer to the following guide:

    Privacy

    In the Privacy section, you can configure secured push notifications with the following settings:

    • Show Channel/Group/Username in Notification: Enable this option to make the channel name, group name, and username visible in notifications.

    • Show Message in Notification: Enabling this makes messages visible in notifications.

    • Hide message content from Apple and Google (and the Gateway, if enabled): Enable this option to hide the content of a message from Google/Apple or any other push gateway. This adds only the message ID to the notification data. The mobile client dynamically fetches the content from the server and updates the notification before displaying it. Failure to fetch a message using the provided message ID in the push data triggers a "You have a new message" notification. When this option is disabled, the message content is sent via push notification payload so the mobile app can immediately display the notification.

    If these privacy settings are disabled, the user receives a push notification without contextual information, as no such contextual information is sent to the push notification gateway in the first place. Then, the user can access the contextual information by opening the Rocket.Chat application. It is helpful in compliance-sensitive requirements like HIPAA to prevent sensitive information from being disclosed via push notification.

    After completing the push configuration, follow the Default User Preferences guide to set the default user preferences for notifications. Then, use the Channel Notifications guide to manage channel-based notifications.

    On some channels, notifications can stop if the number of users exceeds the set limit. You can set the limit in Administration > General > Notifications. See Notifications for more information.

    Cloud sync

    When you purchase a package for push notifications as a self-managed customer, go to Subscription and click Sync license updates to sync your workspace to Rocket.Chat Cloud and fetch any required updates.

    Check the count of notifications used per month

    To check the count of notifications used per month:

    • Go to cloud.rocket.chat.

    • Go to the Workspaces tab.

    • Select the workspace for which you want to check the count.

    • The push notifications block shows the number of used notifications per your current limit per month.


    Was this article helpful?

    What's Next