Connector for Jira - User Guide

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)

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.

picture

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

You can always test your connection to see if it is set up correctly by clicking on "Test Connection” button.

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

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.

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.

Filter update will take effect immediately after saving settings and will erase another filter mode if configured.

Press Save to apply your changes.