Эта версия GitHub Enterprise Server была прекращена 2024-03-26. Исправления выпускаться не будут даже при критических проблемах безопасности. Для повышения производительности, повышения безопасности и новых функций выполните обновление до последней версии GitHub Enterprise Server. Чтобы получить справку по обновлению, обратитесь в службу поддержки GitHub Enterprise.
Конечные точки REST API для глобальных веб-перехватчиков
Используйте REST API для управления глобальными веб-перехватчиками для вашего предприятия.
About global webhooks
These endpoints are only available to authenticated site administrators Normal users will receive a 404
response. To learn how to configure global webhooks, see About global webhooks.
Global webhooks are automatically installed on your enterprise. You can use global webhooks to automatically monitor, respond to, or enforce rules for users, organizations, teams, and repositories on your enterprise.
Global webhooks can subscribe to the organization, user, repository, team, member, membership, fork, and ping event types.
List global webhooks
Параметры для "List global webhooks"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." По умолчанию.: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." По умолчанию.: |
Коды состояния http-ответа для "List global webhooks"
Код состояния | Описание |
---|---|
200 | OK |
Примеры кода для "List global webhooks"
Пример запроса
curl -L \
-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://HOSTNAME/admin/hooks/1",
"ping_url": "https://HOSTNAME/admin/hooks/1/pings"
}
]
Create a global webhook
Параметры для "Create a global webhook"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description | |||||
---|---|---|---|---|---|
name string Обязательное полеMust be passed as "web". | |||||
config object Обязательное полеKey/value pairs to provide settings for this webhook. | |||||
Properties of |
Имя., Тип, 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 |
secret string If provided, the |
insecure_ssl string Determines whether the SSL certificate of the host for |
events
array of strings The events that trigger this webhook. A global webhook can be triggered by user
and organization
events. Default: user
and organization
.
active
boolean Determines if notifications are sent when the webhook is triggered. Set to true
to send notifications.
По умолчанию.: true
Коды состояния http-ответа для "Create a global webhook"
Код состояния | Описание |
---|---|
201 | Created |
Примеры кода для "Create a global webhook"
Пример запроса
curl -L \
-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://HOSTNAME/admin/hooks/1",
"ping_url": "https://HOSTNAME/admin/hooks/1/pings"
}
Get a global webhook
Параметры для "Get a global webhook"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
hook_id integer Обязательное полеThe unique identifier of the hook. You can find this value in the |
Коды состояния http-ответа для "Get a global webhook"
Код состояния | Описание |
---|---|
200 | OK |
Примеры кода для "Get a global webhook"
Пример запроса
curl -L \
-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://HOSTNAME/admin/hooks/1",
"ping_url": "https://HOSTNAME/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.
Параметры для "Update a global webhook"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
hook_id integer Обязательное полеThe unique identifier of the hook. You can find this value in the |
Имя., Тип, Description | |||||
---|---|---|---|---|---|
config object Key/value pairs to provide settings for this webhook. | |||||
Properties of |
Имя., Тип, 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 |
secret string If provided, the |
insecure_ssl string Determines whether the SSL certificate of the host for |
events
array of strings The events that trigger this webhook. A global webhook can be triggered by user
and organization
events. Default: user
and organization
.
active
boolean Determines if notifications are sent when the webhook is triggered. Set to true
to send notifications.
По умолчанию.: true
Коды состояния http-ответа для "Update a global webhook"
Код состояния | Описание |
---|---|
200 | OK |
Примеры кода для "Update a global webhook"
Пример запроса
curl -L \
-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://HOSTNAME/admin/hooks/1",
"ping_url": "https://HOSTNAME/admin/hooks/1/pings"
}
Delete a global webhook
Параметры для "Delete a global webhook"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
hook_id integer Обязательное полеThe unique identifier of the hook. You can find this value in the |
Коды состояния http-ответа для "Delete a global webhook"
Код состояния | Описание |
---|---|
204 | No Content |
Примеры кода для "Delete a global webhook"
Пример запроса
curl -L \
-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.
Параметры для "Ping a global webhook"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
hook_id integer Обязательное полеThe unique identifier of the hook. You can find this value in the |
Коды состояния http-ответа для "Ping a global webhook"
Код состояния | Описание |
---|---|
204 | No Content |
Примеры кода для "Ping a global webhook"
Пример запроса
curl -L \
-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