Notifications v1.3.4
With Hybrid Manager (HM), you can customize the types of notifications you want to receive. There are two types of notification channels:
User notifications — You can receive notifications via email, in-app inbox, or both. These notifications are for all users who have enabled them if their role allows it.
System notifications — You can receive notifications via email (mail group), webhook, pager duty, or any combination. These notifications are triggered once per event, primarily to automate tasks in your organization.
Your role in HM determines your access to notification preferences. The following types of notifications are available:
- Account — For user notification channels. You can be notified that:
- A new project role was assigned to you.
- A project role was unassigned from you.
- Your personal access key is about to expire.
- Global — For user and system notification channels (visible only to the organization owner). You can be notified that:
- A new project was created.
- The machine access key is about to expire.
- Projects — For user and system notification channels. You can be notified that:
- The active cluster was paused.
- A paused cluster was reactivated.
Configuring notifications
Project owners/editors and organization owners/admins can enable or disable notifications for the events they can see. They can receive notifications in the in-app inbox, by email, or both.
Notification settings made by a user apply only to that user. If an email notification is enabled, the email is sent to the email address associated with the user's login.
System notification channels can be configured at the global level by the organization owner or at the project level by the project owner. By default, each organization's project inherits the global-level system notifications channel. However, you can enable/disable or reconfigure the system notifications channel at the project level to override the default settings.
Configure notifications at the global level
Only the organization owner can set the global notifications.
For webhook:
From your profile menu, select Settings.
Select the Notifications tab.
Select Webhook and enter:
- The host URL of the webhook
- The method of the webhook - POST or PUT
Optionally, provide one of these authentication parameters:
- For Basic Auth: username and password
- Bearer Token
Select Save.
For PagerDuty:
Before configuring the PagerDuty notification channel:
- You need access to a PagerDuty account with elevated privileges.
- PagerDuty service must be created and configured with Events API v2 integration.
- In your PagerDuty account, navigate to the desired service and access its Integrations settings.
- Add and configure a new Events API v2 integration.
- Copy the Integration Key (routing key) provided by PagerDuty for the newly created integration.
To configure the PagerDuty notification channel:
- From your profile menu, select Settings.
- Select the Notifications tab.
- Select PagerDuty.
- Set the Routing Key (integration key).
- Select Save.
For email:
From your profile menu, select Settings.
Select the Notifications tab.
Select Email and enter:
- Email To - Optionally, for the system email notifications (Email group)
- Email From - for the email which is sending the email
- Host - URL of the email service
- Port - port of the email service
- Username - username of the email service
- Password - of the email service
Select Save.
Configure notification at project level
Project-level notification settings can override global settings. Each project can have its unique configuration.
- Select the Projects tab
- Select any project.
- Go to the Project Overview page.
- Select Settings on the left-side menu.
- Select Notifications.
- Follow the steps under Configure notifications at the global level for each system notification channel.
Viewing notifications
Users in the following roles can view the notifications:
- Organization owners can view the global notifications.
- Project owners/editors can view the project notifications.
- All users can view their account notifications.
Each notification indicates the level and project the user belongs to with multiple roles assigned in HM.
Select the bell at the top of your HM console to view the in-app notifications. You can read a notification, mark it as unread, or archive it.
To view the email notifications, check the inbox of your configured email address.
Managing notification preferences
- From your profile menu, select My Account.
- Select the Notifications tab.
- Scroll to the Account, Global, or Project section to view the events you want to manage.
- Expand the section to see the list of events.
- For each notification, you can:
- Use the toggle button in front of the event name to opt in or out of receiving notifications for an event.
- Use the check boxes to customize the email and in-app notifications.