Перейти к содержанию

Вебхуки


Введение

Вебхуки позволяют создавать или настраивать интеграции для приложения OAuth, которые подписываются на определенные события на GitFlic. Когда происходит одно из обозначенных событий, отправляются данные на настроенный URL-адрес вебхука. Вебхуки можно использовать для обновления внешнего сервиса, обновления резервного зеркала или даже для развертывания на рабочем сервере. Вы можете использовать вебхуки любым способом по своему усмотрению.

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

Для создания нового вебхука нажмите кнопку Создать.

Обязательным полем для заполнения является URL для отправки данных. Заполнение других полей является опциональным. Возле поля с URL находится кнопка Проверить. Она отсылает тестовый POST-запрос на указанный URL и возвращает ответ 200 - Успешно или 404 - Ошибка клиента.

Присутствует возможность указать секрет вебхука в соответствующем поле. Секрет приходит в заголовке Gitflic-Webhook-Secret. Токен, указанный при создании вебхука, приходит в заголовке Authorization.

Поле для wildcard шаблона позволяет указать список веток. Разделение между шаблонами происходит с помощью :. Только для указанных веток будут приходить вебхуки на следующие события:

  • Создание ветки
  • Обновление ветки
  • Создание тега
  • Удаление тега
  • Новый конвейер
  • Успешный конвейер
  • Ошибка конвейера

Для вебхуков доступны следующие события:

  • Обновление проблемы
  • Удаление тега
  • Комментарий к дискуссии в запросах на слияние
  • Добавление участника
  • Одобрение запроса на слияние
  • Обновление ветки
  • Удаление участника из проекта
  • Создание новой проблемы
  • Отмена запроса на слияние
  • Слияние
  • Обновление прав участника
  • Дискуссии в запросах на слияние
  • Новый конвейер
  • Создание тега
  • Новый запрос на слияние
  • Закрытие запроса на слияние
  • Ошибка конвейера
  • Удаление ветки
  • Обновление запроса на слияние
  • Успешный конвейер
  • Новый комментарий к проблеме
  • Создание ветки

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

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