Welcome to Our Look into the Future!

Braga, Portugal

Vivid connector for Jira and Telegram

This small application allows you to automatically post your Jira updates in your or your company’s Telegram channels. Another very useful feature is showing ticket’s data right after someone would use a ticket’s number in his/her message. This feature is available in private chats/group chats.

Requirements

How to install

  1. Login to your Atlassian account which JIRA license is bound to
  2. Navigate to Atlassian Marketplace
  3. Click “Try it free” to install to your Jira

After these steps you should see a new menu items in the main Jira menu – Apps submenu: Telegram Notifications, Linked Telegram accounts and Your Telegram account.

New menu items related to Vivid connector

Please note that Telegram Notifications page and Linked Telegram accounts can be accessed only by Jira admins.

General configuration page

Click Telegram Notifications menu item in the main Jira menu in Apps submenu.

Jira notifications in channels

Page view with some channels already added and set up

To enable this feature you need to perform following steps:

  1. Add @JIRANotificationsBot to chosen channel
  2. Click Add a channel
  3. You will see a command you need to send to enable a channel
  4. Click Copy command button to copy the command
  5. Send this command in the chosen channel
  6. Bot will notify you about the result of this action
  7. Click Ok in the adding dialog to close it and reload the list of added notification channels
Adding a new notification channel dialog

Currently application supports following list of events to notify about:

  • Issue created
  • Issue updated
  • Comment created
  • Comment updated
  • Comment deleted

Filters for channels

Manage filters dialog

You can specify a list of filters for each notification channel to filter out some of the issues being notified about.

Here you can find logic description for better understanding how to use filters.

The filter is a combination of Jira issue field name, an operator and a value.

You can choose logical AND or OR to be applied to all specified filters, so you’d receive a notification only about an issue which meets conditions in all of the filters.

Field name is one of the available fields for an issue, the list of fields in the dropdown are loaded from the Jira API endpoint. The list contains fields for all projects.

Once a notification comes to Vivid connector for Jira and Telegram the logic checks each filter against this issue. If the issue doesn’t have one of the field specified in the filters then it’s treated as one that doesn’t meet needed condition and you won’t be notified about it. So please consider this when you are setting up the filters.

Some of the fields you can specify in the filters are not issue fields. For example it could be Assignee field. Issue itself just contain a link to the Jira user in this field. So the application tries to fetch display name of the user in this case and use this value to check against the filter.

The application does the same way in several other cases when you specify a field which belongs to another Jira entity. The priority for the field value being checked is:

  1. Try to fetch display name of the Jira entity related to the field specified in the filter
  2. Try to fetch name of the Jira entity related to the field specified in the filter (Priority in Jira has only name for example)
  3. Try to fetch field value directly from the issue

Please also note that some of the field values are converted to ‘None’ string in case they are absent. So instead of specifying empty string for the filter consider using ‘None’.

Parsing messages in group chats

Page view with one chat added and set up
  1. Add @JIRANotificationsBot to chosen channel
  2. Click Add a chat
  3. You will see a command you need to send to enable the parsing feature in the chat
  4. Click Copy command button to copy the command
  5. Send this command in the chosen chat
  6. Bot will notify you about the result of this action
  7. Click Ok in the adding dialog to close it and reload the list of added chats with parsing feature
Adding a new chat dialog

Due Date Reminders

Vivid connector for Jira and Telegram allows you to receive daily digest notifying you which tickets assigned to you have Due Date field. Digest contains list of overdue tickets, tickets are due today, tickets are due to the next day.

On Friday digest contains tickets due to Saturday, Sunday, and Monday.

Jira admins can control settings of this digest or allow users to choose their own settings.

Digest settings for Jira admins

Linked Telegram accounts page

This page displays which Jira accounts are linked to Telegram accounts. Also it displays some of the personal settings users have specified.

The page is paginated and displays 15 records on each page.

Your Telegram account page

Linking Telegram Account

Vivid connector for Jira and Telegram adds ability to link your telegram and Jira account. This can be done using a new link in the profile menu in Jira. Menu can be accessed by clicking your avatar in Jira menu.

Click the Telegram account link

By clicking this link you’ll see Information about your linked Telegram account or instructions how to link your account to Jira.

Please note that the link expires in 15 minutes once generated

Follow this instruction and if everything is ok then the bot will notify you about the successful linking and the page will be automatically reloaded to show you information about the linked account.

If your attempt failed then just try to reload the page to generate new token for linking.

Page view when Telegram account is linked

Personal Notifications

Vivid connector for Jira and Telegram allows you to receive personal notifications about changes in Jira issues where you are assignee or watcher.

Just open Notifications tab on Your Telegram account page to manage events you want to be notified about.

If you don’t want to receive any notifications just disable all events.

Notifications tab

Due Date Reminders

Your telegram account page contains some settings and options related to due date reminders.

If your Jira admin enabled user permission to edit due date reminders settings then you are able to enable/disable this feature just for you and you can choose a time when you’d like to have this reminder.

If permissions are not enabled then you’ll see just a read-only information when reminders are sent.

Please note “Synchronize you timezone” button on this tab. One should use this button when Atlassian account timezone has been changed. Unfortunately Jira doesn’t notify applications about this and currently application doesn’t refresh a profile periodically.

Page view with all available options enabled
Page view when Due Date Reminders feature disabled globally

Adding Jira comments via discussion groups

Vivid connector for Jira and Telegram allows you to add Jira comment using Telegram discussion groups. You can read about discussion groups here https://telegram.org/blog/privacy-discussions-web-bots#broadcasts-meet-group-chats.

In order to enable and setup this feature you need to do following steps:

  1. Assuming you have an activated channel where JTN bot posts updates from you Jira you need to create a discussion group for this channel.
  2. You need to add @JIRANotificationsBot to this discussion group, so bot will be able to see the discussions

Every message from the discussion will be posted as a comment to the ticket in Jira.

You need to consider following:

  • if a notification from JTN bot contains information about only one ticket then if you want to left a comment Jira for this ticket simply post a message in the discussion group
  • if a notification from JTN bot contains information about several tickets then if you want to left a comment Jira for one of those tickets you should prepend your message with a ticket key like following

TEST-1 comment for the ticket from the notification

  • If a Telegram user leaving a message in the discussion group has linked JIRA account then this account will be mentioned in Jira comment left by JTN bot
  • You are able to left a comment in Jira using discussion group only to tickets which are in the notification message from JTN bot.

More options and settings are to come for this feature.

Contacts

Email: info@vividinsight.xyz
Telegram: https://t.me/JTNSupport