Вебхуки

Вебхуки — это механизм автоматической отправки событий во внешние системы (например, в чат, трекер задач или внутренний сервис компании) сразу после действия в системе.

Вебхуки нужны в следующих ситуациях:

• Автоматически сообщать о важных изменениях в проекте.
• Запускать внешние сценарии после событий (например, скрипты обработки).
• Связывать систему с корпоративными системами без ручного копирования данных.

Страница вебхуков

Чтобы перейти к разделу вебхуков:

1. Откройте страницу проекта.
2. Перейдите в раздел "Вебхуки", нажав соответствующую кнопку.

В таблице вебхуков представлены следующие сведения:

• Название — название вебхука и URL-адрес
• Метод — тип действия, которое выполнит вебхук при вызове
• События — список триггеров, которые должны вызывать отправку
• Статус — установленный статус вебхука
• Последний запуск — дата и время последнего запуска вебхука
• Действия — поле быстрых действий вебхуков

Быстрые действия вебхуков

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

• Тестировать (1) — будет отправлен тестовый запрос на указанный в вебхуке URL-адрес. Подробнее о тестировании вебхука читайте в разделе Тестовая отправка вебхука.
• Редактировать (2) — откроется страница изменения вебхука. Подробнее об имеющихся полях вебхука читайте в разделе Создание вебхука.
• Удалить (3) — вебхук будет безвозвратно удален из системы после подтверждения. Подробнее об удалении вебхуков читайте в разделе Удаление вебхука.

Для выполнения быстрого действия необходимо кликнуть по соответствующей кнопке.

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

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

Внесите информацию в поля:

• Название* — понятное название вебхука
• URL* — адрес внешнего сервиса, куда отправляются события
• HTTP Метод* — HTTP-глагол, которым платформа обращается к внешнему сервису при срабатывании вебхука
• События* — список триггеров, которые должны вызывать отправку
• Заголовки — служебная информация о запросе
• Тело запроса — информация о событии

, где "*" — обязательное для заполнения поле.

Для заполнения поля "HTTP Метод" выберите одно значение в выпадающем списке.

Для заполнения поля "События" выберите одно или несколько значений в выпадающем списке.

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

Для подтверждения или отмены изменений нажмите соответствующую кнопку.

Тестовая отправка вебхука

Для тестирования вебхука необходимо:

1. Перейти в раздел "Проекты" и выбрать необходимый проект.
2. Открыть на странице проекта раздел "Вебхуки".
3. В списке вебхуков выбрать нужный.
4. В строке быстрых действий нажать "Тестировать".

Для проверки успешности отправки убедитесь, что в логах вебхука появился успешный результат, и проверьте прием события на стороне внешней системы.

История отправок

Для просмотра логов по вебхукам нажмите на вкладку "История отправок".

В разделе логов можно проверить:

• Время — дата и время отправки запроса
• Событие — название события
• URL — адрес внешнего сервиса, на который отправляются запросы
• Метод — тип запроса, которым вебхук отправлял данные
• Статус — статус выполнения запроса
• Длительность — время выполнения запроса

Для просмотра полей "Тело запроса" и "Тело ответа" нажмите на значок плюсика, расположенный в строке соответствующей записи.

Если отправка неуспешна, необходимо:

1. Проверить URL.
2. Проверить доступность внешнего сервиса.
3. Сверить ожидаемый формат данных на стороне получателя.
4. При необходимости повторить отправку после исправлений.

Справка

Для просмотра справочной информации по вебхукам нажмите на вкладку "Справка".

Для просмотра сведений по определенному блоку кликните по соответствующему заголовку — откроется подробная информация.

Доступные переменные для шаблонов

Блок содержит список переменных, которые можно использовать в теле запроса и заголовках.

Примеры шаблонов

Блок содержит примеры шаблонов запросов для Jenkins, GitLab, Telegram, а также пример со ссылками на проект и тест-ран.

Ограничения

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

Удаление вебхука

Для удаления вебхука на странице со списком нажмите "Удалить" в строке быстрых действий соответствующего вебхука и подтвердите действие в модальном окне.

Возможные ошибки

Основные категории ошибок при работе с вебхуками:

• Ошибка соединения — проверьте DNS, firewall, прокси и доступность адреса.
• 401 или 403 — неверный ключ доступа или недостаточно прав на стороне получателя.
• 415 или 422 — получатель не принимает формат данных.
• Случайные сбои — проверьте таймауты и повторные попытки.

Если вебхук не работает, проверьте сеть и авторизацию. При необходимости проверьте внутреннюю логику события.