Публичный APIВебхуки3. GET /repos/{owner}/{repo}/hooks/{hook_id} — получить информацию о вебхуке

3. GET /repos/{owner}/{repo}/hooks/{hook_id} — получить информацию о вебхуке

Описание

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

Параметры URL:

ПараметрОбязательныйОписание
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"

Требования

Убедитесь, что ключ API указан корректно и обладает необходимыми правами для доступа к репозиторию:
Репозитории -> Чтение.

Ответ (200 OK):

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

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

Поля ответа:

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

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

ПолеТипОписание
urlstringURL, на который будут отправляться вебхуки
content_typestringТип контента
secretstringСекретный ключ для подписи запросов

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

Коды ответов

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

Примечания:

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

Вы нашли что искали?