UiPath Orchestrator Guide

About Push Notifications

In our quest to offer you more mobility and supervising capabilities, Orchestrator Mobile App was enriched with push notifications. This feature was built specifically for your mobile app, based on Orchestrator Webhooks, and helps you better monitor your Robot fleet. Specifically, push notifications enable you to receive notifications every time a specific Orchestrator event takes place.

Important!

To use the push notifications feature, keep in mind that you should:

  • Use an on-premises Orchestrator account.
  • Have corresponding webhooks permissions - view, create, edit, and delete. If any of these permissions are missing, an alert is displayed.

The Notifications screen displays whether this feature is enabled or not, and lists the existing event types. The toggle next to each event type helps you enable or disable it.

Based on pre-existing Orchestrator Webhooks, you can choose to be notified on the following types of events:

To access the Notifications screen, select Settings menu > Notifications option.

Enabling Notifications

You have the possibility to enable or disable the push notifications functionality on any of your on-premises accounts if you have the corresponding webhooks permissions.

Follow these steps to enable push notifications on your device:

  1. In the Notifications screen, switch on Enable Notifications to activate push notifications. By default, the notifications are disabled.
  2. Click Allow within your mobile device's OS permission pop-up window. This pop-up only appears once, when you enable notifications on your mobile device for the first time.
  1. Select an event from the list by switching it on. Toggling an event on your mobile device creates a webhook on your local Orchestrator instance, that points to the Cloud Push Notification Server, a server that generates push notifications to be sent to your mobile app.

Whenever an event of the selected type occurs in Orchestrator, the corresponding webhook is triggered, and Cloud Push Notification Server receives the payload of the webhook event via a POST request. The server inspects incoming events for duplicates, discarding them. During predefined time slots, notifications for specific devices are batched together, based on the device's UUID. Multiple notifications for a single event type are grouped into one notification send request. The server sends push notifications to the Android mobile application by leveraging the Firebase Cloud Messaging service, and to the iOS mobile application by leveraging the Apple Push Notification service.

Some functionalities in the UiPath application may require use of third-party software, licensed under separate terms and conditions. In addition to UiPath Mobile Orchestrator License Terms, you must also comply with the third-party terms and conditions. The Firebase Cloud Messaging service may be used under the following Google APIs Terms of Service and Firebase Data Processing and Security Terms .

Note:

You must have app notifications enabled at device Settings level in order to receive the push notifications from Orchestrator.

The message sent by the server contains additional information, used by the Orchestrator Mobile App to determine which screen of the app should be opened when you tab on the notification. For example, tapping on any single or grouped Job Faulted push notification displays the Jobs screen, with the Faulted state filter applied, and already sorted by most recent records.

Keep in mind that, on the same mobile device, you may enable notifications for specific events on two or more different Orchestrator tenants, say Tenant A and Tenant B. In this case, if you are logged in to Tenant B while receiving a notification for Tenant A, clicking on the notification displays a pop-up window asking you if you wish to log out. If you select Yes, you are logged out of Tenant B, and the Login screen is displayed, allowing you to log in to Tenant A.

Viewing Your Mobile Device's UUID

A UUID (Universal Unique Identifier) is a 128-bit number used to uniquely identify some object or entity on the Internet. Your mobile device has such a UUID.

Here's how you can view the UUID within the Orchestrator Mobile App:

  1. In the Notifications screen, tap on the Show Device UUID text at the bottom of the screen. Your device's UUID is displayed in a pop-up window.
  2. Click Copy to keep the UUID to the clipboard, or click Cancel to close the pop-up window.

Disabling Notifications

In the Notifications screen, you can disable notifications one by one, switching off the desired event. As a result, the corresponding webhook is deleted.

You can also disable all notifications by switching off the Enable Notifications field. The existing webhooks are disabled, not deleted.


About Push Notifications


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.