Send push notifications

🎉

beta

Push notifications for Retool Mobile are currently in beta. Email [email protected] to request access.

Retool Cloud and Self-hosted organizations can send push notifications to Retool Mobile users. Using the built-in Mobile Push Notifications resource, you write queries that send notifications to specified users from any Retool app or workflow.

Configuring push notifications is a two-part process:

• Add a query to mobile apps that subscribe users to push notifications and enables them on their device.
• Write queries in Retool apps and workflows to send push notifications to subscribed users.

Self-hosted deployments must also complete additional steps before using push notifications.

Subscribe users to push notifications

Each user must first subscribe to receive push notifications. This is done by adding a query to mobile apps that runs automatically whenever users launch the app.

1. Open a mobile app in the App editor and add a Resource query.
2. Select the Mobile Push Notifications resource, then select the Subscribe action.
3. Save the query.

When the query runs, it subscribes the user to push notifications. The Retool Mobile app also prompts the user to allow notifications on their device if the user has not yet done so. Once subscribed, the user can receive notifications sent directly to them or when sent to all users.

Send push notifications

The Mobile Push Notifications resource is available anywhere you can write queries in Retool. This enables you to send notifications from any Retool app or workflow. You can send notifications to specific users by including their email addresses or to all users. You specify the recipients and message, and then configure the query to run.

Queries for the Mobile Push Notifications resource only send when used in web apps and workflows. If you need to send push notifications from a mobile app, specify the Send action.

Send queries include a Topics field in which you add recipients. To send a push notification to individual users, use USER:[email protected]. To send a push notification to all users, use ALL_USERS. You add each recipient as a separate topic.

Configure push notifications for Self-hosted deployments

🚧

Requires Self-hosted Retool v2.116 or later.

If you have a Self-hosted deployment, you must obtain a push notification API token from Retool and then configure additional environment variables.

First, contact our support team to request a token. Once you receive it, configure the following environment variables:

MOBILE_PUSH_NOTIFIER_HOST=https://spb8yl7d3j.execute-api.us-west-2.amazonaws.com
MOBILE_PUSH_NOTIFIER_API_TOKEN=(Your push notification API token)