Действия с вебхук-триггерами

Вебхук-триггеры позволяют автоматически запускать проверки безопасности в TRON ASOC при наступлении определенных событий (например, сразу после пуша (git push) или создании merge/pull request) в системе управления исходным кодом (VCS).

Список поддерживаемых VCS и событий, при которых запускаются проверки, представлен в разделе Webhook-триггеры.

Создание вебхук-триггера

Чтобы создать вебхук-триггер, выполните следующие шаги:

1. Перейдите в раздел Webhook-триггеры.
2. Нажмите кнопку Добавить webhook-триггер.
3. В открывшемся окне укажите следующие данные:
   • название вебхук-триггера;
   • описание вебхук-триггера;
   • проект, для которого создается вебхук-триггер;
   • тип VCS;
   • события, при наступлении которых будет срабатывать вебхук-триггер (Push, MR);
   • область действия вебхук-триггера (слои, проверки безопасности).
4. Нажмите кнопку Добавить webhook-триггер.

Также можно создать новый вебхук-триггер из проекта. Для этого выполните следующие шаги:

1. Перейдите в раздел Проекты.
2. Выберите требуемый проект.
3. Перейдите во вкладку Webhook-триггеры.
4. Нажмите кнопку Добавить webhook-триггер.
5. Выполните шаг 3 из предыдущей инструкции.
6. Нажмите кнопку Добавить webhook-триггер.

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

URL вебхука имеет следующий формат: https://<URL вашего TRON.ASOC>/api/v1/webhooks/vcs/<ID интеграции>?token=<TOKEN>. В качестве значения <TOKEN> подставьте ваш API-токен, созданный в TRON.ASOC. Подробнее о создании API-токена см. в разделе Создание API-токена.

danger

URL вебхука отображается только один раз после создания вебхук-триггера.

Также созданный вебхук-триггер будет отображаться в списке триггеров в разделе Webhook-триггеры.

Добавление вебхук-триггера в репозиторий

Чтобы добавить вебхук-триггер в репозиторий, выполните следующие шаги:

1. Авторизуйтесь в VCS (GitHub, GitLab, Bitbucket и т.д.), в которой расположен ваш репозиторий.
2. В настройках вашего репозитория перейдите в раздел Webhooks.
3. Введите URL, полученный ранее при создании вебхук-триггера.
4. Выберите тип контента application/json.
5. Вставьте секрет в поле для проверки подписи (Secret/Token).
6. Отметьте типы событий, соответствующие выбранным при создании вебхук-триггера (push, merge request, pull request и т.д.).
7. Сохраните вебхук.

После сохранения VCS будет отправлять POST-запросы на эндпоинт TRON.ASOC при наступлении указанных событий.

Редактирование вебхук-триггера

Чтобы отредактировать вебхук-триггер, выполните следующие шаги:

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

После этого данные вебхук-триггера будут обновлены, при этом URL вебхука останется без изменений.

Удаление вебхук-триггера

Чтобы удалить один вебхук-триггер, выполните следующие шаги:

1. Нажмите кнопку дополнительных действий () возле необходимого вебхук-триггера.
2. Выберите вариант Удалить.
3. В открывшемся модальном окне подтвердите удаление вебхук-триггера.

Вебхук-триггер будет удален из системы и перестанет отображаться в списке вебхук-триггеров в разделе Webhook-триггеры.

Чтобы удалить несколько вебхук-триггеров, выполните следующие шаги:

1. Выберите необходимые вебхук-триггеры с помощью чекбоксов ().
2. Нажмите кнопку удаления () над таблицей вебхук-триггеров.
3. В открывшемся модальном окне подтвердите удаление вебхук-триггеров.

Вебхук-триггеры будут удалены из системы и перестанут отображаться в списке в разделе Webhook-триггеры.