Notifications

3 minute read

In the CloudBees platform, set up notifications so that users are informed of any updates in an organization. Notify designated users of all platform events, or just feature management events.

The following types of notification are available:

  • Email message

  • Slack message in a specified channel

  • Microsoft Teams message in a specified channel

  • Webhook

Notification events and types

You can configure notifications to ONLY send messages in response to feature management-related events. Otherwise, subscribed users receive notifications for both general and feature management events. The following are platform events that result in a notification.

General notification events:

  • When a workflow job completes.

  • When a workflow run completes.

  • When a user has exceeded their limit of monthly workflow minutes. Refer to Pricing and billing for more information on pricing plans.

    If you create a notification specific for feature management, subscribed users do not receive notifications for the general events above.

Feature management-specific events:

  • A flag is created, updated, or deleted.

  • A flag status is updated.

  • A flag value is synced.

  • A flag configuration is updated.

  • A custom property is created, updated, or deleted.

  • A target group is created, updated, or synced.

  • A flag label is created, updated, or deleted.

Access a notification configuration

Search in and sort the notification list.

To access a notification configuration:

  1. Select an organization, and then select Configurations  Notifications.

  2. (Optional) Search for a specific notification configuration, by entering all or part of a notification name into Search.

  3. (Optional) Select an option in Sort by to sort the notification list by either Ascending or Descending alphanumerical sort order.

The notification configurations are displayed according to your search or sort criteria.

Create a notification configuration

Set up one or more notifications, using email, Microsoft Teams, Slack, or a webhook. Opt to send only notifications for feature management-specific events.

A webhook URL is required to set up all notifications, except for Email.

To create a notification configuration:

  1. Select an organization, and then select Configurations  Notifications.

  2. Select Create notification.

  3. Select one of the following, and configure the notification as follows:

    1. Email

      1. Enter Channel name.

      2. (Optional) Enter Description.

      3. Enter Email addresses, in comma-separated format.

    2. Microsoft Teams webhook

      1. Enter Channel name.

      2. (Optional) Enter Description.

      3. Enter Webhook URL.

    3. Slack webhook

      1. Enter Channel name.

      2. (Optional) Enter Description.

      3. Enter Webhook URL.

    4. Webhook

      1. Enter Webhook name.

      2. (Optional) Enter Description.

      3. Enter Webhook URL.

      4. Select Authorization type from the options.

      5. Enter Token.

      6. (Optional) Select Test webhook to test your connection.

  4. (Optional) Select all feature management environments, or select a specific environment, to send ONLY feature management notifications.

    If you select one or all feature management environments, the users you designate receive feature management notifications, but not any general notifications.
  5. Select Submit.

Your notification configuration is created, and listed in Notifications. For email, designated recipients receive an email for each event. For Microsoft Teams or Slack, a message for each event is published in the designated channel for any subscribed user. For Webhook, the message is published according to your application.

Update a notification configuration

Update any of the configuration settings of a notification.

To update a notification configuration:

  1. Select an organization, and then select Configurations  Notifications.

  2. Select Vertical ellipsis next to the notification setting you want to update.

  3. Select Edit notification.

  4. Make any desired changes.

  5. Select Save.

The selected notification configuration is updated accordingly.

Delete a notification configuration

Delete any of your notification configurations. If deleted, the notification configuration is completely removed from the CloudBees platform, and deletion is irreversible.

To delete a notification:

  1. Select an organization, and then select Configurations  Notifications.

  2. Select Vertical ellipsis next to the notification configuration you want to delete.

  3. Select Delete notification.

  4. Select Delete.

The selected notification configuration is deleted and removed from the notification list.