Interacting with YouTrack via Jabber
Starting with YouTrack 4.2, you can not only get notifications from YouTrack in your Jabber client, but also interact with YouTrack via Jabber messages. Now you can search for issues and apply commands to issues using Jabber. Just like this:
We call the feature that allowed you to interact with YouTrack in this manner the "Jabber Bot".
Enabling and Configuring Jabber Bot
- Open Administration > Settings page
- In the Jabber Notification settings, please provide the following info:
- The standard Jabber Notifications parameters: Jabber server and its port and user credentials.
- If needed to provide jabber service name, click the Advanced settings link below the server port's field.
- To use the bot service, ensure that Enable Jabber bot check box is selected.
- Test the configuration by sending test Jabber message and save the settings in case of success.
Basically, that's it. Now each user who enabled Jabber notifications will be able to apply commands to issues via Jabber messages.
Applying Commands to Issues
The general use case for the Jabber bot is to react immediately on issue's update by applying a command to the updated issue in a reply message to the notification you have received.
That is, you have received notification that issue A-1 had been updated and right away, in your Jabber client, you write a command reply to this notification:
assignee me state In testing and the command will be applied to the issue A-1.
In general, a command should be provided in the following format:
- You can skip issueID, if you are replying to a notification about particular issue
- You can apply a command to one or multiple issues simultaneously. To do so, specify target issueIDs separating them by comma or space. For example, both 'A-1, A-2, A-5' and 'A-1 A-2 A-5' variants are valid.
- To add a comment to an issue, use the "comment" keyword. All that you specify after it will be considered as the comment's text.
Searching for issues
Search request in a Jabber message should be denoted with the slash mark to be distinguished from a command and to be correctly processed by YouTrack. For example, to get a list of issues
To search for a specific issue by its
issueID, you should denote the request with the hash mark:
If you use "
/stat" request, then you'll get the current usage statistics of your YouTrack server.