Получить информацию о вебхуке

GET /repos/{owner}/{repo}/hooks/{hook_id}

Описание

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

Токен

Требуется токен с правами на Чтение для Репозитория.

Заголовки

ПараметрОбязательныйОписание
AuthorizationДаЗаголовок авторизации. Формат: Bearer <token>
AcceptНетТип содержимого ответа. Рекомендуется установить значение application/vnd.gitverse.object+json;version=latest

Параметры пути

ПараметрОбязательныйОписание
ownerДаИмя владельца репозитория
repoДаНазвание репозитория
hook_idДаИдентификатор вебхука

Параметры запроса

Данный метод не требует параметров запроса.

Тело запроса

Данный метод не требует тела запроса.

Пример запроса

curl -X GET "https://api.gitverse.ru/repos/myuser/myrepo/hooks/123" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/vnd.gitverse.object+json;version=latest"

Ответ (200 OK)

Возвращает информацию о вебхуке.

{
  "id": 123,
  "active": true,
  "type": "web",
  "events": [
    "push",
    "pull_request"
  ],
  "config": {
    "url": "https://example.com/webhook",
    "content_type": "json",
    "http_method": "POST",
    "authorization_header": "",
    "branch_filter": ""
  },
  "created_at": "2023-01-01T00:00:00Z",
  "updated_at": "2023-01-01T00:00:00Z",
  "last_response_status": "200"
}

Поля ответа

ПолеТипОписание
idintegerУникальный идентификатор вебхука
activebooleanАктивен ли вебхук
typestringТип вебхука
eventsarray of stringsСобытия, на которые реагирует вебхук
configobjectКонфигурация вебхука
created_atstringДата создания вебхука
updated_atstringДата последнего обновления вебхука
last_response_statusstringСтатус последнего ответа от вебхука

Поля конфигурации config

ПолеТипОписание
urlstringURL, на который будут отправляться вебхуки
content_typestringТип контента
http_methodstringHTTP метод для отправки
authorization_headerstringЗаголовок авторизации, который будет добавляться к запросам
branch_filterstringФильтр событий по имени ветки (например, main или release/*)

Формат ответа: application/vnd.gitverse.object+json;version=latest

Коды ответов

КодСтатусОписание
200OkЗапрос выполнен успешно, информация о вебхуке получена
400Bad RequestНекорректные параметры запроса
401UnauthorizedНеобходима авторизация
403ForbiddenДоступ запрещен
404Not FoundВебхук или репозиторий не найдены
429Too Many RequestsПревышен лимит запросов
500Internal Server ErrorВнутренняя ошибка сервера

Примечания

  • убедитесь, что идентификатор вебхука корректен.