Конечные точки REST API для веб-перехватчиков репозитория
Веб-перехватчики репозитория позволяют серверу получать полезные данные HTTP POST
при каждом возникновении определенных событий в репозитории. Дополнительные сведения см. в разделе Документация по веб-перехватчикам.
Lists webhooks for a repository. last response
may return null if there have not been any deliveries within 30 days.
Подробные маркеры доступа для "List repository webhooks
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения
- Маркеры доступа к установке приложений
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Webhooks" repository permissions (read)
Параметры для "List repository webhooks"
Имя., Тип, Description |
---|
accept stringSetting to |
Имя., Тип, Description |
---|
owner string Обязательное полеThe account owner of the repository. The name is not case sensitive. |
repo string Обязательное полеThe name of the repository without the |
Имя., Тип, Description |
---|
per_page integerThe number of results per page (max 100). For more information, see "Using pagination in the REST API." По умолчанию.: |
page integerThe page number of the results to fetch. For more information, see "Using pagination in the REST API." По умолчанию.: |
Коды состояния http-ответа для "List repository webhooks"
Код состояния | Описание |
---|---|
200 | OK |
404 | Resource not found |
Примеры кода для "List repository webhooks"
Пример запроса
curl -L \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ http(s)://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://HOSTNAME/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://HOSTNAME/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://HOSTNAME/repos/octocat/Hello-World/hooks/12345678/pings", "deliveries_url": "https://HOSTNAME/repos/octocat/Hello-World/hooks/12345678/deliveries", "last_response": { "code": null, "status": "unused", "message": null } } ]
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
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения
- Маркеры доступа к установке приложений
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Webhooks" repository permissions (write)
Параметры для "Create a repository webhook"
Имя., Тип, Description |
---|
accept stringSetting to |
Имя., Тип, Description |
---|
owner string Обязательное полеThe account owner of the repository. The name is not case sensitive. |
repo string Обязательное полеThe name of the repository without the |
Имя., Тип, Description | |||||
---|---|---|---|---|---|
name stringUse | |||||
config objectKey/value pairs to provide settings for this webhook. | |||||
Properties of |
Имя., Тип, Description |
---|
url stringThe URL to which the payloads will be delivered. |
content_type stringThe media type used to serialize the payloads. Supported values include |
secret stringIf provided, the |
insecure_ssl string or numberDetermines whether the SSL certificate of the host for |
events
array of stringsDetermines what events the hook is triggered for.
По умолчанию.: ["push"]
active
booleanDetermines 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.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ http(s)://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://HOSTNAME/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://HOSTNAME/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://HOSTNAME/repos/octocat/Hello-World/hooks/12345678/pings", "deliveries_url": "https://HOSTNAME/repos/octocat/Hello-World/hooks/12345678/deliveries", "last_response": { "code": null, "status": "unused", "message": null } }
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
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения
- Маркеры доступа к установке приложений
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Webhooks" repository permissions (read)
Параметры для "Get a repository webhook"
Имя., Тип, Description |
---|
accept stringSetting to |
Имя., Тип, 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.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ http(s)://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://HOSTNAME/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://HOSTNAME/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://HOSTNAME/repos/octocat/Hello-World/hooks/12345678/pings", "deliveries_url": "https://HOSTNAME/repos/octocat/Hello-World/hooks/12345678/deliveries", "last_response": { "code": null, "status": "unused", "message": null } }
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
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения
- Маркеры доступа к установке приложений
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Webhooks" repository permissions (write)
Параметры для "Update a repository webhook"
Имя., Тип, Description |
---|
accept stringSetting to |
Имя., Тип, 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 |
Имя., Тип, Description | |||||
---|---|---|---|---|---|
config objectConfiguration object of the webhook | |||||
Properties of |
Имя., Тип, Description |
---|
url stringThe URL to which the payloads will be delivered. |
content_type stringThe media type used to serialize the payloads. Supported values include |
secret stringIf provided, the |
insecure_ssl string or numberDetermines whether the SSL certificate of the host for |
events
array of stringsDetermines what events the hook is triggered for. This replaces the entire array of events.
По умолчанию.: ["push"]
add_events
array of stringsDetermines a list of events to be added to the list of events that the Hook triggers for.
remove_events
array of stringsDetermines a list of events to be removed from the list of events that the Hook triggers for.
active
booleanDetermines 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 \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ http(s)://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://HOSTNAME/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://HOSTNAME/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://HOSTNAME/repos/octocat/Hello-World/hooks/12345678/pings", "deliveries_url": "https://HOSTNAME/repos/octocat/Hello-World/hooks/12345678/deliveries", "last_response": { "code": null, "status": "unused", "message": null } }
Delete a webhook for an organization.
The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.
Подробные маркеры доступа для "Delete a repository webhook
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения
- Маркеры доступа к установке приложений
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Webhooks" repository permissions (write)
Параметры для "Delete a repository webhook"
Имя., Тип, Description |
---|
accept stringSetting to |
Имя., Тип, 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.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID
Response
Status: 204
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."
OAuth app tokens and personal access tokens (classic) need the read:repo_hook
or repo
scope to use this endpoint.
Подробные маркеры доступа для "Get a webhook configuration for a repository
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения
- Маркеры доступа к установке приложений
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Webhooks" repository permissions (read)
Параметры для "Get a webhook configuration for a repository"
Имя., Тип, Description |
---|
accept stringSetting to |
Имя., Тип, 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 webhook configuration for a repository"
Код состояния | Описание |
---|---|
200 | OK |
Примеры кода для "Get a webhook configuration for a repository"
Пример запроса
curl -L \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ 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" }
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."
OAuth app tokens and personal access tokens (classic) need the write:repo_hook
or repo
scope to use this endpoint.
Подробные маркеры доступа для "Update a webhook configuration for a repository
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения
- Маркеры доступа к установке приложений
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Webhooks" repository permissions (write)
Параметры для "Update a webhook configuration for a repository"
Имя., Тип, Description |
---|
accept stringSetting to |
Имя., Тип, 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 |
Имя., Тип, Description |
---|
url stringThe URL to which the payloads will be delivered. |
content_type stringThe media type used to serialize the payloads. Supported values include |
secret stringIf provided, the |
insecure_ssl string or numberDetermines whether the SSL certificate of the host for |
Коды состояния http-ответа для "Update a webhook configuration for a repository"
Код состояния | Описание |
---|---|
200 | OK |
Примеры кода для "Update a webhook configuration for a repository"
Пример запроса
curl -L \ -X \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ 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" }
Returns a list of webhook deliveries for a webhook configured in a repository.
Подробные маркеры доступа для "List deliveries for a repository webhook
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения
- Маркеры доступа к установке приложений
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Webhooks" repository permissions (read)
Параметры для "List deliveries for a repository webhook"
Имя., Тип, Description |
---|
accept stringSetting to |
Имя., Тип, 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 |
Имя., Тип, Description |
---|
per_page integerThe number of results per page (max 100). For more information, see "Using pagination in the REST API." По умолчанию.: |
cursor stringUsed for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the |
Коды состояния http-ответа для "List deliveries for a repository webhook"
Код состояния | Описание |
---|---|
200 | OK |
400 | Bad Request |
422 | Validation failed, or the endpoint has been spammed. |
Примеры кода для "List deliveries for a repository webhook"
Пример запроса
curl -L \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/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, "throttled_at": "2019-06-03T00:57:16Z" }, { "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, "throttled_at": null } ]
Returns a delivery for a webhook configured in a repository.
Подробные маркеры доступа для "Get a delivery for a repository webhook
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения
- Маркеры доступа к установке приложений
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Webhooks" repository permissions (read)
Параметры для "Get a delivery for a repository webhook"
Имя., Тип, Description |
---|
accept stringSetting to |
Имя., Тип, 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 |
delivery_id integer Обязательное поле |
Коды состояния http-ответа для "Get a delivery for a repository webhook"
Код состояния | Описание |
---|---|
200 | OK |
400 | Bad Request |
422 | Validation failed, or the endpoint has been spammed. |
Примеры кода для "Get a delivery for a repository webhook"
Пример запроса
curl -L \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/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", "throttled_at": "2019-06-03T00:57:16Z", "request": { "headers": { "X--Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "Accept": "*/*", "X--Hook-ID": "42", "User-Agent": "-Hookshot/b8c71d8", "X--Event": "issues", "X--Hook-Installation-Target-ID": "123", "X--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 webhook delivery for a webhook configured in a repository.
Подробные маркеры доступа для "Redeliver a delivery for a repository webhook
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения
- Маркеры доступа к установке приложений
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Webhooks" repository permissions (write)
Параметры для "Redeliver a delivery for a repository webhook"
Имя., Тип, Description |
---|
accept stringSetting to |
Имя., Тип, 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 |
delivery_id integer Обязательное поле |
Коды состояния http-ответа для "Redeliver a delivery for a repository webhook"
Код состояния | Описание |
---|---|
202 | Accepted |
400 | Bad Request |
422 | Validation failed, or the endpoint has been spammed. |
Примеры кода для "Redeliver a delivery for a repository webhook"
Пример запроса
curl -L \ -X POST \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID/deliveries/DELIVERY_ID/attempts
Accepted
Status: 202
This will trigger a ping event to be sent to the hook.
Подробные маркеры доступа для "Ping a repository webhook
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения
- Маркеры доступа к установке приложений
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Webhooks" repository permissions (read)
Параметры для "Ping a repository webhook"
Имя., Тип, Description |
---|
accept stringSetting to |
Имя., Тип, 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.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID/pings
Response
Status: 204
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
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения
- Маркеры доступа к установке приложений
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Webhooks" repository permissions (read)
Параметры для "Test the push repository webhook"
Имя., Тип, Description |
---|
accept stringSetting to |
Имя., Тип, 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.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID/tests
Response
Status: 204