Skip to main content

Notifications

Soundcheck integrates with the Notifications plugin by providing a number of built in notifications.

Setup​

Install the notifications plugin for Backstage per the instructions here.

In soundcheck enable notifications globally with the following setting:

soundcheck:
  notifications:
    enabled: true

Migrating from Legacy Soundcheck Notifications​

All campaign notifications are supported in the soundcheck notification plugin integration.

To migrate to the new system, simply follow the setup step above.

The new notification system runs in parallel with the legacy system, so both can be active at the same time.

Differences Between Old and New System​

  1. The new system integrates directly with the open source notifications plugin and benefits from the features there.
  2. The new system has additional notification types, and enhanced campaign notifications.
  3. Any new features around notifications will only work with the new notification system.
  4. Email and slack is no longer configured within Soundcheck and as part of the campaign fields, but within the notification processors.

Notification Types​

This documents notifications that Soundcheck will send. To build more robust or complex notifications involving Soundcheck, we suggest looking at events.

Campaigns​

  • Campaign Create - owner of Campaign
  • Campaign Updated - owner of Campaign
  • Campaign Archived - owner of Campaign
  • Campaign Deleted - owner of Campaign
  • Campaign Milestone Reached - owner of Campaign

Checks​

  • Previously Passing Check is now Failing - owner of entities that are failing this check. If multiple entities a user owns are failing a check, only 1 notification is sent. This only triggers if the previous check state was passed.

Tracks​

  • Previously Certified Track is now Failing - owner of entities that are failing certification. If multiple entities a user owns are failing certification, only 1 notification is sent. This only triggers if the previous certification state was passed.
  • Previously Passing Campaign is now Failing - owner of entities that are failing this campaign. If multiple entities a user owns are failing this campaign, only 1 notification is sent. This only triggers if the previous campaign state was passed.