This documentation relates to an earlier version of Bamboo.
View

Unknown macro: {spacejump}

or visit the current documentation home.

Notifications in Bamboo are triggered by a range of events for a plan, including build completion, build outcomes and comments being posted against build results. You can configure whether notifications are sent for a particular event and who they are sent to. Users can choose whether to receive their notifications via email, IM, both or neither.

(info) You must have the 'Edit' permission for a plan, to add or remove notifications for it.

Event

Description

'All Completed Builds'

Bamboo will send a notification whenever a build finishes for this plan, regardless of the build result. This trigger is recommended for any plans for which it is critical that people are always informed about the latest build activity.
Many organisations start with this trigger, then change it later as they get more confidence in the continuous build process.

'Failed Builds And First Successful'

This trigger is generally suitable for the majority of plans. Bamboo will send a notification whenever:

  • a build fails for this plan.
  • the plan is 'fixed' (that is, the plan's latest build is successful and the previous build failed).

'After X Failed Builds'

This trigger enables you to specify the 'Number Of Failed Builds' after which Bamboo will send a notification. This is a useful way of limiting the number of notifications, if you are concerned about people receiving too many. You can also use this event to escalate build problems, e.g. notify a manager if a build fails five times.

'Build Hung'

Bamboo will send a notification whenever it believes that a build has hung, according to the hung build criteria (read more about configuring your Building Hanging Detection settings). You can use this event to ensure that the right people are informed, if a build becomes unresponsive.

'Build Commented'

Bamboo will send a notification whenever a comment is posted against a build result. The email notification will contain all comments against the build, whereas the IM notification will only contain the comment that triggered the notification. This feature can help improve collaboration between team members. Please note that you will not receive notifications for any comments that you post.

'Build Error'

Bamboo will send a notification whenever an error occurs with the build process (i.e. the activities that Bamboo performs to run a build). This event is not related to failures of the actual build itself (see the 'Failed Builds And First Successful' event above). For example, a notification will be sent if Bamboo encounters an error when connecting to the repository, or detecting changes.

'Build Queued Without Capable Agents'

Bamboo will send a notification whenever a build is queued and there are no agents capable of building it. You can use this event to ensure that people are notified when changes to the agents adversely affect your builds.

'Build Queue Timeout'

Bamboo will send a notification whenever a build has been waiting in a build queue for longer than the build queue timeout criteria (read more about configuring your Build Queue Timeout settings). You can use this event to ensure that the right people are informed, if a build is stuck in a queue for too long.

For each plan, you can specify different recipients for each Notification Trigger. Note also that recipients need not be people with Bamboo user accounts.

Before you begin

You need to configure Bamboo's SMTP email and/or instant messaging capabilities before Bamboo can send notifications. If you have not configured either or both of these, a note will display on the page prompting you to set up the appropriate server(s):

  • To configure an email server for Bamboo, click the 'Add an Email Server' link in the note and enter the email server details in the window that displays. See Configuring Bamboo to send SMTP Email for more information.
  • To configure an instant messaging server for Bamboo, click the 'Add an Instant Messaging Server' link in the note and enter the instant messaging server details in the window that displays. See Configuring Bamboo to use Instant Messaging (IM) for more information.


To add notifications for a plan,

(info) If you are creating a new plan, start at step 5.

  1. Click 'Home' to go to the Dashboard.
  2. Click the 'All Plans' tab.
  3. Locate the plan in the list and click this icon:
  4. The 'Configuration' tab will be displayed. Click the 'Notifications' sub-tab.
  5. The 'Notifications' that you currently have set up will be displayed (see screenshot below). Add a new notification in the 'Add Build Notification' section as follows:
    • Select the 'Event':
      • 'All Completed Builds'
      • 'Failed Builds and First Successful'
      • 'After X Failed Builds'
      • 'Build Commented'
      • 'Build Hung'
      • 'Build Queued Without Capable Agents'
      • 'Build Queue Timeout'
    • Specify the 'Recipient':
      • 'Committers' — A committer is the Bamboo user(s) who committed code to a particular build (i.e. someone who committed code after the previous build was checked out by Bamboo).
      • 'Watchers' — A plan's watchers are the Bamboo users who have marked this plan as one of their favourites.
      • 'Group' — Type the name of the appropriate Bamboo group(s).
      • 'User' — Type the username of the appropriate Bamboo user; or click the following icon to select from a list of users:
      • 'Email Address' — This is useful if you need to send email notifications to a person who is not a Bamboo user. Type the appropriate email address. Please note, that if you specify the email address of an existing Bamboo user, the user will receive notifications, even if they have elected not to receive notifications in their user preferences.
      • 'Instant Messaging Address' — This is useful if you need to send IM notifications to a person who is not a Bamboo user. Type the appropriate IM address. Note that if you specify a broadcast address (eg. 'project-x@broadcast.chat.mycompany.com'), Bamboo will not know the context of related IM responses. Please note, that if you specify the IM address of an existing Bamboo user, the user will receive notifications, even if they have elected not to receive notifications in their user preferences.
  6. Click the 'Add' button.
  7. Repeat steps 5 and 6 until you have added all the build notifications that you wish to enable for this plan.
  8. Click the 'Save'/'Done' button if you are editing an existing plan. If you are creating a new plan, you can either click the 'Save'/'Done' button to create the plan without completing the rest of the wizard (check/uncheck the 'Enable Plan' checkbox to create your plan as enabled/disabled as desired) or click the 'Next' button to go to the next page:
    Specifying a Plan's Post Actions.

Screenshot: 'Build Notifications'

To remove notifications for a plan,

  1. Click 'Home' to go to the Dashboard.
  2. Click the 'All Plans' tab.
  3. Locate the plan in the list and click this icon:
  4. The 'Configuration' tab will be displayed. Click the 'Notifications' tab.
  5. Locate the notifications that you wish to disable, click the corresponding 'Remove' link in the 'Operations' column for each notification.
  6. Click the 'Done' button.



Log a request with our support team.



Raise an issue for our developers.



See answers from the community.



Blog and update our documentation.

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.