Skip to end of metadata
Go to start of metadata
You are viewing documentation of TeamCity 6.5.x, which is not the most recent released version of TeamCity. Please refer to the listing to choose another version.
Search

Table of Contents

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).

Subscribing to Email, Jabber, IDE, Windows Tray Notifications

TeamCity allows you to flexibly adjust the notification rules, so you will receive notifications only on the events that are interesting to you. To subscribe to notifications:

  1. 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.
  2. Click the required notifications type:
    • Email notifier: to be able to receive email notifications, you should have your email address specified at the General area on the My Settings & Tools page.
      Icon

      Note, that TeamCity comes with a default notification rule. It will send you an email notification if a build with your changes has failed. This rule starts working after you enter the email address.

    • IDE notifier: to receive notifications right in your IDE, you should have TeamCity plugin installed in your IDE. For the details on installing TeamCity IDE plugins, please 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 here your Google Talk account, if it is configured be System Administrator to be used.
    • Windows Tray Notifier: to receive this type of notifications you should have Windows Tray Notifier installed.
  3. For the selected notifications type, specify the notification rules, which are comprised of two parts: what should be watched and notification conditions - the events you want to be notified about. See the description below.
Icon

Email and Jabber notifications are sent only if System Administrator has configured TeamCity server email and Jabber settings. System Administrator can also change the templates used for notifications.

To Watch

Builds affected by my changes

Check to monitor only the builds that contain your changes.

Builds from the project

Select a project which builds you want to monitor. Select All projects to monitor all of the builds of all the projects' build configurations.

Builds from the selected build configurations

Check to monitor all of the builds of the selected build configurations. Hold the Ctrl key to select several build configurations.

System wide events

Select to be notified about system wide events.

Notification Conditions

The build fails

Check this option to receive notifications about all of the failed builds in the specified projects and build configurations.

Icon
  • If the Builds affected by my changes option is selected in the Watch area, you will not receive notifications about the next failed builds, if they fail with the same errors.
  • If someone is investigating the build failure, all the subsequent notifications will be sent only to that developer.

Ignore failures not caused by my changes

This option can only be enabled when the Watch builds affected by my changes option is used. Check this option not to be notified when build that includes your changes fails, but fails because of the previous (other people's) changes (e.g. the build fails "the same").

Only notify on the first failed build after successful

Check this option to be notified when the build fails after a successful build. Using this option you will not be notified about subsequent failed builds.

The build is successful

Check this option to receive notifications when a build of the specified build configurations has executed successfully.

Only notify on the first successful build after failed

Check this option to receive notification when only the first successful build occurs after a failed build. Notifications about subsequent successful builds will not be sent.

Notify when the first error occurs

Check this option to receive notifications when the first errors are detected, even before the build has finished.

The build starts

Check this option to receive notifications when a build of the specified build configurations starts.

The build fails to start

Check this option to receive notifications when a build of the specified build configurations fails to start.

The build is probably hanging

Check this option to receive notifications when TeamCity suspects that a build of the specified build configurations is hanging.

Investigation is updated

Check this option to receive notifications about the investigation status, like someone is investigating the problem, or problems were fixed, or the investigator has changed, and the first successful build after the fixes.

Tests are muted or unmuted

Investigation assigned on me

This option is available only if System wide events option is selected in the Watch area. Check the option to be notified each time you start investigating a problem.

Icon

TeamCity applies the notification rules in the order they are presented. TeamCity checks whether a build matches any notification rule, and sends notification according to the first matching rule; further check for matching conditions for the same build does not performed.
Note, that you can reorder the notification rules specified.

Icon

Note, that you may already have some notification rules configured by your System Administrator for the user group you're included in.

  • To unsubscribe from group notifications you can add your own rule with same watched builds and different notification events.
  • To unsubscribe from all events, add a rule with corresponding watched builds and no events selected.

Customizing RSS Feed Notifications

TeamCity allows to obtain information about the finished builds, or about the builds with the changes of particular users, via RSS feed. You can customize RSS feed from the TeamCity Tools sidebar of My Settings&Tools page (click customize to open Feed URL Generator options), or from the home page of a build configuration. TeamCity produces a URL to the syndication feed on the base of the values, which you specify in the Feed URL Generator page.

Feed URL Generator Options

Option

Description

Select Build Configurations

 

List build configurations

Specify which build configurations display in the field Select build configurations or projects. The following options are available:

  • With external status enabled: if this option is selected, the next field shows the list of build configurations, for which the option Enable status widget is set in the General Settings, and build configurations visible for everybody without authentication.
  • Available to 'Guest' user: Select this option to show the list of build configurations, which are visible to the user with the Guest permissions.
  • All: Select this option to show a complete list of build configurations, which requires HTTP authorization. Selecting this option enables the field Feed authentication settings.If external status for the build configuration is not enabled, the feed will be available only for authorized users.

Select build configurations or projects

Use this list to select the build configurations or projects you want to be informed about via syndication feed.

Feed Entries Selection

 

Generate feed items for

Specify the events, which trigger syndication feed generation. You can opt to select builds, changes or both.

Include builds

Specify the types of builds to be informed about: 

  • All builds
  • Only successful
  • Only failed

Only builds with changes of the user

Select the user, whose changes you want to be notified about. You can get 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 only available, when All is selected in the List build configurations section.

Include credentials for HTTP authentication

Check this option 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

Type the user name and password, which will be used for HTTP authorization. These fields are only available, when Include credentials... option is checked.

Copy and paste URL to your feed reader, or Subscribe

This field displays a URL, generated by TeamCity, on the base of the values, specified above. You can either copy and paste it to your feed reader, or click the Subscribe link.

Supported Additional URL parameters

In addition to the URL parameters available in the Feed URL Generator, the following parameters are supported:

Parameter Name

Description

itemsCount

number, limits the number of items to return in a feed. Defaults to 100.

sinceDate

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 <TeamCity Data Directory>\config\<template_name>.ftl should be present on the server. See corresponding section on the file syntax.

By default the feed is generated as 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 internal id "bt1", limit the builds to the those started with the last hour but no more then 200 items:



See also:

Administrator's Guide: Customizing Notifications