@backstage/plugin-notifications-node

Home > @backstage/plugin-notifications-node

Node.js library for the notifications plugin.

Classes

Class	Description
DefaultNotificationService

Interfaces

Interface	Description
NotificationProcessor	Notification processors are used to modify the notification parameters or sending the notifications to external systems. Notification modules should utilize the notificationsProcessingExtensionPoint to add new processors to the system. Notification processing flow: New notification send request is received 2. For all notification processors registered, processOptions function is called to process the notification options 3. Notification recipients are resolved from the options 4. For each recipient, preProcess function is called to pre-process the notification 5. Notification is saved to the database and sent to the Backstage UI 6. For each recipient, postProcess function is called to post-process the notification
NotificationRecipientResolver	NotificationRecipientResolver interface is used to resolve the individual users to receive the notification. The resolveNotificationRecipients is used to resolve notifications sent for entity references, and it should return object with a list of user entity references that should receive the notification. In case the function returns other than user entity references, those are ignored.
NotificationService
NotificationsProcessingExtensionPoint

Variables

Variable	Description
notificationService
notificationsProcessingExtensionPoint

Type Aliases

Type Alias	Description
NotificationProcessorFilters
NotificationRecipients
NotificationSendOptions
NotificationServiceOptions