How to Use Chainguard Notifications

You can use the Chainguard Console to configure how Chainguard is permitted to send notifications about things like breaking changes to users in your organization. The feature is rolling out with options to allow notifications to be sent in-app to the user’s Overview page in the Chainguard Console, via email, and using Slack.

These notifications are different from Chainguard Events as Chainguard Notifications are sent by Chainguard’s customer success representatives.

Prerequisites and limitations

This feature is currently in private beta. If you would like to participate, please reach out to our Customer Support team. To use the feature:

• You must use a user account for the Chainguard Console that is configured with the owner role for your organization.
• There are two feature flags which must be turned on, notificationsBeta and emailNotifications. These flags are not available to you until Chainguard enables your access.

Notifications are currently limited to messages related to breaking changes. In the future, this will expand to include notifications about topics like incidents, new releases, and end of life for specific images.

The in-app and email notifications can be set up for you by Chainguard when you opt in to enabling the notifications feature, but you have control over which email notifications are sent. You are also able to set one or more additional email addresses to receive notifications for your organizations; these are called forwarding addresses.

Slack requires you to establish the connection between our Chainguard Notifications Slack app and your company Slack workspace by completing the Slack OAuth flow.

Manage email notifications

To perform this task, you must use a user account for the Chainguard Console that is configured with the owner role for the organization. Then, follow these steps:

1. In the Chainguard Console, open Settings > Notifications.

2. Next to the Email section heading, click Edit. You can then change settings for what notification topics will be sent and to whom, either an individual or perhaps to an email alias for a group.

3. When you are done, click Save changes.

Set up Slack for Chainguard Notifications

Make sure you are logged into both the console and to your Slack workspace on the same machine before you begin. To perform this task, you must use a user account for the Chainguard Console that is configured with the owner role for the organization and a Slack account that can add apps to your Slack workspace and which has access to the Slack channels you plan to use.

For example, when you are trying to add the Chainguard Notifications app to Slack channels, the Slack account you are using will only be shown a list of public and private Slack channels the app has access to and your Slack user account is a member of. If you have a specific channel in mind for these notifications, make sure the Slack user establishing the connection has access to and is a member of that channel.

To set this up, follow these steps:

1. In the Chainguard Console, open Settings > Notifications.

2. Next to the Integrations section heading, click Edit.

3. Under the Slack subheading, click Connect Slack. A pop-up window from Slack will appear asking you to allow the Chainguard Notifications app to access Slack.

4. In the Workspace dropdown, select the Slack workspace in which you want to have your users receive Chainguard Notifications.

5. Click Allow.

Follow the directions in one or more of the following sections to enable notifications in public and private channels.

Preliminary step to set up notifications in a private channel

If you want to provide Chainguard Notifications in a private Slack channel, then at this point you must add the app to the private channel. In Slack:

1. Enter the private channel with your Slack user.

2. Click on the channel members icon to open the list.

3. Click to open the Integrations tab.

4. Click the Add an App button to display a list of available apps in your workspace.

5. Find Chainguard Notifications in the list and click the Add button.

Include the private channel in your actions in the next section.

Set up notifications in a public or private channel

1. Click into the Slack Channels box under the Slack subheading on the Notifications page in the console. You will be shown the list of channels available for the Chainguard Notifications app to use. Select the channel(s) where you want these notifications to be posted.

NOTE: Private channels will not appear here unless you first complete the preliminary step in the previous section.