Skip to content
Stable

This component is complete and can be used. The interfaces will be supported until the function is removed from the project via the deprecation process. There will be ongoing extensions to this function, but it will be done to ensure backward compatibility as far as possible. If there is a need to break backward compatibility, this will be discussed and reviewed in the community, with a documented timeline.

Notification Manager API

The Notification Manager API is a REST API designed to support the management of resource monitoring, the maintenance of the list of subscribers to that monitoring, and the notification of significant events or situations to the registered subscribers.

It supports a personalized notification service. This includes the definition of the trigger for the notification, the style of notification and the recipient.

Key Features

The Notification Manager API supports the following key features:

  • Monitored Resources: Link notification types to the metadata elements that should be monitored for changes.
  • Notification Subscribers: Define the recipients of notifications for specific notification types.

Further information

Sample requests for the REST API can be found in Egeria-api-notification-manager.http. In addition:

Usage Examples

Examples of events that could trigger a notification include:

  • The creation, update or delete of specific metadata elements.
  • The creation, update or delete of specific types of metadata elements.
  • The detection of an unauthorized user action.
  • The completion of a process.
  • The production of a particular type of audit log record.
  • A timer expiring.

When the specific notification occurs, the resulting action could be:

  • To create a user notification
  • To create a ToDo for a user
  • To initiate a governance action process
  • To create an incident report
  • To create an event on a specific topic
  • To call a remote API

Notification Types

The notification definitions are stored in Open Metadata using Notification Types. Attached to the notification type are the resources to monitor and the subscribers to be notified if/when significant event happens around the monitored resources. Subscribers are typically actors or automated processes.

Egeria supports a number of monitoring agents called watchdog action services that are able to support the monitoring of open metadata events and subscribers that are either actors or governance actions.

The Notification Manager API supports search, create, update, and delete of the following types of open metadata that supports notifications.

  • Notification Types
  • Subscribers
  • Monitored Resources

It may be used by a subscriber wishing to change their subscriptions, or an external monitor that is using the Open Metadata definitions to configure its monitoring and notification processes.

Raise an issue or comment below