Introduction
Notifications allow users to be notified when changes occur to the entities of the Platform (digital products, Applications, Subscriptions, IP addresses, etc.) of their interest and for which their intervention might be necessary.
Notification recipients can receive notifications in two ways:
Email: notifications sent to the recipients' email address. Email notifications require valid SMTP settings (see chapter System).
Push: notifications sent within the Platform to the recipient users, which can be viewed thanks to the bell icon in the upper right corner.
To manage notifications navigate to Administration in the Side Bar Menu and select the Notifications section. Notifications can be configured for each entity, and for each Role.
IMPACTS: There are no impacts on other entities if the notifications configurations are changed. However, when a new Role is created, the notifications for that role should also be configured. The role will appear alongside the other roles for each specific notification.
Notifications by entity
Notifications are grouped by entity. The list shows, for each entity, the number of Active notifications and Total notifications.
Entity | What is notified |
|---|---|
API | Lifecycle of the API: concept proposed, accepted or rejected; validation requested, accepted or rejected; publication in non-production and production environments, promotion, readiness for go-live, republication, deprecation, retirement and change of the specification, with the related errors. Many events have a dedicated notification for the subscribers of the API. Deadline notifications warn consumers and owners of upcoming publications, deprecation and retirement. |
APP | Concept of the application proposed, accepted or rejected. |
IP Address | IP address proposed, approved, active, rejected and removed, with the errors of approval and removal. Active, rejected and removed addresses are also notified to the subscribers. |
Keyset | Upcoming expiration and rotation of a key set. |
Organization & Groups | Users added to or removed from a group, or leaving it; invitations sent, expiring and expired; join requests and their approval or rejection; organizations created, edited and deleted; account emails such as email verification, confirmation code and password reset. If your installation is integrated with an API gateway that manages organizations, also the synchronization of organizations and its errors. |
Subscription | Subscription pending approval, approved, rejected, activated, edited (and edit rejected), suspended, reactivated and revoked because the API was retired, with the activation errors. |
Receivers
For each notification you configure the receivers and, for each receiver, the channels. Receivers can be Default or Custom, and identify the users to be notified with respect to the entity, for example:
the user who performed the action, or the user on whom the action was performed;
the owner or the developer of the API or of the application concerned;
the users with a given role in the group or in the organization of the API or of the application (for example Contributor, Consumer, Group Admin or Organization Admin);
the subscribers of an API, the contact of an organization, the Owners of the installation.
Receivers based on roles are available for each role, including custom roles.
Enabling/Disabling Notifications Massively
First it is possible to make the following massive actions for each entity's notifications, from the entities list or from the detail of the entity:
ENABLE ALL: allows you to enable all notifications for that entity. It is available only when at least one notification of the entity is inactive. This does not affect the notification settings for specific roles.
DISABLE ALL: allows you to suspend sending the notifications to all roles in the Platform for that particular entity. It is available only when at least one notification of the entity is active. This does not affect the notification settings for specific roles.
IMPACT: Enabling or disabling all notifications for an entity overrides the enablement of the specific notifications for that entity (but does not impact the specific choices for the recipients)! This means that if you have only some notifications enabled for an entity, enabling/disabling them massively will change this setting for all of them, and you may no longer know which were enabled and which were disabled. The action cannot be undone.
HINT: This kind of action is useful when you want to stop notifications from firing and spamming certain users when, for example, you are importing massive numbers of entities into the Platform with automated scripts.
Steps:
Navigate to Administration > Notifications.
Click Enable all or Disable all on the row of the entity.
Confirm the action.
Enabling/Disabling Specific Notifications
Having selected an entity, the notifications are listed with their Name, Reminder Settings (Configurable or Not available) and Status (Active or Inactive). You can search notifications by name, or filter them by receiver.
It is then possible to open each specific notification and:
specify whether each receiver should receive the notification via Email, Push, or both (the checkbox in the column header enables the channel for every editable receiver at once);
pause that specific notification, using the Status toggle, thus disabling the specific notification for all receivers. (This will not impact any selection for specific receivers.)
NOTE: A paused notification cannot be edited: enable it first to change its settings.
Steps:
Navigate to Administration > Notifications and select an entity.
Select a notification and expand its row: the description of the notification and the list of its receivers are displayed.
For each receiver, select Push, E-mail or both.
Click Save after applying the desired settings.
Managing Notifications With Reminders
Some notifications that are usually related to a deadline, such as the expiration of credentials or the retirement of an API, have the option of having reminders that will be sent as notifications to enabled users a set number of days before the deadline (or after the event). For these notifications the Reminder Settings column shows Configurable. Each reminder is a notification slot.
By default, the installation includes the following reminders:
Notification | Default reminders |
|---|---|
Deprecation deadline to API consumers | 60 days before |
Deprecation deadline to API owners | 90 days before |
Publication deadlines (non-production and production) to API consumers | 60 and 30 days before |
Publication deadlines (non-production and production) to API owners | 90 and 45 days before |
Retirement deadline to API consumers | 60 and 30 days before |
Retirement deadline to API owners | 90 and 45 days before |
Invitation expiring | 3 days before |
Rotation keyset deadline | 7 days before |
Steps:
Navigate to Administration > Notifications and select an entity.
Select a notification related to a deadline from the list and expand its row.
In the Reminder Settings section, add a notification slot and enter the number of days, OR remove a slot with the trash icon.
Click Save after applying the desired settings.
NOTE: Duplicate slots are merged.