Поддержка этой версии GitHub Enterprise будет прекращена 2023-03-15. Исправления выпускаться не будут даже при критических проблемах безопасности. Для повышения производительности, укрепления безопасности и новых функций установите последнюю версию GitHub Enterprise. Чтобы получить справку по обновлению, обратитесь в службу поддержки GitHub Enterprise.

We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the Actions REST API page.

Глобальные веб-перехватчики

Используйте REST API для управления глобальными веб-перехватчиками для вашего предприятия.

Сведения о глобальных веб-перехватчиках

Эти конечные точки доступны только администраторам сайта, прошедшим проверку подлинности . Обычные пользователи получат 404 ответ. Сведения о настройке глобальных веб-перехватчиков см. в разделе Сведения о глобальных веб-перехватчиках.

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

Глобальные веб-перехватчики могут подписаться на такие типы событий, как организация, пользователь, репозиторий, команда, член, членство, вилка и проверка связи.

List global webhooks

Параметры

Заголовки
Имя, Тип, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Параметры запроса
Имя, Тип, Описание
`per_page`integer The number of results per page (max 100). Значение по умолчанию: `30`
`page`integer Page number of the results to fetch. Значение по умолчанию: `1`

Коды состояния HTTP-ответа

Код состояния	Описание
`200`	OK

Примеры кода

get/admin/hooks

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/hooks

Response

Status: 200

[
  {
    "type": "Global",
    "id": 1,
    "name": "web",
    "active": true,
    "events": [
      "organization",
      "user"
    ],
    "config": {
      "url": "https://example.com",
      "content_type": "json",
      "insecure_ssl": "0",
      "secret": "********"
    },
    "updated_at": "2017-12-07T00:14:59Z",
    "created_at": "2017-12-07T00:14:59Z",
    "url": "https://api.github.com/admin/hooks/1",
    "ping_url": "https://api.github.com/admin/hooks/1/pings"
  }
]

Create a global webhook

Параметры

Заголовки

Имя, Тип, Описание

acceptstring

Setting to application/vnd.github+json is recommended.

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

Имя, Тип, Описание

namestringОбязательно

Must be passed as "web".

configobjectОбязательно

Key/value pairs to provide settings for this webhook.

Properties of config

Имя, Тип, Описание
`url`stringОбязательно The URL to which the payloads will be delivered.
`content_type`string The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.
`secret`string If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the `X-Hub-Signature` header.
`insecure_ssl`string Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.

eventsarray of strings

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

activeboolean

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

Значение по умолчанию: true

Коды состояния HTTP-ответа

Код состояния	Описание
`201`	Created

Примеры кода

post/admin/hooks

curl \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/hooks \
  -d '{"name":"web","events":["organization","user"],"config":{"url":"https://example.com/webhook","content_type":"json","secret":"secret"}}'

Response

Status: 201

{
  "type": "Global",
  "id": 1,
  "name": "web",
  "active": true,
  "events": [
    "organization",
    "user"
  ],
  "config": {
    "url": "https://example.com",
    "content_type": "json",
    "insecure_ssl": "0",
    "secret": "********"
  },
  "updated_at": "2017-12-07T00:14:59Z",
  "created_at": "2017-12-07T00:14:59Z",
  "url": "https://api.github.com/admin/hooks/1",
  "ping_url": "https://api.github.com/admin/hooks/1/pings"
}

Get a global webhook

Параметры

Заголовки
Имя, Тип, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`hook_id`integerОбязательно The unique identifier of the hook.

Коды состояния HTTP-ответа

Код состояния	Описание
`200`	OK

Примеры кода

get/admin/hooks/{hook_id}

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/hooks/HOOK_ID

Response

Status: 200

{
  "type": "Global",
  "id": 1,
  "name": "web",
  "active": true,
  "events": [
    "organization",
    "user"
  ],
  "config": {
    "url": "https://example.com",
    "content_type": "json",
    "insecure_ssl": "0",
    "secret": "********"
  },
  "updated_at": "2017-12-07T00:14:59Z",
  "created_at": "2017-12-07T00:14:59Z",
  "url": "https://api.github.com/admin/hooks/1",
  "ping_url": "https://api.github.com/admin/hooks/1/pings"
}

Update a global webhook

Parameters that are not provided will be overwritten with the default value or removed if no default exists.

Параметры

Заголовки

Имя, Тип, Описание

acceptstring

Setting to application/vnd.github+json is recommended.

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

Имя, Тип, Описание

hook_idintegerОбязательно

The unique identifier of the hook.

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

Имя, Тип, Описание

configobject

Key/value pairs to provide settings for this webhook.

Properties of config

Имя, Тип, Описание
`url`stringОбязательно The URL to which the payloads will be delivered.
`content_type`string The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.
`secret`string If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the `X-Hub-Signature` header.
`insecure_ssl`string Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.

eventsarray of strings

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

activeboolean

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

Значение по умолчанию: true

Коды состояния HTTP-ответа

Код состояния	Описание
`200`	OK

Примеры кода

patch/admin/hooks/{hook_id}

curl \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/hooks/HOOK_ID \
  -d '{"events":["organization"],"config":{"url":"https://example.com/webhook"}}'

Response

Status: 200

{
  "type": "Global",
  "id": 1,
  "name": "web",
  "active": true,
  "events": [
    "organization"
  ],
  "config": {
    "url": "https://example.com",
    "content_type": "form",
    "insecure_ssl": "0"
  },
  "updated_at": "2017-12-07T00:14:59Z",
  "created_at": "2017-12-07T00:14:59Z",
  "url": "https://api.github.com/admin/hooks/1",
  "ping_url": "https://api.github.com/admin/hooks/1/pings"
}

Delete a global webhook

Параметры

Заголовки
Имя, Тип, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`hook_id`integerОбязательно The unique identifier of the hook.

Коды состояния HTTP-ответа

Код состояния	Описание
`204`	No Content

Примеры кода

delete/admin/hooks/{hook_id}

curl \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/hooks/HOOK_ID

Response

Status: 204

Ping a global webhook

This will trigger a ping event to be sent to the webhook.

Параметры

Заголовки
Имя, Тип, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`hook_id`integerОбязательно The unique identifier of the hook.

Коды состояния HTTP-ответа

Код состояния	Описание
`204`	No Content

Примеры кода

post/admin/hooks/{hook_id}/pings

curl \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/hooks/HOOK_ID/pings

Response

Status: 204

Jan	FEB	Mar
	04
2022	2023	2024