Настройка вебхуков

Механизм вебхуков используется для передачи данных о действии или событии между двумя сервисами. Test IT использует вебхуки для интеграций с мессенджерами и CI/CD системами. Для настройки вебхуков вам необходимо обладать проектной ролью ProjectAdmin или другой ролью с правами доступа на редактирование проекта Полный доступ.

Создание вебхуков

1. Откройте настройки проекта.

2. Перейдите на вкладку Вебхуки.

3. Нажмите Новый вебхук.

   1. Укажите следующие параметры:

      • Название - имя вебхука, которое будет отображаться в списке вебхуков.
      • Описание - текстовое описание вебхука, для указания краткого комментария.
      • Событие - действие в системе, которое будет инициировать отправку вебхука. Вы можете настроить вебхуки для двух типов событий: Запуск автотестов и Изменение статуса тест-плана.

      

      • URL - адрес внешней системы, на который будет отправлен HTTP запрос.
      • Тип запроса - тип запроса, отправляемого сервисом - POST, PUT или DELETE.
      • Заголовки HTTP и Параметры URL - параметры, передаваемые вебхуком. В значениях заголовков и query параметров можно использовать специальные переменные, чтобы отправлять во внешнюю систему данные, связанные с конкретным событием. Чтобы ввести параметр, напечатайте $ и выберите необходимый параметр для вашего события из выпадающего списка.
        Список специальных переменных предопределен для каждого события исходя из его контекста. Специальные переменные, доступные для подстановки, можно увидеть в инструкции и подсказках. Чтобы узнать больше, смотрите Вебхук для запуска автотестов и Вебхук для изменения статуса тест-плана.

      

4. Для POST и PUT запросов настройте передачу тела запроса. В поле Тело запроса выберите одну из опций:

   • Отправлять стандартный контекст - передает предопределенную для события модель данных. Вы можете найти примеры стандартных контекстов для разных событий здесь:
     • Пример для запуска автотестов
     • Пример для изменения статуса тест-планов
   • Отправлять свой контекст - позволяет включить следующие опции:

     • Заменить системные параметры - заменяет в теле отправляемого запроса системные параметры, вводимые через $, на ассоциирующиеся с ними переменные. Например, при вводе параметра $BUILD, в теле запроса выводится номер сборки, для которой произошло событие вебхука.

     • Экранировать параметры - экранирует escape-последовательности в теле HTTP. Например, если параметру $PROJECT_NAME присваивается значение dev\new, \n в теле запроса без экранирования параметров будет прочитано как escape-последовательность, и будет отображаться как новая строка.

       

       При экранировании параметров escape-последовательности отображаются как текст.

       

   • Не отправлять.

5. Сохраните вебхук, нажав Новый вебхук.

   

Редактирование и удаление

1. Откройте настройки проекта.
   
2. Перейдите на вкладку Вебхуки.
3. Раскройте вебхук, который хотите редактировать или удалить. Отредактируйте необходимые поля.
4. Нажмите Сохранить или Удалить в правом нижнем углу окна вебхука.