Skip to main content

Telegram

Get real-time updates on the launch completion in your Telegram.

With the Telegram plugin, everyone instantly knows about important test automation updates. This helps avoid delays in communication and allows teams to respond quickly to issues.

To download the Telegram plugin, see Upload plugin section.

Configuration on Telegram side​

  1. Run the chatbot.
  1. Create a Group in Telegram.
  1. Add the chatbot to your group.
  1. Copy chat ID

You can find the chat ID in two ways:

  • In the URL of the web version of Telegram
  • In the Telegram app under Advanced settings.
important

Chat id can be used to create notification rules in RP.

Configuration on ReportPortal side​

Upload plugin​

  1. Log in to ReportPortal as administrator.

  2. Go to Administrate -> Plugins section.

  3. Click ‘Upload’ button at the top of the page.

  4. Add Telegram plugin .jar file and click ‘Upload’ button.

Create notification rule​

  1. Go to the Project settings -> Notifications.

  2. Choose Telegram Notifications Group.

  3. Click ‘Create Rule’ button.

  4. Fill the form:

Rule name – from 1 to 55 characters, mandatory field

Chat id – mandatory field, copied from group info in Telegram

important

Add ‘-’ before the chat id.

In case – optional field, dropdown with the options:

  • Always – notification will be sent in any case.
  • 10% of items have issues – notification will be sent, if more than 10% of items have issues.
  • 20% of items have issues – notification will be sent, if more than 20% of items have issues.
  • 50% of items have issues – notification will be sent, if more than 50% of items have issues.
  • Launch has issues – notification will be sent, if at least 1 item has issues
  • Launch has ‘To Investigate’ items – notification will be sent, if at least 1 item has ‘To Investigate’

Launch names – optional field

You can select only existing launch name. The field allows multi-selection.

Attributes – optional checkbox

When the ‘Attributes’ checkbox is checked, you can provide key/value for attributes and select the necessary radio button:

  • ‘All attributes should match’
  • ‘Any attribute should match’
  1. Click on ‘Create’ button.

How to receive notifications in Telegram​

When you have the plugin installed and Telegram notification rules configured, you can start receiving notifications to the channel configured. For this you need to report a launch which matches the notification rule and after the launch is finished you will receive a corresponding message in the Telegram channel with some details on the Launch results.

Disable Telegram notifications​

  1. Log in to ReportPortal as administrator.

  2. Go to Administrate -> Plugins -> Notifications tab.

  3. Turn OFF for Telegram.

Disable Telegram rules​

  1. Go to the Project settings -> Notifications.

  2. Find Telegram Notifications Group.

  3. Turn OFF for the rule.

Disable plugin​

  1. Log in to ReportPortal as administrator.

  2. Go to Administrate -> Plugins section -> Notifications tab.

  3. Find Telegram plugin.

  4. Turn OFF.

Uninstall plugin​

  1. Log in to ReportPortal as administrator.

  2. Go to Administrate -> Plugins section -> Notifications tab.

  3. Find Telegram plugin and click on it.

  4. Click ‘Uninstall’ button and confirm your choice.