Получить информацию о вебхуке
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"
}Поля ответа
| Поле | Тип | Описание |
|---|---|---|
id | integer | Уникальный идентификатор вебхука |
active | boolean | Активен ли вебхук |
type | string | Тип вебхука |
events | array of strings | События, на которые реагирует вебхук |
config | object | Конфигурация вебхука |
created_at | string | Дата создания вебхука |
updated_at | string | Дата последнего обновления вебхука |
last_response_status | string | Статус последнего ответа от вебхука |
Поля конфигурации config
| Поле | Тип | Описание |
|---|---|---|
url | string | URL, на который будут отправляться вебхуки |
content_type | string | Тип контента |
http_method | string | HTTP метод для отправки |
authorization_header | string | Заголовок авторизации, который будет добавляться к запросам |
branch_filter | string | Фильтр событий по имени ветки (например, main или release/*) |
Формат ответа: application/vnd.gitverse.object+json;version=latest
Коды ответов
| Код | Статус | Описание |
|---|---|---|
200 | Ok | Запрос выполнен успешно, информация о вебхуке получена |
400 | Bad Request | Некорректные параметры запроса |
401 | Unauthorized | Необходима авторизация |
403 | Forbidden | Доступ запрещен |
404 | Not Found | Вебхук или репозиторий не найдены |
429 | Too Many Requests | Превышен лимит запросов |
500 | Internal Server Error | Внутренняя ошибка сервера |
Примечания
- убедитесь, что идентификатор вебхука корректен.