Subscribing to Notifications
TeamCity provides a wide range of notification possibilities to keep developers informed about the status of their projects. Notifications can be sent by e-mail, Jabber/XMPP instant messages or can be displayed in the IDE (with the help of TeamCity plugins) or the Windows system tray (using TeamCity Windows Tray Notifier). Notifications can also be received via Atom/RSS syndication feeds.
Notifications in TeamCity are sent per-user according to the user's configured notification rules. Notification rules can also be configured at the user group level, in which case they will apply to all the users in the group.
You can customize notification templates.
Subscribing to Notifications
TeamCity allows you to flexibly adjust the notification rules, so that you receive notifications only on the events you are interested in. To subscribe to notifications:
In the top right corner of the screen, click the arrow next to your username, and select My Settings & Tools from the drop-down list. Open the Notification Rules tab.
Click the required notifications type:
Email Notifier: to be able to receive email notifications, your email address must be specified in the General area on the My Settings & Tools page.
IDE Notifier: to receive notifications right in your IDE, the required TeamCity plugin must be installed in your IDE. For the details on installing TeamCity IDE plugins, refer to Installing Tools.
Jabber Notifier: to receive notifications of this type, specify your Jabber account either on the Notification Rules | Jabber notifier page, or the My Settings & Tools page in the Watched Builds and Notifications area. Note that instead of Jabber you can specify your Google Talk account here if this option is configured by the System Administrator.
Windows Tray Notifier: to receive this type of notifications, Windows Tray Notifier must be installed.
Click Add new rule and specify the rule in the dialog. The notification rules are comprised of two parts: what you will watch and which events you will be notified about. See the details below.
What Will Be Watched
Event | Description |
|---|---|
Events related to the following projects and build configurations | Select the projects / build configurations whose builds you want to monitor. Notification rules defined for a project will be propagated to its subprojects. To monitor all of the builds of all the projects' build configurations, select Root project. Use the following options for granular control over the notifications in the selected projects / build configurations:
|
System wide events | Select to be notified about investigations assigned to you. |
Which Events Will Trigger Notifications
Event | Description |
|---|---|
Build fails | Check this option to receive notifications about all of finished failed builds in the specified projects and build configurations. If an investigation for a build configuration was assigned to someone while the build was in progress, the failed build notification is sent only to that user. Note that if Builds with my changes only is selected in the Watch area, TeamCity will notify you if a build with your changes fails, and will keep sending notifications on each 'incomplete' build afterwards until a successful one. An incomplete build is a finished build which failed with at least one of the following errors:
|
Only notify on the first failed build after successful | Check this option to be notified about only the first failed build after a successful build or the first build with your changes. When using this option, you will not be notified about subsequent failed builds. |
Only notify on new build problem or new failed test | Check this option to be notified only if a build fails with a new build problem or a new failed test. |
Build is successful | Check this option to receive notifications when a build of the specified projects and build configurations executed successfully. |
Only notify on the first successful build after failed | Check this option to receive notifications when only the first successful build occurs after a failed build. Notifications about subsequent successful builds will not be sent. |
The first error occurs | Check this option to receive notifications about a "failing" build as soon as the first build error is detected, even before the build has finished. |
Build starts | Check this option to receive notifications as soon as a build starts. |
Build fails to start | Check this option to receive notifications when a build fails to start. |
Build is probably hanging | Check this option to receive notifications when TeamCity identifies a build as hanging. |
Investigation is updated | Check this option to receive notifications on changing a build configuration or test investigation status, e.g. someone is investigating the problem, or problems were fixed, or the investigator changed. |
Tests are muted or unmuted | Check this option to receive notifications on the test mute status change in the affected build configurations. |
Investigation assigned to me | This option is available only if the option is selected in the Watch area. Check the option to be notified each time you start investigating a problem. |
Rules Processing Order
TeamCity applies the notification rules in the order they are presented. TeamCity checks whether a build matches any notification rule, and sends a notification according to the first matching rule; the further check for matching conditions for the same build is not performed. You can reorder the configured notification rules.
The user rules are applied first, then the group rules are applied.
The group rules are processed in hierarchical order: starting from child groups to parent ones.
If there are more than one parent with their own rules set, the inherited rules are processed t op-bottom corresponding to the order they are presented on the Notification Rules user profile tab (alphabetically).
Unsubscribing and Overriding Existing Rules
You may already have some notification rules configured by your System Administrator for the user group you're included in.
To unsubscribe from or override group notifications, add your own rule with the same watched builds and different notification events.
To unsubscribe from all events, add a rule with the corresponding watched builds and no events selected.
Customizing RSS Feed Notifications
TeamCity allows obtaining information about the finished builds or about the builds with the changes of particular users via RSS. You can customize the RSS feed from the TeamCity Tools sidebar of My Settings & Tools page using the Syndication Feed section (click customize to open the Feed URL Generator options) or from the home page of a build configuration. TeamCity produces a URL to the syndication feed on the basis of the values specified on the Feed URL Generator page.
Feed URL Generator Options
Option | Description |
|---|---|
Select Build Configurations | |
List build configurations | Specify which build configurations to display in the Select build configurations or projects field. The following options are available:
|
Select build configurations or projects | Use this list to select the build configurations or projects you want to be informed about via a syndication feed. |
Feed Entries Selection | |
Generate feed items for | Specify the events to trigger syndication feed generation. You can opt to select builds, changes or both. |
Include builds | Specify the types of builds to be informed about:
|
Only builds with changes of the user | Select the user whose changes you want to be notified about. You can get a syndication feed about the changes of all users, yours only, or of a particular user from the list of users registered to the server. |
Other Settings | The following options are available only if All is selected in the List build configurations section. |
Feed Authentication Settings: | |
Include credentials for HTTP authentication - Check this box to specify the user name and password for automatic authentication. If this option is not checked, you will have to enter your user name and password in the authorization dialog box of your feed reader. TeamCity User, Password -configurable when the ... option is checked. Type the user name and password which will be used for HTTP authorization. | |
Copy and Paste the URL into Your Feed Reader or Subscribe | This field displays the URL generated by TeamCity on the basis of the values specified above. You can either copy and paste it to your feed reader or click the Subscribe link. |
Additional Supported URL Parameters
In addition to the URL parameters available in the Feed URL Generator, the following parameters are supported:
Parameter Name | Description |
|---|---|
itemsCount | a number; limits the number of items to return in a feed. Defaults to 100. |
sinceDate | a negative number; specifies the number of minutes. Only builds finished within the specified number of minutes from the moment of feed request will be returned. Defaults to 5 days. |
template | name of the custom template to use to render the feed (<template_name>). The file |
By default, the feed is generated as an Atom feed. Add &feedType=rss_0.93 to the feed URL to get the feed in RSS 0.93 format.
Example
Get builds from the TeamCity server located at "http://teamcity.server:8111" address, from the build configuration with ID "bt1", limit the builds to the those started with the last hour but no more than 200 items: