Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourYellow
titleBETA

Telegram is a messaging app with a focus on speed and security, it’s super-fast, simple and free. It's cloud based like Slack and RockChat. According to Telegram, the app's architecture does not support federation yet like Mattermost.

The messaging format is simpler that RocketChat, Mattermost or Slack. It doesn't allow complex messages like showing avatars, fields, headers, etc. The message format is closer to an SMS message than a "Card" like Slack provides.

JEMHCloud supports Telegram notifications from Issue Events and Post Functions. You will be able to notify your Telegram Channels when JEMHC detects an issue change.

Configuring the Telegram Connection

In order to send Telegram notifications from Issue and Post function events, you need to create a Bot bot and add a Bot the bot to a group or a private conversation.

Once you have the Botbot, you can enter the the bot token to JEMHCloud in order to create the Telegram Connection. 

Configure Telegram's Bot

For this step, we are assuming that you have a Telegram account.

...

  1. Go to JEMH Cloud → Notifications → Telegram → Create
  2. Complete the form, select the nominated project, select the Telegram Connection and the chat (for example the new group chat where the bot is a member). Enter a velocity script if you want to modify the notification behavior at runtime (more below). Be sure that the Group Chat is listed in the select. If not, mention the bot user in the Telegram's chat group and refresh the Telegram Notification Page in JEMHCloud.
  3. On Submit, you should see the new Telegram mapping
  4. To test the mapping, create an issue in the nominated project and go to Auditing → Events
  5. You should see the issue created an event in the queue. When the event has been processed, the configured channel in the mapping should have received a Telegram message
  6. The report of the event should confirm the message sent 
  7. Image Modified
  8. In Auditing → Outbound Messages → Type Telegram, the table should show the Telegram messages sent and the cog icon should show their contents.

Send Telegram Notifications from Post Functions

...

Adding the Telegram Notification Post Function to workflow transition:

  1. Go to right corner Cog → JIRA Administration → Issue → Workflows. Edit the workflow of the project you want to add the Post Function
  2. Click on the transition you want to change and select the Post Functions tab. Click on Add post function
  3. Image Modified
  4. Select Send Telegram Notification by JEMHCloud and click Add
  5. Image Modified
  6. Set the Telegram Connection and Velocity script if necessary. Press Add/Update
  7. Once the Post Function is in the right position, publish the workflow draft.
  8. Image Modified
  9. To test the post function, go to an issue of the given workflow and perform the transition that will fire the post function.
  10. Image Modified
  11. Post function event should appear in JEMH Cloud → Notifications → Events.
  12. Image Modified
  13. The event report should show the used incoming webhook URL
  14. The message in Telegram:
  15. In Auditing → Outbound Messages, the table should show the Telegram messages sent and the cog icon should show their contents.

Filter Scripts

Both Telegram Notification Mapping and Telegram Post Function behavior can be changed at runtime with a Velocity Script. The script can use the event data or be time-based to change how notifications are performed.

...