При настройке веб-перехватчика можно использовать пользовательский интерфейс или API, чтобы выбрать, какие события будут отправлять полезные данные. Если подписаться только на определенные события, которые вы планируете обрабатывать, вы ограничите количество HTTP-запросов к серверу. Вы также можете подписаться на все текущие и будущие события. По умолчанию веб-перехватчики подписываются только на событие отправки. Список событий, на которые вы подписаны, можно изменить в любое время.
Вы можете создавать веб-перехватчики, которые подписываются на события, указанные на этой странице. Каждое событие веб-перехватчика включает описание свойств веб-перехватчика и пример полезных данных. Дополнительные сведения см. в разделе Создание веб-перехватчиков.
Общие свойства объекта полезных данных веб-перехватчика
Все полезные данные события веб-перехватчика также содержат свойства, уникальные для события. Уникальные свойства указаны в разделах отдельных типов событий.
Ключ | Тип | Описание |
---|---|---|
action | string | Большинство полезных данных веб-перехватчика содержат свойство action , которое содержит конкретное действие, вызвавшее событие. |
sender | object | Пользователь, который запустил событие. Это свойство включено во все полезные данные веб-перехватчика. |
repository | object | repository , где произошло событие. Полезные данные веб-перехватчика содержат свойство repository , когда событие происходит в результате выполнения действия в репозитории. |
organization | object | Объект organization будет содержаться в полезных данных веб-перехватчика, если такой настроен для организации, либо произойдет событие в результате действия в репозитории, принадлежащем организации. installation |
Уникальные свойства для события веб-перехватчика — это те же свойства, которые можно найти в свойстве payload
при использовании API отчетов. Единственным исключением является событие push
. Уникальные свойства полезных данных веб-перехватчика события push
и свойство payload
в API событий различаются. Полезные данные веб-перехватчика содержат более подробные сведения.
Примечание. Размер полезных данных не должен превышать 25 МБ. Если ваше событие генерирует полезные данные большего размера, веб-перехватчик не будет запущен. Это может произойти, например, при событии create
в случае одновременной принудительной отправки большого количества ветвей или тегов. Рекомендуем отслеживать размер полезных данных, чтобы обеспечить доставку.
Заголовки доставки
Полезные данные HTTP POST, которые доставляются на настроенную конечную точку URL-адреса вашего веб-перехватчика, будут содержать несколько специальных заголовков:
Header | Описание |
---|---|
X-GitHub-Event | Название события, активировавшего доставку. |
X-GitHub-Delivery | GUID для идентификации доставки. |
X-GitHub-Enterprise-Version | Версия экземпляра GitHub Enterprise Server, отправившего полезные данные HTTP POST. |
X-GitHub-Enterprise-Host | Имя узла экземпляра GitHub Enterprise Server, отправившего полезные данные HTTP POST. |
X-Hub-Signature-256 | Этот заголовок отправляется, если веб-перехватчик настроен с secret . Это шестнадцатеричный дайджест HMAC текста запроса, который генерируется с использованием хэш-функции SHA-256 и secret в качестве HMAC key . |
Кроме того, User-Agent
для запросов будет иметь префикс GitHub-Hookshot/
.
Пример доставки
> POST /payload HTTP/2
> Host: localhost:4567
> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958
> X-GitHub-Enterprise-Version: 2.15.0
> X-GitHub-Enterprise-Host: example.com
> X-Hub-Signature-256: sha256=d57c68ca6f92289e6987922ff26938930f6e66a2d161ef06abdf1859230aa23c
> User-Agent: GitHub-Hookshot/044aadd
> Content-Type: application/json
> Content-Length: 6615
> X-GitHub-Event: issues
> {
> "action": "opened",
> "issue": {
> "url": "https://HOSTNAME/api/v3/repos/octocat/Hello-World/issues/1347",
> "number": 1347,
> ...
> },
> "repository" : {
> "id": 1296269,
> "full_name": "octocat/Hello-World",
> "owner": {
> "login": "octocat",
> "id": 1,
> ...
> },
> ...
> },
> "sender": {
> "login": "octocat",
> "id": 1,
> ...
> }
> }
branch_protection_rule
This event occurs when there is activity relating to branch protection rules. For more information, see "About protected branches." For information about the APIs to manage branch protection rules, see the GraphQL documentation or "Branch protection" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission
Доступность для branch_protection_rule
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для branch_protection_rule
A branch protection rule was created.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
rule objectОбязательноThe branch protection rule. Includes a | |||
Properties of | |||
sender objectОбязательноA GitHub user. |
check_run
This event occurs when there is activity relating to a check run. For information about check runs, see "Getting started with the Checks API." For information about the APIs to manage check runs, see the GraphQL API documentation or "Check Runs" in the REST API documentation.
For activity relating to check suites, use the check-suite
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the rerequested
and requested_action
event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created
and completed
event types in repositories.
Note: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests
array and a null
value for head_branch
.
Доступность для check_run
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для check_run
A check run was completed, and a conclusion is available.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringЗначение: | |||
check_run objectОбязательноA check performed on the code of a given code change | |||
Properties of | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
check_suite
This event occurs when there is activity relating to a check suite. For information about check suites, see "Getting started with the Checks API." For information about the APIs to manage check suites, see the GraphQL API documentation or "Check Suites" in the REST API documentation.
For activity relating to check runs, use the check_run
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the requested
and rerequested
event types, the app must have at lease write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed
event types in repositories.
Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests
array and a null
value for head_branch
.
Доступность для check_suite
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для check_suite
All check runs in a check suite have completed, and a conclusion is available.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
actions_meta object or null | |||
check_suite objectОбязательноThe check_suite. | |||
Properties of | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
code_scanning_alert
This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "About code scanning" and "About code scanning alerts." For information about the API to manage code scanning, see "Code scanning" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission.
Доступность для code_scanning_alert
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для code_scanning_alert
A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
alert objectОбязательноThe code scanning alert involved in the event. | |||
Properties of | |||
commit_oid stringОбязательноThe commit SHA of the code scanning alert. When the action is | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
ref stringОбязательноThe Git reference of the code scanning alert. When the action is | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
commit_comment
This event occurs when there is activity relating to commit comments. For more information about commit comments, see "Commenting on a pull request." For information about the APIs to manage commit comments, see the GraphQL API documentation or "Commit comments" in the REST API documentation.
For activity relating to comments on pull request reviews, use the pull_request_review_comment
event. For activity relating to issue comments, use the issue_comment
event. For activity relating to discussion comments, use the discussion_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Доступность для commit_comment
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для commit_comment
Someone commented on a commit.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноThe action performed. Can be Значение: | |||
comment objectОбязательноThe commit comment resource. | |||
Properties of | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
create
This event occurs when a Git branch or tag is created.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Note: This event will not occur when more than three tags are created at once.
Доступность для create
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для create
Заголовки |
---|
Имя, Тип, Описание |
Параметры запроса |
Имя, Тип, Описание |
description string or nullОбязательноThe repository's current description. |
enterprise objectAn enterprise on GitHub. |
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. |
master_branch stringОбязательноThe name of the repository's default branch (usually |
organization objectA GitHub organization. |
pusher_type stringОбязательноThe pusher type for the event. Can be either |
ref stringОбязательноThe |
ref_type stringОбязательноThe type of Git ref object created in the repository. Может быть одним из: |
repository objectОбязательноA repository on GitHub. |
sender objectОбязательноA GitHub user. |
delete
This event occurs when a Git branch or tag is deleted.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Note: This event will not occur when more than three tags are deleted at once.
Доступность для delete
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для delete
Заголовки |
---|
Имя, Тип, Описание |
Параметры запроса |
Имя, Тип, Описание |
enterprise objectAn enterprise on GitHub. |
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. |
organization objectA GitHub organization. |
pusher_type stringОбязательноThe pusher type for the event. Can be either |
ref stringОбязательноThe |
ref_type stringОбязательноThe type of Git ref object deleted in the repository. Может быть одним из: |
repository objectОбязательноA repository on GitHub. |
sender objectОбязательноA GitHub user. |
dependabot_alert
This event occurs when there is activity relating to Dependabot alerts.
For more information about Dependabot alerts, see "About Dependabot alerts." For information about the API to manage Dependabot alerts, see "Dependabot alerts" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission.
Note: Webhook events for Dependabot alerts are currently in beta and subject to change.
Доступность для dependabot_alert
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для dependabot_alert
A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
alert objectОбязательноA Dependabot alert. | |||
Properties of | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
enterprise objectAn enterprise on GitHub. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
deploy_key
This event occurs when there is activity relating to deploy keys. For more information, see "Managing deploy keys." For information about the APIs to manage deploy keys, see the GraphQL API documentation or "Deploy keys" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.
Доступность для deploy_key
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для deploy_key
A deploy key was created.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
key objectОбязательноThe | |||
Properties of | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
deployment
This event occurs when there is activity relating to deployments. For more information, see "About deployments." For information about the APIs to manage deployments, see the GraphQL API documentation or "Deployments" in the REST API documentation.
For activity relating to deployment status, use the deployment_status
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.
Доступность для deployment
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для deployment
A deployment was created.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
deployment objectОбязательноThe deployment. | |||
Properties of | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. | |||
workflow object or nullОбязательно | |||
workflow_run object or nullОбязательно |
deployment_status
This event occurs when there is activity relating to deployment statuses. For more information, see "About deployments." For information about the APIs to manage deployments, see the GraphQL API documentation or "Deployments" in the REST API documentation.
For activity relating to deployment creation, use the deployment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.
Доступность для deployment_status
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для deployment_status
A new deployment status was created.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
check_run object or null | |||
deployment objectОбязательноThe deployment. | |||
Properties of | |||
deployment_status objectОбязательноThe deployment status. | |||
Properties of | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. | |||
workflow object or null | |||
workflow_run object or null |
discussion
This event occurs when there is activity relating to a discussion. For more information about discussions, see "GitHub Discussions." For information about the API to manage discussions, see the GraphQL documentation.
For activity relating to a comment on a discussion, use the discussion_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
Note: Webhook events for GitHub Discussions are currently in beta and subject to change.
Доступность для discussion
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для discussion
A comment on the discussion was marked as the answer.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
answer objectОбязательно | |||
Properties of | |||
discussion objectОбязательноA Discussion in a repository. | |||
Properties of | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
discussion_comment
This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "GitHub Discussions." For information about the API to manage discussions, see the GraphQL documentation.
For activity relating to a discussion as opposed to comments on a discussion, use the discussion
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
Note: Webhook events for GitHub Discussions are currently in beta and subject to change.
Доступность для discussion_comment
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для discussion_comment
A comment on a discussion was created.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
comment objectОбязательно | |||
Properties of | |||
discussion objectОбязательноA Discussion in a repository. | |||
Properties of | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
fork
This event occurs when someone forks a repository. For more information, see "Fork a repo." For information about the API to manage forks, see "Forks" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Доступность для fork
- Предприятия
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для fork
Заголовки |
---|
Имя, Тип, Описание |
Параметры запроса |
Имя, Тип, Описание |
enterprise objectAn enterprise on GitHub. |
forkee ОбязательноThe created |
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. |
organization objectA GitHub organization. |
repository objectОбязательноA repository on GitHub. |
sender objectОбязательноA GitHub user. |
github_app_authorization
This event occurs when a user revokes their authorization of a GitHub App. For more information, see "About apps." For information about the API to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.
A GitHub App receives this webhook by default and cannot unsubscribe from this event.
Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials
error. For details about user-to-server requests, which require GitHub App authorization, see "Identifying and authorizing users for GitHub Apps."
Доступность для github_app_authorization
- Приложения GitHub
Объект полезных данных веб-перехватчика для github_app_authorization
Someone revoked their authorization of a GitHub App.
Заголовки |
---|
Имя, Тип, Описание |
Параметры запроса |
Имя, Тип, Описание |
action stringОбязательноЗначение: |
enterprise objectAn enterprise on GitHub. |
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. |
organization objectA GitHub organization. |
repository objectA repository on GitHub. |
sender objectОбязательноA GitHub user. |
gollum
This event occurs when someone creates or updates a wiki page. For more information, see "About wikis."
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Доступность для gollum
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для gollum
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
pages array of objectsОбязательноThe pages that were updated. | |||
Properties of | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
installation
This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
For more information about GitHub Apps, see "About apps." For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.
Доступность для installation
- Приложения GitHub
Объект полезных данных веб-перехватчика для installation
Someone installed a GitHub App on a user or organization account.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectОбязательноInstallation | |||
organization objectA GitHub organization. | |||
repositories array of objectsAn array of repository objects that the installation can access. | |||
Properties of | |||
repository objectA repository on GitHub. | |||
requester object or null | |||
sender objectОбязательноA GitHub user. |
installation_repositories
This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
For more information about GitHub Apps, see "About apps." For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.
Доступность для installation_repositories
- Приложения GitHub
Объект полезных данных веб-перехватчика для installation_repositories
A GitHub App installation was granted access to one or more repositories.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectОбязательноInstallation | |||
organization objectA GitHub organization. | |||
repositories_added array of objectsОбязательноAn array of repository objects, which were added to the installation. | |||
Properties of | |||
repositories_removed array of objectsОбязательноAn array of repository objects, which were removed from the installation. | |||
Properties of | |||
repository objectA repository on GitHub. | |||
repository_selection stringОбязательноDescribe whether all repositories have been selected or there's a selection involved Может быть одним из: | |||
requester object or nullОбязательно | |||
sender objectОбязательноA GitHub user. |
installation_target
This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see "About apps." For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.
Доступность для installation_target
- Приложения GitHub
Объект полезных данных веб-перехватчика для installation_target
Somebody renamed the user or organization account that a GitHub App is installed on.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
account objectОбязательно | |||
Properties of | |||
action stringОбязательно | |||
changes objectОбязательно | |||
Properties of | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectОбязательноThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
repository objectA repository on GitHub. | |||
sender objectA GitHub user. | |||
target_type stringОбязательно |
issue_comment
This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "About issues" and "About pull requests." For information about the APIs to manage issue comments, see the GraphQL documentation or "Issue comments" in the REST API documentation.
For activity relating to an issue as opposed to comments on an issue, use the issue
event. For activity related to pull request reviews or pull request review comments, use the pull_request_review
or pull_request_review_comment
events. For more information about the different types of pull request comments, see "Working with comments."
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions.
Доступность для issue_comment
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для issue_comment
A comment on an issue or pull request was created.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
comment objectОбязательноThe comment itself. | |||
Properties of | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
issue ОбязательноThe issue the comment belongs to. | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
issues
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
Доступность для issues
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для issues
An issue was assigned to a user.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноThe action that was performed. Значение: | |||
assignee object or null | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
issue objectОбязательноThe issue itself. | |||
Properties of | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
label
This event occurs when there is activity relating to labels. For more information, see "Managing labels." For information about the APIs to manage labels, see the GraphQL documentation or "Labels" in the REST API documentation.
If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled
or unlabeled
action type for the issues
, pull_request
, or discussion
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.
Доступность для label
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для label
A label was created.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
label objectОбязательно | |||
Properties of | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectA GitHub user. |
member
This event occurs when there is activity relating to collaborators in a repository. For more information, see "Adding outside collaborators to repositories in your organization." For more information about the API to manage repository collaborators, see the GraphQL API documentation or "Collaborators" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
Доступность для member
- Предприятия
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для member
A GitHub user accepted an invitation to a repository.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
changes object | |||
Properties of | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
member object or nullОбязательно | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
membership
This event occurs when there is activity relating to team membership. For more information, see "About teams." For more information about the APIs to manage team memberships, see the GraphQL API documentation or "Team members" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
Доступность для membership
- Организации
- Предприятия
- Приложения GitHub
Объект полезных данных веб-перехватчика для membership
An organization member was added to a team.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
member object or nullОбязательно | |||
organization objectОбязательноA GitHub organization. | |||
repository objectA repository on GitHub. | |||
scope stringОбязательноThe scope of the membership. Currently, can only be Значение: | |||
sender object or nullОбязательно | |||
team objectОбязательноGroups of organization members that gives permissions on specified repositories. | |||
Properties of |
merge_group
This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "Managing a merge queue."
To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission.
Note: The pull request merge queue feature is currently in public beta and subject to change.
Доступность для merge_group
- Приложения GitHub
Объект полезных данных веб-перехватчика для merge_group
Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.
When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательно | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
merge_group objectОбязательно | |||
Properties of | |||
organization objectA GitHub organization. | |||
repository objectA repository on GitHub. | |||
sender objectA GitHub user. |
meta
This event occurs when there is activity relating to a webhook itself.
To subscribe to this event, a GitHub App must have at least read-level access for the "Meta" app permission.
Доступность для meta
- GitHub Marketplace
- Предприятия
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для meta
The webhook was deleted.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
hook objectОбязательноThe modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. | |||
Properties of | |||
hook_id integerОбязательноThe id of the modified webhook. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
repository objectA repository on GitHub. | |||
sender objectA GitHub user. |
milestone
This event occurs when there is activity relating to milestones. For more information, see "About milestones." For information about the APIs to manage milestones, see the GraphQL documentation or "Milestones" in the REST API documentation.
If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned
or demilestoned
action type for the issues
or pull_request
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions.
Доступность для milestone
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для milestone
A milestone was closed.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
milestone objectОбязательноA collection of related issues and pull requests. | |||
Properties of | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
organization
This event occurs when there is activity relating to an organization and its members. For more information, see "About organizations." For information about the APIs to manage organizations, see the GraphQL documentation or "Organizations" in the REST API documentation.
If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block
event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
Доступность для organization
- Организации
- Предприятия
- Приложения GitHub
Объект полезных данных веб-перехватчика для organization
An organization was deleted.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
membership objectThe membership between the user and the organization. Not present when the action is | |||
Properties of | |||
organization objectОбязательноA GitHub organization. | |||
repository objectA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
package
This event occurs when there is activity relating to GitHub Packages. For more information, see "Introduction to GitHub Packages." For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or "Packages" in the REST API documentation.
To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.
Доступность для package
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для package
A package was published to a registry.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
package objectОбязательноInformation about the package. | |||
Properties of | |||
repository objectA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
page_build
This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see "Configuring a publishing source for your GitHub Pages site." For information about the API to manage GitHub Pages, see "Pages" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission.
Доступность для page_build
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для page_build
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
build objectОбязательноThe List GitHub Pages builds itself. | |||
Properties of | |||
enterprise objectAn enterprise on GitHub. | |||
id integerОбязательно | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
ping
This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.
Доступность для ping
- Репозитории
- Организации
- Приложения GitHub
- Предприятия
- GitHub Marketplace
Объект полезных данных веб-перехватчика для ping
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
hook objectThe webhook that is being pinged | |||
Properties of | |||
hook_id integerThe ID of the webhook that triggered the ping. | |||
organization objectA GitHub organization. | |||
repository objectA repository on GitHub. | |||
sender objectA GitHub user. | |||
zen stringRandom string of GitHub zen. |
project_card
This event occurs when there is activity relating to a card on a classic project. For more information, see "About projects (classic)." For information about the API to manage classic projects, see the GraphQL API documentation or "Projects (classic)" in the REST API documentation.
For activity relating to a project or a column on a project, use the project
and project_column
event. For activity relating to Projects instead of Projects (classic), use the projects_v2
event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.
Доступность для project_card
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для project_card
A note in a classic project was converted to an issue.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
changes objectОбязательно | |||
Properties of | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
project_card objectОбязательно | |||
Properties of | |||
repository objectA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
project
This event occurs when there is activity relating to a classic project. For more information, see "About projects (classic)." For information about the API to manage classic projects, see the GraphQL API documentation or "Projects (classic)" in the REST API documentation.
For activity relating to a card or column on a project, use the project_card
and project_column
event. For activity relating to Projects instead of Projects (classic), use the projects_v2
event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.
Доступность для project
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для project
A classic project was closed.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
project objectОбязательно | |||
Properties of | |||
repository objectA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
project_column
This event occurs when there is activity relating to a column on a classic project. For more information, see "About projects (classic)." For information about the API to manage classic projects, see the GraphQL API documentation or "Projects (classic)" in the REST API documentation.
For activity relating to a project or a card on a project, use the project
and project_card
event. For activity relating to Projects instead of Projects (classic), use the projects_v2
event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.
Доступность для project_column
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для project_column
A column was added to a classic project.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
project_column objectОбязательно | |||
Properties of | |||
repository objectA repository on GitHub. | |||
sender objectA GitHub user. |
projects_v2
This event occurs when there is activity relating to an organization-level project. For more information, see "About Projects." For information about the Projects API, see the GraphQL documentation.
For activity relating to a item on a project, use the projects_v2_item
event. For activity relating to Projects (classic), use the project
, project_card, and
project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.
Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
Доступность для projects_v2
- Организации
Объект полезных данных веб-перехватчика для projects_v2
A project in the organization was closed.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
organization objectОбязательноA GitHub organization. | |||
projects_v2 objectОбязательноA projects v2 project | |||
Properties of | |||
sender objectОбязательноA GitHub user. |
public
This event occurs when repository visibility changes from private to public. For more information, see "Setting repository visibility."
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.
Доступность для public
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для public
Заголовки |
---|
Имя, Тип, Описание |
Параметры запроса |
Имя, Тип, Описание |
enterprise objectAn enterprise on GitHub. |
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. |
organization objectA GitHub organization. |
repository objectОбязательноA repository on GitHub. |
sender objectОбязательноA GitHub user. |
pull_request
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, issue_comment
, or pull_request_review_thread
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.
Доступность для pull_request
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для pull_request
A pull request was assigned to a user.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
assignee object or nullОбязательно | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
number integerОбязательноThe pull request number. | |||
organization objectA GitHub organization. | |||
pull_request objectОбязательно | |||
Properties of | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
pull_request_review_comment
This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "Commenting on a pull request." For information about the APIs to manage pull request review comments, see the GraphQL API documentation or "Pull request review comments" in the REST API documentation.
For activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review
, issue_comment
, or pull_request_review_thread
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.
Доступность для pull_request_review_comment
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для pull_request_review_comment
A comment on a pull request diff was created.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
comment objectОбязательноThe comment itself. | |||
Properties of | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
pull_request objectОбязательно | |||
Properties of | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
pull_request_review
This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "About pull request reviews." For information about the APIs to manage pull request reviews, see the GraphQL API documentation or "Pull request reviews" in the REST API documentation.
For activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment
, issue_comment
, or pull_request_review_thread
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.
Доступность для pull_request_review
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для pull_request_review
A review on a pull request was dismissed.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
pull_request objectОбязательно | |||
Properties of | |||
repository objectОбязательноA repository on GitHub. | |||
review objectОбязательноThe review that was affected. | |||
Properties of | |||
sender objectОбязательноA GitHub user. |
pull_request_review_thread
This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "About pull request reviews." For information about the APIs to manage pull request review comment threads, see the GraphQL API documentation or "Pull request reviews" in the REST API documentation.
For activity related to pull request review comments, pull request comments, or pull request reviews, use the pull_request_review_comment
, issue_comment
, or pull_request_review
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.
Доступность для pull_request_review_thread
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для pull_request_review_thread
A comment thread on a pull request was marked as resolved.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
pull_request objectОбязательно | |||
Properties of | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectA GitHub user. | |||
thread objectОбязательно | |||
Properties of |
push
This event occurs when a commit or tag is pushed.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Note: An event will not be created when more than three tags are pushed at once.
Доступность для push
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для push
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
after stringОбязательноThe SHA of the most recent commit on | |||
base_ref string or nullОбязательно | |||
before stringОбязательноThe SHA of the most recent commit on | |||
commits array of objectsОбязательноAn array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the | |||
Properties of | |||
compare stringОбязательноURL that shows the changes in this | |||
created booleanОбязательноWhether this push created the | |||
deleted booleanОбязательноWhether this push deleted the | |||
enterprise objectAn enterprise on GitHub. | |||
forced booleanОбязательноWhether this push was a force push of the | |||
head_commit object or nullОбязательно | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
pusher objectОбязательноMetaproperties for Git author/committer information. | |||
Properties of | |||
ref stringОбязательноThe full git ref that was pushed. Example: | |||
repository objectОбязательноA git repository | |||
sender objectA GitHub user. |
registry_package
This event occurs when there is activity relating to GitHub Packages. For more information, see "Introduction to GitHub Packages." For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or "Packages" in the REST API documentation.
To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.
Note: GitHub recommends that you use the newer package
event instead.
Доступность для registry_package
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для registry_package
A package was published to a registry.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
registry_package objectОбязательно | |||
Properties of | |||
repository objectA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
release
This event occurs when there is activity relating to releases. For more information, see "About releases." For information about the APIs to manage releases, see the GraphQL API documentation or "Releases" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Доступность для release
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для release
A draft was saved, or a release or pre-release was published without previously being saved as a draft.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
release objectОбязательноThe release object. | |||
Properties of | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
repository
This event occurs when there is activity relating to repositories. For more information, see "About repositories." For information about the APIs to manage repositories, see the GraphQL documentation or "Repositories" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.
Доступность для repository
- Приложения GitHub
- Предприятия
- Организации
- Репозитории
Объект полезных данных веб-перехватчика для repository
Someone disabled anonymous Git read access to the repository. For more information, see "Enabling anonymous Git read access for a repository."
Заголовки |
---|
Имя, Тип, Описание |
Параметры запроса |
Имя, Тип, Описание |
action stringОбязательноЗначение: |
enterprise objectAn enterprise on GitHub. |
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. |
organization objectA GitHub organization. |
repository objectA repository on GitHub. |
sender objectA GitHub user. |
repository_dispatch
This event occurs when a GitHub App sends a POST
request to /repos/{owner}/{repo}/dispatches
. For more information, see the REST API documentation for creating a repository dispatch event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Доступность для repository_dispatch
- Приложения GitHub
Объект полезных данных веб-перехватчика для repository_dispatch
The event_type
that was specified in the POST /repos/{owner}/{repo}/dispatches
request body.
Заголовки |
---|
Имя, Тип, Описание |
Параметры запроса |
Имя, Тип, Описание |
action stringОбязательно |
branch stringОбязательно |
client_payload object or nullОбязательно |
enterprise objectAn enterprise on GitHub. |
installation objectОбязательноThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. |
organization objectA GitHub organization. |
repository objectОбязательноA repository on GitHub. |
sender objectОбязательноA GitHub user. |
secret_scanning_alert
This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "About secret scanning." For information about the API to manage secret scanning alerts, see "Secret scanning" in the REST API documentation.
For activity relating to secret scanning alert locations, use the secret_scanning_alert_location
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.
Доступность для secret_scanning_alert
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для secret_scanning_alert
A secret scanning alert was created.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
alert objectОбязательно | |||
Properties of | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectA GitHub user. |
secret_scanning_alert_location
This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.
For more information about secret scanning, see "About secret scanning." For information about the API to manage secret scanning alerts, see "Secret scanning" in the REST API documentation.
For activity relating to secret scanning alerts, use the secret_scanning_alert
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.
Доступность для secret_scanning_alert_location
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для secret_scanning_alert_location
A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringЗначение: | |||
alert objectОбязательно | |||
Properties of | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
location objectОбязательно | |||
Properties of | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. |
security_and_analysis
This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "GitHub security features."
To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.
Доступность для security_and_analysis
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для security_and_analysis
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
changes objectОбязательно | |||
Properties of | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
repository objectОбязательноFull Repository | |||
sender objectA GitHub user. |
sponsorship
This event occurs when there is activity relating to a sponsorship listing. For more information, see "About GitHub Sponsors." For information about the API to manage sponsors, see the GraphQL documentation.
You can only create a sponsorship webhook on GitHub.com. For more information, see "Configuring webhooks for events in your sponsored account."
Доступность для sponsorship
- Спонсируемые учетные записи
Объект полезных данных веб-перехватчика для sponsorship
A sponsorship was cancelled and the last billing cycle has ended.
This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
repository objectA repository on GitHub. | |||
sender objectОбязательноA GitHub user. | |||
sponsorship objectОбязательно | |||
Properties of |
star
This event occurs when there is activity relating to repository stars. For more information about stars, see "Saving repositories with stars." For information about the APIs to manage stars, see the GraphQL documentation or "Starring" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.
Доступность для star
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для star
Someone starred a repository.
Заголовки |
---|
Имя, Тип, Описание |
Параметры запроса |
Имя, Тип, Описание |
action stringОбязательноЗначение: |
enterprise objectAn enterprise on GitHub. |
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. |
organization objectA GitHub organization. |
repository objectОбязательноA repository on GitHub. |
sender objectОбязательноA GitHub user. |
starred_at string or nullОбязательноThe time the star was created. This is a timestamp in ISO 8601 format: |
status
This event occurs when the status of a Git commit changes. For example, commits can be marked as error
, failure
, pending
, or success
. For more information, see "About status checks." For information about the APIs to manage commit statuses, see the GraphQL documentation or "Statuses" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission.
Доступность для status
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для status
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
avatar_url string or null | |||
branches array of objectsОбязательноAn array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. | |||
Properties of | |||
commit objectОбязательно | |||
Properties of | |||
context stringОбязательно | |||
created_at stringОбязательно | |||
description string or nullОбязательноThe optional human-readable description added to the status. | |||
enterprise objectAn enterprise on GitHub. | |||
id integerОбязательноThe unique identifier of the status. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
name stringОбязательно | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. | |||
sha stringОбязательноThe Commit SHA. | |||
state stringОбязательноThe new state. Can be Может быть одним из: | |||
target_url string or nullОбязательноThe optional link added to the status. | |||
updated_at stringОбязательно |
team_add
This event occurs when a team is added to a repository. For more information, see "Managing teams and people with access to your repository."
For activity relating to teams, see the teams
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
Доступность для team_add
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для team_add
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. | |||
team objectОбязательноGroups of organization members that gives permissions on specified repositories. | |||
Properties of |
team
This event occurs when there is activity relating to teams in an organization. For more information, see "About teams."
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
Доступность для team
- Организации
- Предприятия
- Приложения GitHub
Объект полезных данных веб-перехватчика для team
A team was granted access to a repository.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectОбязательноA GitHub organization. | |||
repository objectA git repository | |||
sender objectA GitHub user. | |||
team objectОбязательноGroups of organization members that gives permissions on specified repositories. | |||
Properties of |
user
This event occurs when there is activity relating to user accounts in an enterprise.
Доступность для user
- Предприятия
Объект полезных данных веб-перехватчика для user
A user account was added to the enterprise.
Заголовки |
---|
Имя, Тип, Описание |
Параметры запроса |
Имя, Тип, Описание |
action stringОбязательноЗначение: |
enterprise objectAn enterprise on GitHub. |
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. |
organization objectA GitHub organization. |
repository objectA repository on GitHub. |
sender objectA GitHub user. |
user object or null |
watch
This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "Managing your subscriptions." For information about the APIs to manage watching, see "Watching" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.
Доступность для watch
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для watch
Someone started watching the repository.
Заголовки |
---|
Имя, Тип, Описание |
Параметры запроса |
Имя, Тип, Описание |
action stringОбязательноЗначение: |
enterprise objectAn enterprise on GitHub. |
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. |
organization objectA GitHub organization. |
repository objectОбязательноA repository on GitHub. |
sender objectОбязательноA GitHub user. |
workflow_dispatch
This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "Manually running a workflow."
For activity relating to workflow runs, use the workflow_run
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Доступность для workflow_dispatch
- Приложения GitHub
Объект полезных данных веб-перехватчика для workflow_dispatch
Заголовки |
---|
Имя, Тип, Описание |
Параметры запроса |
Имя, Тип, Описание |
enterprise objectAn enterprise on GitHub. |
inputs object or nullОбязательно |
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. |
organization objectA GitHub organization. |
ref stringОбязательно |
repository objectОбязательноA repository on GitHub. |
sender objectОбязательноA GitHub user. |
workflow stringОбязательно |
workflow_job
This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "Using jobs in a workflow." For information about the API to manage workflow jobs, see "Workflow jobs" in the REST API documentation.
For activity relating to a workflow run instead of a job in a workflow run, use the workflow_run
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.
Доступность для workflow_job
- Предприятия
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для workflow_job
A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.
Заголовки | |||
---|---|---|---|
Имя, Тип, Описание | |||
Параметры запроса | |||
Имя, Тип, Описание | |||
action stringОбязательноЗначение: | |||
enterprise objectAn enterprise on GitHub. | |||
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. | |||
organization objectA GitHub organization. | |||
repository objectОбязательноA repository on GitHub. | |||
sender objectОбязательноA GitHub user. | |||
workflow_job Обязательно | |||
deployment objectA request for a specific ref(branch,sha,tag) to be deployed | |||
Properties of |
workflow_run
This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "About workflows." For information about the APIs to manage workflow runs, see the GraphQL documentation or "Workflow runs" in the REST API documentation.
For activity relating to a job in a workflow run, use the workflow_job
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.
Доступность для workflow_run
- Предприятия
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных веб-перехватчика для workflow_run
A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.
Заголовки |
---|
Имя, Тип, Описание |
Параметры запроса |
Имя, Тип, Описание |
action stringОбязательноЗначение: |
enterprise objectAn enterprise on GitHub. |
installation objectThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. |
organization objectA GitHub organization. |
repository objectОбязательноA repository on GitHub. |
sender objectОбязательноA GitHub user. |
workflow object or nullОбязательно |
workflow_run Обязательно |