Вебхуки

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

Совет

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

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

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

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

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

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

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

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

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

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

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

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

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

   Пример

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

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

7. Заполните поля для каждого выбранного события:

   1. В поле Тело запроса настройте формат отправляемого сообщения.

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

      1. Нажмите на поле фильтрации запусков.

      2. Выберите тип метаданных для фильтрации.

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

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

      Примечание

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

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

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

8. Нажмите Создать.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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