Вебхуки

ТестОпс позволяет отправлять уведомления о событиях внешним приложениям с помощью механизма вебхуков. При наступлении определенного события ТестОпс отправляет в указанную систему POST-запрос, содержащий текст сообщения с дополнительной информацией (например, количество успешно пройденных тестов в закрытом запуске).

Совет

С помощью вебхуков вы можете настроить отправку сообщений в ваш корпоративный мессенджер о завершении тестирования (закрытии запуска) или о появлении нового дефекта. Или вы можете отправлять информацию о пройденных тестах в сторонний инструмент визуализации данных для анализа.

Поддерживаются следующие события:

• создание и закрытие запусков;
• создание, закрытие и удаление дефектов;
• создание и удаление тест-планов.

Для настройки вебхука нужно указать URL-адрес системы, которая будет принимать сообщения, и выбрать события, при возникновении которых нужно отправлять сообщения.

Если после 10 попыток отправки сообщения ТестОпс не получает HTTP-статус 200 от внешней системы, вебхук автоматически отключается и помечается маркировкой Error. Чтобы восстановить работу вебхука, устраните причину отключения вебхука и включите его вручную.

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

Чтобы добавить вебхук:

1. Перейдите в раздел Настройки → Вебхуки.

2. Нажмите + Вебхук.

3. Введите название для вебхука (например, название стороннего приложения).

4. В поле Endpoint укажите URL-адрес, на который нужно отправлять сообщения.

5. Если нужно, нажмите + Заголовок, чтобы добавить дополнительные HTTP-заголовки, которые должны быть указаны в запросе. По умолчанию система добавляет HTTP-заголовок Content-Type: application/json. Он сообщает клиенту (внешней системе), что тело запроса будет передано в формате JSON.

6. Выберите нужные события для вебхука из выпадающего меню Триггер напротив нужной категории.

   Совет

   Чтобы создать вебхук для отправки сообщений о новых запусках и дефектах:

   1. Сначала нажмите Триггер напротив Запуски и выберите Создан.
   2. Затем нажмите Триггер напротив Дефекты и выберите Создан.

7. Настройте формат отправляемого сообщения для каждого выбранного события.

   Текст сообщения может содержать переменные, которые указываются с помощью фигурных скобок. При отправке сообщения каждая переменная будет заменена на соответствущее ей значение. Например, переменная projectName будет заменена на название проекта, в котором произошло событие.

   Чтобы добавить переменные в текст, нажмите иконку Переменные. Чтобы сбросить текст к предыдущему сохраненному состоянию, нажмите иконку Сбросить тело запроса.

8. Для запусков вы можете дополнительно указать фильтр, чтобы получать информацию только об определенных запусках.

9. Нажмите Протестировать, чтобы проверить отправку сообщений на указанный URL-адрес.

10. Нажмите Создать, чтобы завершить создание вебхука.

Формат сообщения

По умолчанию сообщения передаются в виде JSON-объектов следующего вида:

{
  "text": "Launch at 2024-10-01 22:21 closed by Ivan Ivanov in the project My Project"
}

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

Например, вы можете изменить структуру JSON-объекта:

{
  "user": "{{ createdBy }}",
  "date": "{{ createdDate }}",
  "text": "{{ launchName }} created"
}

Или настроить отправку сообщений простым текстом, без использования JSON:

{{ launchName }} closed by {{ closedBy }}

Список переменных, которые можно указать в сообщении:

Переменная	Описание
projectId	Идентификатор проекта
projectName	Название проекта
launchName	Название запуска
launchUrl	Ссылка на запуск
createdDate	Дата создания запуска в формате 2024-12-31 23:59:59
createdBy	Имя пользователя, создавшего запуск
closedBy	Имя пользователя, закрывшего запуск, или system, если запуск был закрыт автоматически
assigned	Имя пользователя, который был исполнителем в момент события
passedCount	Количество результатов тестов со статусом «Успешный»
failedCount	Количество результатов тестов со статусом «Неуспешный»
brokenCount	Количество результатов тестов со статусом «Сломанный»
skippedCount	Количество результатов тестов со статусом «Пропущенный»
unknownCount	Количество результатов тестов со статусом «Неизвестный»

Фильтрация запусков

При создании вебхука для запусков вы можете ограничить набор запусков, для которых будут отправляться сообщения. Для этого в поле Фильтры в настройках вебхука укажите один или несколько атрибутов для фильтрации:

1. Нажмите на поле ввода Фильтры.

2. Выберите атрибут для фильтрации запусков.

3. Выберите одно или несколько значений атрибута.

   Совет

   Чтобы отправлять сообщения только о запусках с определенным тегом:

   1. Выберите Тег.
   2. Введите название тега.
   3. Нажмите Enter.

   При указании нескольких значений для атрибута сообщения будут отправляться о запусках, которые содержат хотя бы одно из указанных значений.

Если фильтр содержит несколько условий (атрибутов), сообщения будут отправляться только о тех запусках, которые удовлетворяют всем условиям.

Совет

Если указать значение Firefox для атрибута Browser и значение Windows для атрибута OS, то под эти условия попадут запуски, в которых используется браузер Firefox и операционная система Windows одновременно.

Примеры настройки вебхуков

Примеры настройки описаны в гайдах:

• Настройка вебхуков в ТестОпс для Slack;
• Настройка вебхуков в ТестОпс для Telegram.