Configuring notifications for a plan and its jobs
Error rendering macro 'viewport-redirect'
null
Notifications in Bamboo are triggered by a range of events involving a plan and its jobs, including build completion, build outcomes and comments being posted against build results. You can configure whether notifications are sent for a particular event for each plan and job, and who they are sent to.
Recipients receive notifications by email and, in general, do not require Atlassian Cloud user accounts. Note that notifications can not be received by IM – see Restricted functions.
Adding notifications for a plan or job
Before you begin:
On this page:
- You must have the 'Edit' permission for a plan, to add or remove notifications for it.
To add a notification for a plan or its jobs:
- Navigate to the configuration for the desired plan, as described on Configuring plans.
- Click the Notifications tab.
Set up a new notification in the 'Add Build Notification' section as follows:
Setting Notes Event Select the event type you want to be notified about. Refer to the list of events (below) for details. Recipient Type User — Enter the username of the appropriate Bamboo user, or click the icon to select from a list of users. Hipchat — Enter the Hipchat API Token and Room Name. See Integrating Bamboo with HipChat for more information.
Group — Enter the name of the appropriateAtlassian Cloud group(s).
Email Address — You can use email to send notifications to a person who is not a Bamboo user. Type the appropriate email address. 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.
IM Address— This is useful if you need to send Instant Messenger (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 relatedIM responses.
- 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.
Responsible Users — The Bamboo users who have been assigned as being responsible for a broken build. See Assigning responsibility for build failures. Committers — The Bamboo users who have committed code to a particular build since build was last checked out by Bamboo. Watchers — The Bamboo users who have marked this plan as one of their favorites. - Click Add, then configure further notifications if required.
- Click Save when you have finished.
Screenshot: Plan build notifications
Notification events
Plan Events | Description |
|---|---|
All Builds Completed | Bamboo will send a notification whenever the plan build finishes, regardless of the plan build's result. This notification is recommended for any plans whose latest build activity is critical for people to be informed about. |
Change of Build Status | Bamboo will send a notification only when there has been a change in status of the plan's build activity over consecutive plan builds — for example, only whenever a plan's latest build changes from successful to failed or vice versa (i.e. 'fixed'). |
| Failed Builds And First Successful | Bamboo will send a notification whenever: - a build of this plan fails. - the plan is 'fixed' (that is, the plan's latest build is successful and the previous plan build failed).  This notification is generally suitable for the majority of plans. |
After X Failed Builds | This notification allows you to specify the Number Of Failures (i.e. number of failed builds of this plan), after which Bamboo will send a notification. |
Comment Added | Bamboo will send a notification whenever a comment is added to a build result. The email notification will contain all comments against the plan build, whereas IM notifications will only contain the comment that triggered this notification event. |
| Change of Responsibilities | Bamboo will send a notification whenever someone is added to, or removed from, the list of those responsible for a broken build. |
Job Events |
|
All Jobs Completed | Bamboo will send a notification whenever a job build of the plan finishes, regardless of the job build's result. This notification is recommended if the latest build activity of all jobs in this plan are critical for people to be informed about. |
Change of Job Status | Bamboo will send a notification only when there has been a change in build activity status of the jobs within this plan over consecutive plan builds — for example, only whenever the latest build of any job in this plan changes from successful to failed or vice versa (i.e. 'fixed'). |
| Failed Jobs And First Successful | Bamboo will send a notification whenever: - a build of this job fails. - the job is 'fixed' (that is, the job's latest build is successful and the previous job build failed). |
First Failed Job For plan | If multiple jobs fail in a plan, Bamboo will only send a notification for the first failing job detected by the Bamboo system. |
Job Error | Bamboo will send a notification whenever an error occurs in one of the plan's job build processes (i.e. the activities that Bamboo performs to run a job build). This event is not related to failures of the actual build itself (see the Failed Jobs And First Successful and Failed Builds And First Successful events above). For example, a notification will be sent if Bamboo encounters an error when connecting to the repository, or detecting changes. |
Job Hung | Bamboo will send a notification whenever it determines that one of the plan's job builds has hung, according to the hung job build criteria (read more about configuring your hung job build settings). |
Job Queue Timeout | Bamboo will send a notification whenever one of the plan's job builds has been waiting in the queue for longer than the build queue timeout criteria (read more about configuring your job's Build Queue Timeout settings). |
Job Queued Without Capable Agents | Bamboo will send a notification whenever one of the plan's job builds is queued and there are no agents capable of building it. |
Removing notifications from a plan or job
You must have the 'Edit' permission for a plan, to add or remove notifications for it.
- Navigate to the configuration for the desired Plan, as described on Configuring plans.
- Click the Notifications tab.
- Click Remove for each of the notifications that you wish to remove.