Вебхуки

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

Этот раздел Public API GitVerse позволяет создавать, получать информацию, обновлять и удалять вебхуки для репозитория.

Работа с вебхуками

Публичный API GitVerse предоставляет следующие методы для управления вебхуками:

• GET /repos/{owner}/{repo}/hooks — возвращает список всех вебхуков репозитория. Используйте этот метод, чтобы увидеть все настроенные вебхуки;

• POST /repos/{owner}/{repo}/hooks — создает новый вебхук для репозитория. При создании нужно указать URL для отправки уведомлений, список событий и параметры конфигурации;

• GET /repos/{owner}/{repo}/hooks/{hook_id} — возвращает информацию о конкретном вебхуке по его идентификатору. Полезно для проверки настроек вебхука;

• PATCH /repos/{owner}/{repo}/hooks/{hook_id} — обновляет информацию о вебхуке (payload URL, события, активное состояние). Позволяет изменить настройки без пересоздания вебхука;

• DELETE /repos/{owner}/{repo}/hooks/{hook_id} — удаляет вебхук из репозитория. После удаления вебхук перестанет отправлять уведомления.

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

При работе с API вебхуков могут возникать следующие ошибки:

Код	Описание
400 Bad Request	Некорректный формат данных. Проверьте структуру тела запроса и параметры.
401 Unauthorized	Необходима авторизация. Проверьте заголовок Authorization и токен доступа.
403 Forbidden	Недостаточно прав. Убедитесь, что у вас есть права администратора репозитория.
404 Not Found	Репозиторий или вебхук не найдены. Проверьте параметры пути.
429 Too Many Requests	Превышен лимит запросов. Повторите запрос позже.
500 Internal Server Error	Внутренняя ошибка сервера. Обратитесь в поддержку GitVerse.