Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@backstage/plugin-notifications-node

Package Overview
Dependencies
Maintainers
3
Versions
322
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@backstage/plugin-notifications-node

Node.js library for the notifications plugin

  • 0.0.0-nightly-20240309020749
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
12K
decreased by-6.51%
Maintainers
3
Weekly downloads
 
Created
Source

@backstage/plugin-notifications-node

Welcome to the Node.js library package for the notifications plugin!

Getting Started

To be able to send notifications from other backend plugins, the NotificationService must be initialized for the environment. Add notification service to your plugin.ts as a dependency for init

import { notificationService } from '@backstage/plugin-notifications-node';

export const myPlugin = createBackendPlugin({
  pluginId: 'myPlugin',
  register(env) {
    env.registerInit({
      deps: {
        config: coreServices.rootConfig,
        logger: coreServices.logger,
        httpRouter: coreServices.httpRouter,
        notificationService: notificationService,
      },
      async init({ config, logger, httpRouter, notificationService }) {
        httpRouter.use(
          await createRouter({
            config,
            logger,
            permissions,
            notificationService,
          }),
        );
      },
    });
  },
});

You also need to set up the @backstage/plugin-notifications-backend and @backstage/plugin-notifications to be able to show notifications in the UI.

Sending notifications

To send notifications from backend plugin, use the NotificationService::send functionality. This function will save the notification and optionally signal the frontend to show the latest status for users.

When sending notifications, you can specify the entity reference of the notification. If the entity reference is a user, the notification will be sent to only that user. If it's a group, the notification will be sent to all members of the group. If it's some other entity, the notification will be sent to the owner of that entity.

If the notification has scope set and user already has notification with that scope, the existing notification will be updated with the new notification values and moved to inbox as unread.

FAQs

Package last updated on 09 Mar 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc