Конфигурация веб-перехватчика репозитория

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

Get a webhook configuration for a repository

Работа с GitHub Apps

Returns the webhook configuration for a repository. To get more information about the webhook, including the active state and events, use "Get a repository webhook."

Access tokens must have the read:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:read permission.

Параметры

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

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

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

Примеры кода

get/repos/{owner}/{repo}/hooks/{hook_id}/config

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

Response

Status: 200

{
  "content_type": "json",
  "insecure_ssl": "0",
  "secret": "********",
  "url": "https://example.com/webhook"
}

Update a webhook configuration for a repository

Работа с GitHub Apps

Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use "Update a repository webhook."

Access tokens must have the write:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:write permission.

Параметры

Заголовки
Имя, Тип, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`owner`stringОбязательно The account owner of the repository. The name is not case sensitive.
`repo`stringОбязательно The name of the repository. The name is not case sensitive.
`hook_id`integerОбязательно The unique identifier of the hook.
Параметры запроса
Имя, Тип, Описание
`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 for delivery signature headers.
`insecure_ssl`string or number 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.

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

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

Примеры кода

patch/repos/{owner}/{repo}/hooks/{hook_id}/config

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

Response

Status: 200

{
  "content_type": "json",
  "insecure_ssl": "0",
  "secret": "********",
  "url": "https://example.com/webhook"
}