Step 1 - Create your bot
for Jira administrators
Before you begin to receive notifications, Jira administrator must establish a connection between Telegram and Jira itself.
All communication between these services is performed via your custom telegram bot. If you don’t have one, please use the official documentation to get your bot. (see here)
Here is a quick guide how to:
Open Telegram.
Search for BotFather bot.
Type /start and follow the given workflow to create your bot (bot’s name must end in "bot").
Done. Your bot is created.
Step 2 - Set up connection
for Jira administrators
After add-on installation Jira administrator must go to Settings → Manage apps → Telegram Connector → Telegram Bot to establish connection between Jira and Telegram.
Here administrator must add crucial information about created Telegram bot:
Bot name
Access token.
This information is given only to bot creator from BotFather. Alongside with other control options.
After configuration is saved, service connection is complete. Now users can set up their own notification rules.
Step 3 - Create configuration
Users can be notified on events happening with your project or issues via Telegram group chats. All notifications are sent from Jira on behalf of your custom bot used for the whole Jira instance.
Each project administrator can set up configuration that will notify on certain events.
To do so go to Project settings → Telegram Connector. On this page you can create as many configurations as you want as long as they use different Telegram group ID.
Telegram Group address
To start creating a configuration user must fill in the required fields:
Title (will be used as configuration name)
Telegram group ID
How to get Telegram group ID
Create Telegram group chat (see instruction)
Add bot to group chat (find bot name under "Telegram group ID" field)
Send /info command in chat to get Telegram group ID. (use /start command first if needed)
You can always test your connection to see if it is set up correctly by clicking on "Test Connection” button.
Filtering
Basic/JQL filter
By default if any selected event (see Events section below) takes place in any issue in project - a notification will be immediately sent to Telegram group chat. If you want to limit the number of monitored issues, 2 modes of filtering are available: Basic and Advanced.
You can switch between filtering modes by clicking on the corresponding toggle. Note that only one filtering mode can exist at a time.
Label next to the toggle element will give a hint on what filter mode is configured for current setting.
Basic
Advanced
Filter update will take effect immediately after saving settings and will erase another filter mode if configured.
Author
As administrator you can narrow down notification on events depending on who is their author. i.e. Who performed the action from the selected events list (see Events section below).
For example you can set up notifications to be sent only if they are performed by some core users (like managers or team leads) or a specific team. This can be done by defining specific users or via user groups.
Or you can exclude notifications of events performed by specific users simply mentioning them in the field “Exclude users”.
Events picking
After managing the Telegram group ID and bot commands users can select events they want to be notified on. Each configuration is split by sections of events depending on their specifics:
Comment
Issue
Worklog
Versions
Sprint
Activating toggles next to events will enable sending notifications to Telegram chat as soon as this event takes place in Jira.
To enable/disable the whole event column - activate or deactivate toggle for the whole column.
Extra fields
Each card has its own set of fields, yet for some events you can set up additional fields to display in the cards sent to Telegram group chat.
You can see an icon next to some events, clicking on which would open a drop down list of fields. Search and select the field which value you want to be displayed in the card sent to Telegram group chat.
After all settings have been set, save them to apply changes. As soon as they are saved, notification will start reaching your channel.
Press Save to apply your changes.
Telegram is a separate tool. Due to this fact there is a small chance of network connectivity related issues.