Notification Management
You can configure and manage email notifications for various scenarios including app instance expiration, open API account expiration, license expiration, playbook errors, and more. These notifications can be customized to be sent to specific user groups, individual users, or external users, as specified in your settings.
Before you Start
Ensure you have permission to View Notification Management and Create/Update Notification Management to manage email notifications.
Steps
To configure notifications for your users, follow these steps:
Go to Admin Panel > Notification Management.
Click Edit.
Turn on the Select All toggle to Enable all Admin Notifications and subscribe to all notifications. This enables all the notifications for your Orchestrate instance. You can also enable notifications as required and modify the recipients for the notification. The following notifications are available:
Click Save.
You can turn on the toggle corresponding to License Expiry to send notifications to recipients when your Orchestrate tenant license is approaching its expiration date or if it has already expired. You can also configure the following options for this notification:
Add user groups, and users as notification recipients.
Add external recipient email addresses as a comma-separated list.
Configure the frequency to notify recipients. Select Notify before 7 days or customize frequency in days by selecting Custom.
Note
By default, users who belong to the Admin user group are added as recipients for license expiry notifications. You can modify the user group recipients as required.
You can turn on the toggle to send notifications to recipients when app instances are approaching their expiration date or if they have already expired. You can also configure the following options for this notification:
Select Creator to send notifications automatically to the creator of the app.
Add user groups, and users as notification recipients.
Add external recipient email addresses as a comma-separated list.
Use the preset frequency to notify recipients before 30 days, 15 days, 7 days, and 1 day of app instance expiry.
Configure custom notification frequency in days and send notifications as early as 60 days in advance.
Note
By default, users who belong to the Admin user group are added as recipients for app expiry notifications. You can modify the user group recipients as required.
You can turn on the toggle to send notifications to recipients when webhook configurations are approaching their expiration date or if they have already expired. You can also configure the following options for this notification:
Select Creator to send notifications automatically to the creator of the app.
Add user groups, and users as notification recipients.
Add external recipient email addresses as a comma-separated list.
Use the preset frequency to notify recipients before 30 days, 15 days, 7 days, and 1 day of webhook expiry.
Configure custom notification frequency in days and send notifications as early as 60 days in advance.
Note
By default, users who belong to the Admin user group are added as recipients for webhook expiry notifications. You can modify the user group recipients as required.
You can turn on the toggle to send notifications to recipients when open API credentials are approaching their expiration date or if they have already expired. You can also configure the following options for this notification:
Select Creator to send notifications automatically to the creator of the app.
Add user groups, and users as notification recipients.
Add external recipient email addresses as a comma-separated list.
Use the preset frequency to notify recipients before 30 days, 15 days, 7 days, and 1 day of open API expiry.
Configure custom notification frequency in days and send notifications as early as 60 days in advance.
Note
By default, users who belong to the Admin user group are added as recipients for license expiry notifications. You can modify the user group recipients as required.
You can turn on the toggle to send notifications to recipients when any open API token gets regenerated in the Admin Panel. You can also configure the following options for this notification:
Select Creator to send notifications to the creator of the open API when open APIs are regenerated.
Select Regenerator to send notifications to the user who regenerates the open API token.
Add user groups, and users as notification recipients.
Note
By default, users who belong to the Admin user group are added as recipients for open API regeneration notifications. You can modify the user group recipients as required.
You can turn on the toggle to send notifications to recipients when Cyware Agent faces connection errors and stops polling data. The notifications are sent every hour if the agent has failed to connect during the previous hour. You can also configure the following options for this notification:
Add user groups, and users as notification recipients.
Add external recipient email addresses as a comma-separated list.
Note
By default, users who belong to the Admin user group are added as recipients for agent connection error notifications. You can modify the user group recipients as required.
You can turn on the toggle to send notifications when any playbook run results in an Error status. You can also configure the following options for this notification:
Add user groups, and users as notification recipients. Followers of a playbook will always receive notifications about playbook errors regardless of this setting.
Note
By default, users who belong to the Admin user group are added as recipients of playbook error notifications. You can modify the user group recipients as required.
You can turn on the toggle to send notifications when any playbook run ends with System Error status. You can configure the following options for this notification:
Add user groups and users as notification recipients. Followers of a playbook will always receive notifications about playbook system errors regardless of this setting.
Note
By default, users who belong to the Admin user group are added as recipients of playbook system error notifications. You can modify the user group recipients as required.
You can turn on the toggle to send notifications when any playbook gets updated. You can configure the following options for this notification:
Add user groups, and users as notification recipients. Followers of a playbook will always receive notifications about playbook updates regardless of this setting.
Note
By default, users who belong to the Admin user group are added as recipients of playbook update notifications. You can modify the user group recipients as required.