Merge pull request #454 from testomatio/telegram-type

telegram_notification

Author: TetianaKhomenko

astro.config.mjs

@@ -351,6 +351,7 @@ export default defineConfig({
 								{ label: 'Email', link: '/integrations/report-notifications/email' },
 								{ label: 'Slack', link: '/integrations/report-notifications/slack' },
 								{ label: 'Microsoft Teams', link: '/integrations/report-notifications/ms-teams' },
+								{ label: 'Telegram', link: '/integrations/report-notifications/telegram' },
 								{ label: 'Jira', link: '/integrations/report-notifications/jira' },
 								{label: 'Azure DevOps', link: '/integrations/report-notifications/azure-devops'},
 							],

src/content/docs/integrations/report-notifications/images/att1_telegram.png

@@ -8,23 +8,26 @@ head:
     attrs:
       name: og:image
       content: https://docs.testomat.io/_astro/Basic_Rules.BGM4UhZJ_Z1Yiri8.webp
-      
+
   - tag: meta
     attrs:
       name: keywords
-      content: Testomat.io, notifications, Email alerts, Email notifications, Slack notifications, MS Teams, Jira integration, Jira Notification, Azure DevOps, notification rules, test runs, automated alerts, CI notifications, QA tools, notification channels, Report Notification, Basic rules, Advanced rules engine, Run Group Notifications, test management, test automation, software testing
+      content: Testomat.io, notifications, Email alerts, Email notifications, Slack notifications, MS Teams, Jira integration, Jira Notification, Azure DevOps, Telegram notification, Notification rules, test runs, automated alerts, CI notifications, QA tools, notification channels, Report Notification, Basic rules, Advanced rules engine, Run Group Notifications, test management, test automation, software testing
 ---
 
 **Notification** is one of the attractive Agile testing tool features. Test management web application Testomat.io provides for collaborative purposes notification QA team, development team and business. So, keeping the teams engaged with project updates and getting fast feedback from business owners is simpler than ever! In addition, you as the test manager or team owner through **Team Management Dashboard** will have end-to-end visibility on your collaboration process.
 
 **Available to notify by:**
-- Email notifications.
-- Slack notification.
-- Jira Notification.
-- MS Teams.
-- Azure DevOps.
+
+- **Email** notifications.
+- **Slack** notification.
+- **Microsoft Teams** notification.
+- **Jira** notification.
+- **Azure DevOps** notification.
+- **Telegram** notification.
 
 Testomat.io allows sending notifications for finished runs:
+
 - Send brief reports to stakeholders.
 - Notify team members of failed or passed tests.
 - Notify test results after test executions.
@@ -69,20 +72,20 @@ manual and contains(run, "Release")
 
 A complete list of allowed variables:
 
-* `automated` - boolean. True if a run is automated
-* `manual` - boolean. True if a run is manual
-* `has_failed` - boolean. True if a run has failed
-* `has_passed` - boolean. True if a run has passed
-* `was_terminated` - boolean. True if a run was terminated
-* `run` - string. Title of a run
-* `rungroup` - title. Title of rungroup a run belongs to
-* `status` - string. Status of run, 'passed' or 'failed' as a string.
-* `started_at` - datetime. Time when the run was started.
-* `finished_at` - datetime. Time when the run was finished
-* `passed_tests` - collection. A list of all passed tests in a run.
-* `failed_tests` - collection. A list of all failed tests in a run.
-* `skipped_tests` - collection. A list of all skipped tests in a run.
-* `env` - collection. A list of environments.
+- `automated` - boolean. True if a run is automated
+- `manual` - boolean. True if a run is manual
+- `has_failed` - boolean. True if a run has failed
+- `has_passed` - boolean. True if a run has passed
+- `was_terminated` - boolean. True if a run was terminated
+- `run` - string. Title of a run
+- `rungroup` - title. Title of rungroup a run belongs to
+- `status` - string. Status of run, 'passed' or 'failed' as a string.
+- `started_at` - datetime. Time when the run was started.
+- `finished_at` - datetime. Time when the run was finished
+- `passed_tests` - collection. A list of all passed tests in a run.
+- `failed_tests` - collection. A list of all failed tests in a run.
+- `skipped_tests` - collection. A list of all skipped tests in a run.
+- `env` - collection. A list of environments.
 
 An expression should return a boolean value. To deal with types other than boolean functions and methods can be used:
 
@@ -96,20 +99,21 @@ contains(run, "New")
 
 **Collection**
 
-Collections contain an array of objects. 
+Collections contain an array of objects.
 
 Use `.size` to check for the size of items in the collection. For instance, this rule is activated when a number of failed tests is more than 10.
 
 ```
 failed_tests.size > 10
 ```
+
 Collection of tests can be filtered. Tests in the collection have following properties:
 
-* `test['title']` - title of a test
-* `test['suite']` - title of a suite of a test
-* `test['id']` - id of a test
-* `test['suite_id']` - id of a suite
-* `test['status']` - status of a test in collection
+- `test['title']` - title of a test
+- `test['suite']` - title of a suite of a test
+- `test['id']` - id of a test
+- `test['suite_id']` - id of a suite
+- `test['status']` - status of a test in collection
 
 For instance, this is how to check if a collection of failed tests contains at least one test with `@important` tag in its name:
 
@@ -121,13 +125,13 @@ failed_tests.filter(test, contains(test["title"], "@important")).size > 0
 
 `started_at` and `finished_at` variables are of datetime type. They have properties from [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) and [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) classes of Ruby that can be used in expressions. Most used ones are:
 
-* `hour`
-* `minute`
-* `day`
-* `wday`
-* `month`
-* `year`
-* [etc](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html)
+- `hour`
+- `minute`
+- `day`
+- `wday`
+- `month`
+- `year`
+- [etc](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html)
 
 For instance, this is how notification can be enabled for reports finished in non-business time:
 
@@ -177,7 +181,7 @@ automated and has_failed and contains (env, "alpha”)
 has_passed and passed_tests.filter(test, contains(test["title"], "autocomplete")).size > 0
 ```
 
-For example: 
+For example:
 
 ![Testomat.io - Run Rules](./images/Run_rule.png)
 
@@ -206,12 +210,12 @@ The rules engine allows writing conditions in a special expression language simi
 
 A list of allowed variables:
 
-* `title` - string. Title of a rungroup
-* `rungroup_finished` -  boolean. True if all runs completed => True if rungroup contains only finished runs.
-* `runs` - collection. A list of all runs inside a rungroup
-* `finished_runs` - collection. A list of finished (passed or failed) runs inside a rungroup
-* `ongoing_runs` - collection. A list of pending runs (scheduled, in progress) runs inside a rungroup
-* `failed_runs` - collection. A list of failed runs inside a rungroup
+- `title` - string. Title of a rungroup
+- `rungroup_finished` - boolean. True if all runs completed => True if rungroup contains only finished runs.
+- `runs` - collection. A list of all runs inside a rungroup
+- `finished_runs` - collection. A list of finished (passed or failed) runs inside a rungroup
+- `ongoing_runs` - collection. A list of pending runs (scheduled, in progress) runs inside a rungroup
+- `failed_runs` - collection. A list of failed runs inside a rungroup
 
 ### Examples for Run Groups Notifications
 
@@ -234,14 +238,16 @@ ongoing_runs.filter(run, run['created_at'] <= 0.seconds_ago).size == 0
 ```
 
 **Notify when next rules are met:**
-- the title of the Run Group contains the substring 'str-' and 
+
+- the title of the Run Group contains the substring 'str-' and
 - all runs within this Run Group are finished and
 - at least one of the runs within this Run Group has a title that contains the exact string 'islast: true'
 
 ```
 contains(title, "str-") and rungroup_finished and (runs.select(run, contains(run["title"], "islast: true")).size > 0)
 ```
-For example: 
+
+For example:
 
 ![Testomat.io - RunGroup Rules](./images/RunGroup_rule.png)
 

src/content/docs/integrations/report-notifications/images/att2_telegram.png

@@ -0,0 +1,73 @@
+---
+title: Telegram Notifications
+description: Configure Telegram notifications in Testomat.io to receive test updates. This guide provides detailed steps for creating a Telegram bot, generating a Bot Token, retrieving a Chat ID, and linking it with Testomat.io for seamless test result notifications.
+type: article
+url: https://docs.testomat.io/integrations/report-notifications/telegram
+head:
+  - tag: meta
+    attrs:
+      name: keywords
+      content: Telegram integration, Testomat.io, failed test runs, Notification rules, Report Notifications, Add Notification Rule, publish report, public link, basic rules, advanced rules engine, detailed test run results, test management, test automation, software testing
+---
+
+Testomat.io provides integration with **Telegram** to deliver real-time notifications about your test results directly into your chat. This integration allows you to keep the entire team updated about failed test runs, published reports, or other key QA events without leaving Telegram.
+
+Before creating a **New Notification Rule** in Testomat.io, you need to have:
+
+- **Telegram bot token** — if you don’t have one yet, follow the official Telegram instructions to [create a new bot](https://core.telegram.org/bots#creating-a-new-bot).
+
+## How to get a Chat/Channel/Group ID
+
+To send notifications from Testomat.io to Telegram, you need a unique identifier (ID) for the destination:
+
+- **Chat ID** is used for sending notifications to a personal/individual chat
+- **Channel/Group ID** is used for sending notifications to a shared channel or group
+
+### Individual Chat Notifications
+
+1. Open a chat with your bot in Telegram
+2. Send any message to the bot
+3. Forward this message to [@username_to_id_bot](https://t.me/username_to_id_bot) to get the **Chat ID**
+4. Paste the returned ID into the **Telegram bot chat/channel/group ID** field in Testomat.io
+
+### Channel/Group Notifications
+
+1. Create a channel (or group) in Telegram
+2. Add your bot as an **administrator**
+3. In the channel/group, send any message
+4. Forward this message to [@username_to_id_bot](https://t.me/username_to_id_bot) to get the **Channel/Group ID**
+5. Paste the returned ID into the **Telegram bot chat/channel/group ID** field in Testomat.io
+
+## How to Create a New Notification Rule for Telegram
+
+1. Navigate to **Settings** in the left sidebar
+2. Open the **Report notifications** page
+3. Click on the **Add Notification Rule** button
+
+![Add Notification Rule](./images/att1_telegram.png)
+
+Once the page opens, fill in the following fields:
+
+4. **Title** — Notification rule name (required)
+5. **Notification Type** — select **Telegram** from the dropdown (required)
+6. **Telegram bot token** (required)
+7. **Telegram bot chat/channel/group ID** (required)
+
+:::note
+
+Add the bot as an **administrator** of the channel/group. Without admin rights, Testomat.io cannot deliver notifications, even with the correct Channel/Group ID.
+
+:::
+
+8. Enable **Publish a report and use public link in report notification** (optional)
+9. Configure Rules: choose [Basic Rules](https://docs.testomat.io/integrations/report-notifications/rules/#basic-rules) or [Advanced Rules Engine](https://docs.testomat.io/integrations/report-notifications/rules/#advanced-rules)
+10. Click **Save** button to create the new Notification Rule
+
+![Save new notification rule](./images/att2_telegram.png)
+
+After saving your rule:
+
+- Use the **Test webhook** button to send a sample notification and confirm that everything is working correctly
+- Run a test in Testomat.io and check that a notification with test results appears in your Telegram chat/channel/group
+
+![Telegram notification](./images/att3_telegram.png)

src/content/docs/integrations/report-notifications/images/att3_telegram.png

@@ -15,7 +15,7 @@ Templates in Testomat.io empower teams to work faster and more consistently by s
 :::note
 
 To ensure newly created **Notification Templates** are applied correctly, you must also create a new **Notification Rule**.  
-Without it, Slack or Microsoft Teams notifications will continue using the default message format with all supported variables.
+Without it, Slack, Telegram or Microsoft Teams notifications will continue using the default message format with all supported variables.
 
 Learn more: [How to create a Notification Rule](https://docs.testomat.io/integrations/report-notifications/rules/)
 
@@ -28,7 +28,7 @@ Learn more: [How to create a Notification Rule](https://docs.testomat.io/integra
 - **Code Template**: used to define the default code structure for automated tests with dynamic variables to simplify test automation;
 - **Defect Template**: used to automatically prefill the issue summary and description fields when reporting defects to integrations like Jira, GitHub, or Azure;
 - **Meta Template**: defines which meta-data keys are displayed in the Run Report View; it controls how data is shown and helps enrich report context;
-- **Notification Template (Slack / MS Teams)**: used to customize the structure and content of automated messages sent to Slack or Microsoft Teams after a test run is completed;
+- **Notification Template (Slack / MS Teams / Telegram)**: used to customize the structure and content of automated messages sent to Slack, Microsoft Teams, or Telegram after a test run is completed;
 
 :::note
 
@@ -55,7 +55,7 @@ Once the **Add template** sidebar opens,
 4. Fill in the following fields:
 
 - **Title** (required): enter a unique title and optionally add tags using @ syntax (e.g., @smoke);
-- **Type** (required): select the template type from the dropdown — **test** is selected by default, but you can change it to suite, defect, code, meta, notification-slack, or notification-ms-teams;
+- **Type** (required): select the template type from the dropdown — **test** is selected by default, but you can change it to suite, defect, code, meta, notification-slack, notification-telegram, or notification-ms-teams;
 - **Default** (optional): set this template as the default by clicking the **star icon**;
 
 :::note
@@ -527,7 +527,7 @@ In the Run Report View, the values corresponding to the keys defined in the temp
 
 Unlike other template types, **there is no manual option to select a Notification Template** during a test run or when sending report notifications.
 
-Once you have configured Slack or Microsoft Teams integration via the [Slack Notification](https://docs.testomat.io/integrations/report-notifications/slack/) or [MS Teams Notification](https://docs.testomat.io/integrations/report-notifications/ms-teams/), and created a **default** Notification Template, it will be automatically applied to all notifications triggered by your configured Notification Rules.
+Once you have configured [Slack Notification](https://docs.testomat.io/integrations/report-notifications/slack/), [MS Teams Notification](https://docs.testomat.io/integrations/report-notifications/ms-teams/), or [Telegram Notification](https://docs.testomat.io/integrations/report-notifications/telegram), and created a default Notification Template, it will be automatically applied to all notifications triggered by your configured Notification Rules.
 
 ![Notification Template](./images/att18_6270.png)