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

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

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

1. Откройте проект.
2. В навигационном меню слева нажмите Вебхуки.
3. Нажмите Создать.
4. Укажите основные параметры нового вебхука:
   • Событие — действие в системе, которое будет инициировать отправку вебхука (например Запуск автотестов и Изменение статуса тест-плана).
   • Название — имя вебхука, которое будет отображаться в списке вебхуков.
   • Описание — текстовое описание вебхука, для указания краткого комментария. Данное поле необязательно для заполнения.
5. Укажите параметры запроса HTTP:
   • URL — адрес внешней системы, на который будет отправлен HTTP запрос.
   • Тип запроса — тип запроса, отправляемого сервисом — POST, PUT или DELETE.
6. Укажите параметры, передаваемые в URL и заголовках запроса HTTP. В значениях параметров URL и заголовка используются специальные переменные, которые отправляют во внешнюю систему данные, связанные с конкретным событием. Список специальных переменных предопределен для каждого события, исходя из его контекста. Чтобы ознакомиться с переменными, смотрите Вебхук для запуска автотестов и Вебхук для изменения статуса тест-плана.
7. Опционально: Нажмите Проверить справа от поля URL, чтобы проверить доступность введенного URL-адреса.
8. Для POST и PUT запросов настройте передачу тела запроса. В поле Тип контекста выберите одну из опций:
   • Отправлять стандартный контекст — передает предопределенную для события модель данных. Примеры стандартных контекстов для разных событий:
     • Пример для запуска автотестов
     • Пример для изменения статуса тест-планов
   • Отправлять пользовательский контекст — позволяет включить следующие опции:
     • Заменить системные параметры — заменяет в теле отправляемого запроса системные параметры, вводимые через $, на ассоциирующиеся с ними переменные. Например, при вводе параметра $BUILD, в теле запроса выводится номер сборки, для которой произошло событие вебхука.
     • Экранировать параметры — экранирует escape-последовательности в теле HTTP. Например, если параметру $PROJECT_NAME присваивается значение dev\new, \n в теле запроса без экранирования параметров будет прочитано как escape-последовательность, и будет отображаться как новая строка. При экранировании параметров escape-последовательности отображаются как текст.
   • Не отправлять контекст
9. Нажмите Сохранить.
   Созданный вебхук отображается в списке на вкладке Вебхуки.

Получение массива данных

Вы можете настроить вебхук на передачу массива данных для событий:

• Остановка тест-рана
• Прохождение всех автотестов

Чтобы настроить вебхук на передачу массива данных:

1. Начните создавать вебхук. В Шаге 1 в меню Событие выберите Остановка тест-рана или Прохождение всех автотестов.
2. В Шаге 2 в меню Тип Запроса выберите POST или PUT.
3. Заполните данные в шагах 3-4 в соответствии с вашими требованиями.
4. В Шаге 5 укажите следующее:
   • В меню Тип контекста выберите Отправлять пользовательский контекст.
   • Отметьте флажками пункты Заменить системные параметры и Экранировать параметры.
   • В поле Пользовательский контекст введите символ $, затем в выпадающем меню выберите параметр AUTOTEST_IDS.
     
5. Нажмите Сохранить. При наступлении выбранного события вебхук будет передавать массив данных.

Отслеживание логов

Вы можете посмотреть логи всех запущенных системой вебхуков за последние 7 дней. Для этого перейдите в раздел Журнал вебхуков.

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

1. Откройте проект.
2. В навигационном меню слева нажмите Вебхуки.
3. Найдите вебхук, который хотите удалить, в общем списке.
4. В колонке Действия откройте меню, нажав значок Действия и выберите необходимое действие — Редактировать или Удалить.
5. Сохраните изменения.