Настройка уведомлений в Telegram с помощью вебхуков

Вы можете получать уведомления из Test IT в чаты Telegram (группы и личные беседы). Количество чатов, в которые вы можете получать уведомления, не ограничено.

Настройка уведомлений включает в себя:

  1. Регистрация компании в чат-боте Test IT
  2. Добавление чат-бота в группу или личную беседу Telegram
  3. Создание / редактирование вебхука для чат-бота Telegram

Регистрация компании в чат-боте Test IT

Регистрация компании осуществляется в Telegram. В процессе регистрации используются команды, которые вводятся в чат Telegram (например /help). По окончании регистрации вы получите токен, который потребуется при создании или редактировании вебхука. Токен действует бессрочно.

Чтобы зарегистрировать компанию:

  1. В Telegram откройте чат-бота для уведомлений Test IT. Для этого в поле Поиск введите идентификатор чат-бота: идентификатор @testit_notifications_bot.
  2. Опционально: Для просмотра списка доступных команд используйте команду /help. Вы сможете задать требуемую команду, нажав на нее.
  3. В чате бота зарегистрируйте вашу компанию. Для этого используйте команду /register, затем введите название компании. В чате отобразится сообщение, содержащее запрос электронной почты.

    Внимание!

    С одного аккаунта Telegram вы можете зарегистрировать не более одной компании.

  4. Введите адрес электронной почты. В чате отобразится сообщение об успешной регистрации.
  5. Получите токен для авторизации бота (используется при создании вебхука) с помощью команды /getcompany. Скопируйте токен.

Добавление чат-бота в группу или личную беседу Telegram

Добавление чат-бота осуществляется в Telegram. В процессе используются команды, которые вводятся в чат Telegram (например /help).

Чтобы добавить чат-бота в группу или беседу:

  1. В чат-боте Test IT получите идентификатор чата с помощью команды /getchatid. Отобразится сообщение, содержащее идентификатор. Например, Chat ID: 908664085, где 908664085 — идентификатор.
  2. Скопируйте идентификатор чата и добавьте чат в зарегистрированную компанию. Для этого используйте команду /addchat, затем через пробел введите идентификатор чат-бота Test IT. Например: /addchat 908664085.
  3. Добавьте чат-бота в группу или личную беседу. Для этого:
    а. Откройте группу или личную беседу, в которую хотите добавить бота.
    б. Перейдите в настройки группы.
    в. Нажмите Добавить участников.
    г. Введите название бота: @testit_notifications_bot. Нажмите на него, затем нажмите ОК.
  4. Получите идентификатор группы или личной беседы, в которую хотите получать уведомление с помощью команды /getchatid. Отобразится сообщении о добавлении чата. Например: Chat ID: -918078093.

    Внимание!

    Если идентификатор чата содержит специальные символы, скопируйте их. Например, идентификатор “-918078093” содержит знак “-”, который необходимо скопировать.

  5. Добавьте чат-бота Test IT в группу или личную беседу. Для этого используйте команду /addchat, затем через пробел введите идентификатор чат-бота Test IT. Отобразится сообщение о добавлении чата.

Создание / редактирование вебхука для чат-бота Telegram

Для работы с Telegram вам потребуется создатьopen in new window новый вебхук или отредактироватьopen in new window уже существующий с учетом следующих особенностей:

  1. В поле URL укажите URL Telegram-сервиса Test IT: https://webhooks.testit.software/telegram
  2. В меню Тип запроса выберите POST
  3. В поле Заголовок HTTP укажите Authorization, в поле Значение введите токен для авторизации бота, полученный в чат-боте Test IT.
  4. В меню Тип контекста выберите Отправлять пользовательский контекст.
  5. В поле Пользовательский контекст введите запрос:
    а. В поле “message”, расположенном в теле запроса, введите текст сообщения, используя язык разметки HTMLopen in new window.
    б. В поле “parseMode“ укажите режим форматирования текста: HTML.
    в. В поле “chatIds” добавьте идентификаторы чатов, в которые хотите направлять уведомления. Вы можете добавить несколько идентификаторов. Если вы оставите поле “chatIds” пустым, уведомления будут направляться во все чаты, которые добавлены к компании. Если вы добавите идентификатор чата, не добавленного в компанию, уведомления в него приходить не будут.
    Пример запроса (развернуть)
    {
      "message": "<b>$TEST_PLAN_NAME</b> перешел в статус <b>$TEST_PLAN_STATUS</b>. \n Пользователь изменивший статус: <b>$USER_NAME</b>",
      "parseMode": "HTML",
      "chatIds": [
        908664085
      ]
    }
    
    После отправки сообщения в Telegram будет отправлено уведомление вида:
    Уведомление в Telegram от Test IT TMS, полученное через вебхук
  6. Завершите создание или редактирование вебхука.
    Уведомления будут приходить в чаты, определенные в пользовательском контексте.
Обновлено: