Skip to main content
REST API теперь версия. Дополнительные сведения см. в разделе "О управлении версиями API".

Веб-перехватчики организации

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

Сведения о веб-перехватчиках организации

Веб-перехватчики организации позволяют серверу получать полезные данные HTTP POST при каждом возникновении определенных событий в организации. Дополнительные сведения см. в разделе «AUTOTITLE».

Область действия и ограничения

Вы должны быть владелец организации для использования этих конечных точек. Маркеры OAuth требуют admin:org_hook использования этих конечных точек область.

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

  • OAuth apps не может перечислять, просматривать или изменять веб-перехватчики, которые они не создали.
  • Пользователи не могут перечислять, просматривать или изменять веб-перехватчики, созданные OAuth apps.

List organization webhooks

Подробные маркеры доступа для "List organization webhooks

Эта конечная точка работает со следующими типами маркеров:

Маркер должен иметь следующий набор разрешений.:

  • organization_hooks:read

Параметры для "List organization webhooks"

Заголовки
Имя., Тип, Description
accept string

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

Параметры пути
Имя., Тип, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

Параметры запроса
Имя., Тип, Description
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

По умолчанию.: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

По умолчанию.: 1

Коды состояния http-ответа для "List organization webhooks"

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

OK

404

Resource not found

Примеры кода для "List organization webhooks"

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

get/orgs/{org}/hooks
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/hooks

Response

Status: 200
[ { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", "name": "web", "events": [ "push", "pull_request" ], "active": true, "config": { "url": "http://example.com", "content_type": "json" }, "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "type": "Organization" } ]

Create an organization webhook

Here's how you can create a hook that posts payloads in JSON format:

Подробные маркеры доступа для "Create an organization webhook

Эта конечная точка работает со следующими типами маркеров:

Маркер должен иметь следующий набор разрешений.:

  • organization_hooks:write

Параметры для "Create an organization webhook"

Заголовки
Имя., Тип, Description
accept string

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

Параметры пути
Имя., Тип, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

Параметры запроса
Имя., Тип, Description
name string Обязательное поле

Must be passed as "web".

config object Обязательное поле

Key/value pairs to provide settings for this webhook.

Имя., Тип, Description
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.

username string
password string
events array of strings

Determines what events the hook is triggered for. Set to ["*"] to receive all possible events.

По умолчанию.: ["push"]

active boolean

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

По умолчанию.: true

Коды состояния http-ответа для "Create an organization webhook"

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

Created

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Примеры кода для "Create an organization webhook"

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

post/orgs/{org}/hooks
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/hooks \ -d '{"name":"web","active":true,"events":["push","pull_request"],"config":{"url":"http://example.com/webhook","content_type":"json"}}'

Response

Status: 201
{ "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", "name": "web", "events": [ "push", "pull_request" ], "active": true, "config": { "url": "http://example.com", "content_type": "json" }, "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "type": "Organization" }

Get an organization webhook

Returns a webhook configured in an organization. To get only the webhook config properties, see "Get a webhook configuration for an organization."

Подробные маркеры доступа для "Get an organization webhook

Эта конечная точка работает со следующими типами маркеров:

Маркер должен иметь следующий набор разрешений.:

  • organization_hooks:read

Параметры для "Get an organization webhook"

Заголовки
Имя., Тип, Description
accept string

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

Параметры пути
Имя., Тип, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

hook_id integer Обязательное поле

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Коды состояния http-ответа для "Get an organization webhook"

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

OK

404

Resource not found

Примеры кода для "Get an organization webhook"

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

get/orgs/{org}/hooks/{hook_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/hooks/HOOK_ID

Response

Status: 200
{ "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", "name": "web", "events": [ "push", "pull_request" ], "active": true, "config": { "url": "http://example.com", "content_type": "json" }, "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "type": "Organization" }

Update an organization webhook

Updates a webhook configured in an organization. When you update a webhook, the secret will be overwritten. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use "Update a webhook configuration for an organization."

Подробные маркеры доступа для "Update an organization webhook

Эта конечная точка работает со следующими типами маркеров:

Маркер должен иметь следующий набор разрешений.:

  • organization_hooks:write

Параметры для "Update an organization webhook"

Заголовки
Имя., Тип, Description
accept string

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

Параметры пути
Имя., Тип, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

hook_id integer Обязательное поле

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Параметры запроса
Имя., Тип, Description
config object

Key/value pairs to provide settings for this webhook.

Имя., Тип, Description
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.

events array of strings

Determines what events the hook is triggered for.

По умолчанию.: ["push"]

active boolean

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

По умолчанию.: true

name string

Коды состояния http-ответа для "Update an organization webhook"

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

OK

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Примеры кода для "Update an organization webhook"

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

patch/orgs/{org}/hooks/{hook_id}
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/hooks/HOOK_ID \ -d '{"active":true,"events":["pull_request"]}'

Response

Status: 200
{ "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", "name": "web", "events": [ "pull_request" ], "active": true, "config": { "url": "http://example.com", "content_type": "json" }, "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "type": "Organization" }

Delete an organization webhook

Подробные маркеры доступа для "Delete an organization webhook

Эта конечная точка работает со следующими типами маркеров:

Маркер должен иметь следующий набор разрешений.:

  • organization_hooks:write

Параметры для "Delete an organization webhook"

Заголовки
Имя., Тип, Description
accept string

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

Параметры пути
Имя., Тип, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

hook_id integer Обязательное поле

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Коды состояния http-ответа для "Delete an organization webhook"

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

No Content

404

Resource not found

Примеры кода для "Delete an organization webhook"

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

delete/orgs/{org}/hooks/{hook_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/hooks/HOOK_ID

Response

Status: 204

Get a webhook configuration for an organization

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

OAuth app tokens and personal access tokens (classic) need the admin:org_hook scope to use this endpoint.

Подробные маркеры доступа для "Get a webhook configuration for an organization

Эта конечная точка работает со следующими типами маркеров:

Маркер должен иметь следующий набор разрешений.:

  • organization_hooks:read

Параметры для "Get a webhook configuration for an organization"

Заголовки
Имя., Тип, Description
accept string

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

Параметры пути
Имя., Тип, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

hook_id integer Обязательное поле

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Коды состояния http-ответа для "Get a webhook configuration for an organization"

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

OK

Примеры кода для "Get a webhook configuration for an organization"

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

get/orgs/{org}/hooks/{hook_id}/config
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/hooks/HOOK_ID/config

Response

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

Update a webhook configuration for an organization

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

OAuth app tokens and personal access tokens (classic) need the admin:org_hook scope to use this endpoint.

Подробные маркеры доступа для "Update a webhook configuration for an organization

Эта конечная точка работает со следующими типами маркеров:

Маркер должен иметь следующий набор разрешений.:

  • organization_hooks:write

Параметры для "Update a webhook configuration for an organization"

Заголовки
Имя., Тип, Description
accept string

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

Параметры пути
Имя., Тип, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

hook_id integer Обязательное поле

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Параметры запроса
Имя., Тип, Description
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-ответа для "Update a webhook configuration for an organization"

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

OK

Примеры кода для "Update a webhook configuration for an organization"

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

patch/orgs/{org}/hooks/{hook_id}/config
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/hooks/HOOK_ID/config \ -d '{"url":"http://example.com/webhook","content_type":"json","insecure_ssl":"0","secret":"********"}'

Response

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

List deliveries for an organization webhook

Returns a list of webhook deliveries for a webhook configured in an organization.

Подробные маркеры доступа для "List deliveries for an organization webhook

Эта конечная точка работает со следующими типами маркеров:

Маркер должен иметь следующий набор разрешений.:

  • organization_hooks:read

Параметры для "List deliveries for an organization webhook"

Заголовки
Имя., Тип, Description
accept string

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

Параметры пути
Имя., Тип, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

hook_id integer Обязательное поле

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Параметры запроса
Имя., Тип, Description
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

По умолчанию.: 30

cursor string

Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the link header for the next and previous page cursors.

redelivery boolean

Коды состояния http-ответа для "List deliveries for an organization webhook"

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

OK

400

Bad Request

422

Validation failed, or the endpoint has been spammed.

Примеры кода для "List deliveries for an organization webhook"

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

get/orgs/{org}/hooks/{hook_id}/deliveries
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/hooks/HOOK_ID/deliveries

Response

Status: 200
[ { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "delivered_at": "2019-06-03T00:57:16Z", "redelivery": false, "duration": 0.27, "status": "OK", "status_code": 200, "event": "issues", "action": "opened", "installation_id": 123, "repository_id": 456 }, { "id": 123456789, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "delivered_at": "2019-06-04T00:57:16Z", "redelivery": true, "duration": 0.28, "status": "OK", "status_code": 200, "event": "issues", "action": "opened", "installation_id": 123, "repository_id": 456 } ]

Get a webhook delivery for an organization webhook

Returns a delivery for a webhook configured in an organization.

Подробные маркеры доступа для "Get a webhook delivery for an organization webhook

Эта конечная точка работает со следующими типами маркеров:

Маркер должен иметь следующий набор разрешений.:

  • organization_hooks:read

Параметры для "Get a webhook delivery for an organization webhook"

Заголовки
Имя., Тип, Description
accept string

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

Параметры пути
Имя., Тип, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

hook_id integer Обязательное поле

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

delivery_id integer Обязательное поле

Коды состояния http-ответа для "Get a webhook delivery for an organization webhook"

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

OK

400

Bad Request

422

Validation failed, or the endpoint has been spammed.

Примеры кода для "Get a webhook delivery for an organization webhook"

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

get/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/hooks/HOOK_ID/deliveries/DELIVERY_ID

Response

Status: 200
{ "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "delivered_at": "2019-06-03T00:57:16Z", "redelivery": false, "duration": 0.27, "status": "OK", "status_code": 200, "event": "issues", "action": "opened", "installation_id": 123, "repository_id": 456, "url": "https://www.example.com", "request": { "headers": { "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "Accept": "*/*", "X-GitHub-Hook-ID": "42", "User-Agent": "GitHub-Hookshot/b8c71d8", "X-GitHub-Event": "issues", "X-GitHub-Hook-Installation-Target-ID": "123", "X-GitHub-Hook-Installation-Target-Type": "repository", "content-type": "application/json", "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" }, "payload": { "action": "opened", "issue": { "body": "foo" }, "repository": { "id": 123 } } }, "response": { "headers": { "Content-Type": "text/html;charset=utf-8" }, "payload": "ok" } }

Redeliver a delivery for an organization webhook

Redeliver a delivery for a webhook configured in an organization.

Подробные маркеры доступа для "Redeliver a delivery for an organization webhook

Эта конечная точка работает со следующими типами маркеров:

Маркер должен иметь следующий набор разрешений.:

  • organization_hooks:write

Параметры для "Redeliver a delivery for an organization webhook"

Заголовки
Имя., Тип, Description
accept string

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

Параметры пути
Имя., Тип, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

hook_id integer Обязательное поле

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

delivery_id integer Обязательное поле

Коды состояния http-ответа для "Redeliver a delivery for an organization webhook"

Код состоянияОписание
202

Accepted

400

Bad Request

422

Validation failed, or the endpoint has been spammed.

Примеры кода для "Redeliver a delivery for an organization webhook"

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

post/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/hooks/HOOK_ID/deliveries/DELIVERY_ID/attempts

Accepted

Ping an organization webhook

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

Подробные маркеры доступа для "Ping an organization webhook

Эта конечная точка работает со следующими типами маркеров:

Маркер должен иметь следующий набор разрешений.:

  • organization_hooks:write

Параметры для "Ping an organization webhook"

Заголовки
Имя., Тип, Description
accept string

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

Параметры пути
Имя., Тип, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

hook_id integer Обязательное поле

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Коды состояния http-ответа для "Ping an organization webhook"

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

No Content

404

Resource not found

Примеры кода для "Ping an organization webhook"

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

post/orgs/{org}/hooks/{hook_id}/pings
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/hooks/HOOK_ID/pings

Response

Status: 204