Недавно мы переехали некоторые из документации по REST API. Если вы не можете найти нужные сведения, попробуйте использовать новые страницы REST API Branches, Collaborators, Commits, Deploy Keys, Deployments, GitHub Pages, Releases, Metrics, Webhooks REST API.
Веб-перехватчики репозитория
Используйте REST API для управления веб-перехватчиками репозитория.
List repository webhooks
Lists webhooks for a repository. last response
may return null if there have not been any deliveries within 30 days.
Параметры для "List repository webhooks"
Имя, Type, Description |
---|
accept string Setting to |
Имя, Type, Description |
---|
owner string Обязательное полеThe account owner of the repository. The name is not case sensitive. |
repo string Обязательное полеThe name of the repository without the |
Имя, Type, Description |
---|
per_page integer The number of results per page (max 100). По умолчанию.: |
page integer Page number of the results to fetch. По умолчанию.: |
Коды состояния http-ответа для "List repository webhooks"
Код состояния | Описание |
---|---|
200 | OK |
404 | Resource not found |
Примеры кода для "List repository webhooks"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/repos/OWNER/REPO/hooks
Response
Status: 200
[
{
"type": "Repository",
"id": 12345678,
"name": "web",
"active": true,
"events": [
"push",
"pull_request"
],
"config": {
"content_type": "json",
"insecure_ssl": "0",
"url": "https://example.com/webhook"
},
"updated_at": "2019-06-03T00:57:16Z",
"created_at": "2019-06-03T00:57:16Z",
"url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678",
"test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test",
"ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings",
"deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries",
"last_response": {
"code": null,
"status": "unused",
"message": null
}
}
]
Create a repository webhook
Repositories can have multiple webhooks installed. Each webhook should have a unique config
. Multiple webhooks can
share the same config
as long as those webhooks do not have any events
that overlap.
Параметры для "Create a repository webhook"
Имя, Type, Description |
---|
accept string Setting to |
Имя, Type, Description |
---|
owner string Обязательное полеThe account owner of the repository. The name is not case sensitive. |
repo string Обязательное полеThe name of the repository without the |
Имя, Type, Description | |||||||
---|---|---|---|---|---|---|---|
name string Use | |||||||
config object Key/value pairs to provide settings for this webhook. | |||||||
Properties of |
Имя, Type, 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 or number Determines whether the SSL certificate of the host for |
token string |
digest string |
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
Коды состояния http-ответа для "Create a repository webhook"
Код состояния | Описание |
---|---|
201 | Created |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Примеры кода для "Create a repository webhook"
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/repos/OWNER/REPO/hooks \
-d '{"name":"web","active":true,"events":["push","pull_request"],"config":{"url":"https://example.com/webhook","content_type":"json","insecure_ssl":"0"}}'
Response
Status: 201
{
"type": "Repository",
"id": 12345678,
"name": "web",
"active": true,
"events": [
"push",
"pull_request"
],
"config": {
"content_type": "json",
"insecure_ssl": "0",
"url": "https://example.com/webhook"
},
"updated_at": "2019-06-03T00:57:16Z",
"created_at": "2019-06-03T00:57:16Z",
"url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678",
"test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test",
"ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings",
"deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries",
"last_response": {
"code": null,
"status": "unused",
"message": null
}
}
Get a repository webhook
Returns a webhook configured in a repository. To get only the webhook config
properties, see "Get a webhook configuration for a repository."
Параметры для "Get a repository webhook"
Имя, Type, Description |
---|
accept string Setting to |
Имя, Type, Description |
---|
owner string Обязательное полеThe account owner of the repository. The name is not case sensitive. |
repo string Обязательное полеThe name of the repository without the |
hook_id integer Обязательное полеThe unique identifier of the hook. You can find this value in the |
Коды состояния http-ответа для "Get a repository webhook"
Код состояния | Описание |
---|---|
200 | OK |
404 | Resource not found |
Примеры кода для "Get a repository webhook"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID
Response
Status: 200
{
"type": "Repository",
"id": 12345678,
"name": "web",
"active": true,
"events": [
"push",
"pull_request"
],
"config": {
"content_type": "json",
"insecure_ssl": "0",
"url": "https://example.com/webhook"
},
"updated_at": "2019-06-03T00:57:16Z",
"created_at": "2019-06-03T00:57:16Z",
"url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678",
"test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test",
"ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings",
"deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries",
"last_response": {
"code": null,
"status": "unused",
"message": null
}
}
Update a repository webhook
Updates a webhook configured in a repository. 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 a repository."
Параметры для "Update a repository webhook"
Имя, Type, Description |
---|
accept string Setting to |
Имя, Type, Description |
---|
owner string Обязательное полеThe account owner of the repository. The name is not case sensitive. |
repo string Обязательное полеThe name of the repository without the |
hook_id integer Обязательное полеThe unique identifier of the hook. You can find this value in the |
Имя, Type, Description | |||||||
---|---|---|---|---|---|---|---|
config object Key/value pairs to provide settings for this webhook. | |||||||
Properties of |
Имя, Type, 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 or number Determines whether the SSL certificate of the host for |
address string |
room string |
events
array of strings Determines what events the hook is triggered for. This replaces the entire array of events.
По умолчанию.: ["push"]
add_events
array of strings Determines a list of events to be added to the list of events that the Hook triggers for.
remove_events
array of strings Determines a list of events to be removed from the list of events that the Hook triggers for.
active
boolean Determines if notifications are sent when the webhook is triggered. Set to true
to send notifications.
По умолчанию.: true
Коды состояния http-ответа для "Update a repository webhook"
Код состояния | Описание |
---|---|
200 | OK |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Примеры кода для "Update a repository webhook"
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID \
-d '{"active":true,"add_events":["pull_request"]}'
Response
Status: 200
{
"type": "Repository",
"id": 12345678,
"name": "web",
"active": true,
"events": [
"push",
"pull_request"
],
"config": {
"content_type": "json",
"insecure_ssl": "0",
"url": "https://example.com/webhook"
},
"updated_at": "2019-06-03T00:57:16Z",
"created_at": "2019-06-03T00:57:16Z",
"url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678",
"test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test",
"ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings",
"deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries",
"last_response": {
"code": null,
"status": "unused",
"message": null
}
}
Delete a repository webhook
Параметры для "Delete a repository webhook"
Имя, Type, Description |
---|
accept string Setting to |
Имя, Type, Description |
---|
owner string Обязательное полеThe account owner of the repository. The name is not case sensitive. |
repo string Обязательное полеThe name of the repository without the |
hook_id integer Обязательное полеThe unique identifier of the hook. You can find this value in the |
Коды состояния http-ответа для "Delete a repository webhook"
Код состояния | Описание |
---|---|
204 | No Content |
404 | Resource not found |
Примеры кода для "Delete a repository webhook"
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID
Response
Status: 204
Ping a repository webhook
This will trigger a ping event to be sent to the hook.
Параметры для "Ping a repository webhook"
Имя, Type, Description |
---|
accept string Setting to |
Имя, Type, Description |
---|
owner string Обязательное полеThe account owner of the repository. The name is not case sensitive. |
repo string Обязательное полеThe name of the repository without the |
hook_id integer Обязательное полеThe unique identifier of the hook. You can find this value in the |
Коды состояния http-ответа для "Ping a repository webhook"
Код состояния | Описание |
---|---|
204 | No Content |
404 | Resource not found |
Примеры кода для "Ping a repository webhook"
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID/pings
Response
Status: 204
Test the push repository webhook
This will trigger the hook with the latest push to the current repository if the hook is subscribed to push
events. If the hook is not subscribed to push
events, the server will respond with 204 but no test POST will be generated.
Note: Previously /repos/:owner/:repo/hooks/:hook_id/test
Параметры для "Test the push repository webhook"
Имя, Type, Description |
---|
accept string Setting to |
Имя, Type, Description |
---|
owner string Обязательное полеThe account owner of the repository. The name is not case sensitive. |
repo string Обязательное полеThe name of the repository without the |
hook_id integer Обязательное полеThe unique identifier of the hook. You can find this value in the |
Коды состояния http-ответа для "Test the push repository webhook"
Код состояния | Описание |
---|---|
204 | No Content |
404 | Resource not found |
Примеры кода для "Test the push repository webhook"
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID/tests
Response
Status: 204