Skip to main content
Мы публикуем частые обновления нашей документации, и перевод этой страницы, возможно, еще выполняется. Актуальные сведения см. в документации на английском языке.

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

Узнайте, когда происходит каждое событие веб-перехватчика и какие полезные данные содержатся.

Корпоративные учетные записи доступны для GitHub Enterprise Cloud и GitHub Enterprise Server. Дополнительные сведения см. в разделе Сведения о корпоративных учетных записях."

Веб-перехватчики, настроенные для корпоративных учетных записей или организаций, входящих в корпоративную учетную запись, будут включать в себя объект учетной записи enterprise.

При настройке веб-перехватчика можно использовать пользовательский интерфейс или API, чтобы выбрать, какие события будут отправлять полезные данные. Если подписаться только на определенные события, которые вы планируете обрабатывать, вы ограничите количество HTTP-запросов к серверу. Вы также можете подписаться на все текущие и будущие события. По умолчанию веб-перехватчики подписываются только на событие отправки. Список событий, на которые вы подписаны, можно изменить в любое время.

Вы можете создавать веб-перехватчики, которые подписываются на события, указанные на этой странице. Каждое событие веб-перехватчика включает описание свойств веб-перехватчика и пример полезных данных. Дополнительные сведения см. на странице Создание веб-перехватчиков.

Общие свойства объекта полезных данных веб-перехватчика

Все полезные данные события веб-перехватчика также содержат свойства, уникальные для события. Уникальные свойства указаны в разделах отдельных типов событий.

КлючТипОписание
actionstringБольшинство полезных данных веб-перехватчика содержат свойство action, которое содержит конкретное действие, вызвавшее событие.
senderobjectПользователь, который запустил событие. Это свойство включено во все полезные данные веб-перехватчика.
repositoryobjectrepository, где произошло событие. Полезные данные веб-перехватчика содержат свойство repository, когда событие происходит в результате выполнения действия в репозитории.
organizationobjectОбъект organization будет содержаться в полезных данных веб-перехватчика, если такой настроен для организации, либо произойдет событие в результате действия в репозитории, принадлежащем организации. installation

Уникальные свойства для события веб-перехватчика — это те же свойства, которые можно найти в свойстве payload при использовании API отчетов. Единственным исключением является событие push. Уникальные свойства полезных данных веб-перехватчика события push и свойство payload в API событий различаются. Полезные данные веб-перехватчика содержат более подробные сведения.

Примечание. Размер полезных данных не должен превышать 25 МБ. Если ваше событие генерирует полезные данные большего размера, веб-перехватчик не будет запущен. Это может произойти, например, при событии create в случае одновременной принудительной отправки большого количества ветвей или тегов. Рекомендуем отслеживать размер полезных данных, чтобы обеспечить доставку.

Заголовки доставки

Полезные данные HTTP POST, которые доставляются на настроенную конечную точку URL-адреса вашего веб-перехватчика, будут содержать несколько специальных заголовков:

HeaderОписание
X-GitHub-EventНазвание события, активировавшего доставку.
X-GitHub-DeliveryGUID для идентификации доставки.
X-Hub-SignatureЭтот заголовок отправляется, если веб-перехватчик настроен с secret. Это шестнадцатеричный дайджест HMAC текста запроса, который генерируется с использованием хеш-функции SHA-1 и secret в качестве HMAC key. X-Hub-Signature предоставляется для совместимости с существующими интеграциями; мы рекомендуем вместо него использовать более безопасный X-Hub-Signature-256.
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-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6
> 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://api.github.com/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

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A branch protection rule was created.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: created

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

ruleobjectОбязательно

The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A check run was completed, and a conclusion is available.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstring

Значение: completed

check_runobjectОбязательно

A check performed on the code of a given code change

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

All check runs in a check suite have completed, and a conclusion is available.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: completed

actions_metaobject or null
check_suiteobjectОбязательно
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

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.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: appeared_in_branch

alertobjectОбязательно

The code scanning alert involved in the event.

commit_oidstringОбязательно

The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

refstringОбязательно

The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Someone commented on a commit.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

The action performed. Can be created.

Значение: created

commentobjectОбязательно

The commit comment resource.

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
descriptionstring or nullОбязательно

The repository's current description.

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

master_branchstringОбязательно

The name of the repository's default branch (usually main).

organizationobject

A GitHub organization.

pusher_typestringОбязательно

The pusher type for the event. Can be either user or a deploy key.

refstringОбязательно

The git ref resource.

ref_typestringОбязательно

The type of Git ref object created in the repository.

Может быть одним из: tag, branch

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

pusher_typestringОбязательно

The pusher type for the event. Can be either user or a deploy key.

refstringОбязательно

The git ref resource.

ref_typestringОбязательно

The type of Git ref object deleted in the repository.

Может быть одним из: tag, branch

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: created

alertobjectОбязательно

A Dependabot alert.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

enterpriseobject

An enterprise on GitHub.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A deploy key was created.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: created

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

keyobjectОбязательно

The deploy key resource.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

A deployment was created.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: created

deploymentobjectОбязательно
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

A GitHub user.

workflowobject or nullОбязательно
workflow_runobject 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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

A new deployment status was created.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: created

check_runobject or null
deploymentobjectОбязательно
deployment_statusobjectОбязательно
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

A GitHub user.

workflowobject or null
workflow_runobject 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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A comment on the discussion was marked as the answer.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: answered

answerobjectОбязательно
discussionОбязательно
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A comment on a discussion was created.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: created

commentobjectОбязательно
discussionobjectОбязательно
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Предприятия
  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
enterpriseobject

An enterprise on GitHub.

forkeeОбязательно

The created repository resource.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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

Объект полезных данных веб-перехватчика

Someone revoked their authorization of a GitHub App.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: revoked

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobject

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

pagesarray of objectsОбязательно

The pages that were updated.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

Someone installed a GitHub App on a user or organization account.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: created

enterpriseobject

An enterprise on GitHub.

installationobjectОбязательно

Installation

organizationobject

A GitHub organization.

repositoriesarray of objects

An array of repository objects that the installation can access.

repositoryobject

A repository on GitHub.

requesterobject or null
senderobjectОбязательно

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.

Доступность

  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A GitHub App installation was granted access to one or more repositories.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: added

enterpriseobject

An enterprise on GitHub.

installationobjectОбязательно

Installation

organizationobject

A GitHub organization.

repositories_addedarray of objectsОбязательно

An array of repository objects, which were added to the installation.

repositories_removedarray of objectsОбязательно

An array of repository objects, which were removed from the installation.

repositoryobject

A repository on GitHub.

repository_selectionstringОбязательно

Describe whether all repositories have been selected or there's a selection involved

Может быть одним из: all, selected

requesterobject or nullОбязательно
senderobjectОбязательно

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.

Доступность

  • Приложения GitHub

Объект полезных данных веб-перехватчика

Somebody renamed the user or organization account that a GitHub App is installed on.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
accountobjectОбязательно
actionstringОбязательно
changesobjectОбязательно
enterpriseobject

An enterprise on GitHub.

installationobjectОбязательно

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobject

A repository on GitHub.

senderobject

A GitHub user.

target_typestringОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A comment on an issue or pull request was created.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: created

commentobjectОбязательно

The comment itself.

enterpriseobject

An enterprise on GitHub.

installationobject

The 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.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

An issue was assigned to a user.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

The action that was performed.

Значение: assigned

assigneeobject or null
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

issueobjectОбязательно

The issue itself.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A label was created.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: created

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

labelobjectОбязательно
organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobject

A GitHub user.

marketplace_purchase

This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "GitHub Marketplace." For information about the APIs to manage GitHub Marketplace listings, see the GraphQL documentation or "GitHub Marketplace" in the REST API documentation.

Доступность

  • GitHub Marketplace

Объект полезных данных веб-перехватчика

Тип действия

Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: cancelled

effective_datestringОбязательно
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

marketplace_purchaseОбязательно
organizationobject

A GitHub organization.

previous_marketplace_purchaseobject
repositoryobject

A repository on GitHub.

senderobjectОбязательно

A 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.

Доступность

  • Предприятия
  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A GitHub user accepted an invitation to a repository.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: added

changesobject
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

memberobject or nullОбязательно
organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Организации
  • Предприятия
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

An organization member was added to a team.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: added

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

memberobject or nullОбязательно
organizationobjectОбязательно

A GitHub organization.

repositoryobject

A repository on GitHub.

scopestringОбязательно

The scope of the membership. Currently, can only be team.

Значение: team

senderobject or nullОбязательно
teamobjectОбязательно

Groups of organization members that gives permissions on specified repositories.

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 limited private beta and subject to change.

Доступность

  • Приложения GitHub

Объект полезных данных веб-перехватчика

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.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно
installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

merge_groupobjectОбязательно
organizationobject

A GitHub organization.

repositoryobject

A repository on GitHub.

senderobject

A 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.

Доступность

  • GitHub Marketplace
  • Предприятия
  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

The webhook was deleted.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: deleted

enterpriseobject

An enterprise on GitHub.

hookobjectОбязательно

The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.

hook_idintegerОбязательно

The id of the modified webhook.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobject

A repository on GitHub.

senderobject

A 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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A milestone was closed.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: closed

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

milestoneobjectОбязательно

A collection of related issues and pull requests.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

A GitHub user.

org_block

This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "Blocking a user from your organization." For information about the APIs to manage blocked users, see the GraphQL documentation or "Blocking users" in the REST API documentation.

If you want to receive an event when members are added or removed from an organization, use the organization event instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission.

Доступность

  • Организации
  • Предприятия
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A user was blocked from the organization.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: blocked

blocked_userobject or nullОбязательно
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobjectОбязательно

A GitHub organization.

repositoryobject

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Организации
  • Предприятия
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

An organization was deleted.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: deleted

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

membershipobject

The membership between the user and the organization. Not present when the action is member_invited.

organizationobjectОбязательно

A GitHub organization.

repositoryobject

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A package was published to a registry.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: published

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

packageobjectОбязательно

Information about the package.

repositoryobject

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
buildobjectОбязательно
enterpriseobject

An enterprise on GitHub.

idintegerОбязательно
installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub
  • Предприятия
  • GitHub Marketplace

Объект полезных данных веб-перехватчика

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
hookobject

The webhook that is being pinged

hook_idinteger

The ID of the webhook that triggered the ping.

organizationobject

A GitHub organization.

repositoryobject

A repository on GitHub.

senderobject

A GitHub user.

zenstring

Random 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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A note in a classic project was converted to an issue.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: converted

changesobjectОбязательно
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

project_cardobjectОбязательно
repositoryobject

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A classic project was closed.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: closed

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

projectobjectОбязательно
repositoryobject

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A column was added to a classic project.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: created

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

project_columnobjectОбязательно
repositoryobject

A repository on GitHub.

senderobject

A 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.

Доступность

  • Организации

Объект полезных данных веб-перехватчика

Тип действия

A project in the organization was closed.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: closed

organizationobjectОбязательно

A GitHub organization.

projects_v2objectОбязательно

A projects v2 project

senderobjectОбязательно

A GitHub user.

projects_v2_item

This event occurs when there is activity relating to an item on 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 project (instead of an item on a project), use the projects_v2 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.

Доступность

  • Организации

Объект полезных данных веб-перехватчика

Тип действия

An item on an organization project was archived. For more information, see "Archiving items from your project."

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: archived

changesobjectОбязательно
installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobjectОбязательно

A GitHub organization.

projects_v2_itemobjectОбязательно

An item belonging to a project

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A pull request was assigned to a user.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: assigned

assigneeobject or nullОбязательно
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

numberintegerОбязательно

The pull request number.

organizationobject

A GitHub organization.

pull_requestobjectОбязательно
repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A comment on a pull request diff was created.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: created

commentobjectОбязательно

The comment itself.

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

pull_requestobjectОбязательно
repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A review on a pull request was dismissed.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: dismissed

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

pull_requestobjectОбязательно
repositoryobjectОбязательно

A repository on GitHub.

reviewobjectОбязательно

The review that was affected.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A comment thread on a pull request was marked as resolved.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: resolved

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

pull_requestobjectОбязательно
repositoryobjectОбязательно

A repository on GitHub.

senderobject

A GitHub user.

threadobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
afterstringОбязательно

The SHA of the most recent commit on ref after the push.

base_refstring or nullОбязательно
beforestringОбязательно

The SHA of the most recent commit on ref before the push.

commitsarray of objectsОбязательно

An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.

comparestringОбязательно

URL that shows the changes in this ref update, from the before commit to the after commit. For a newly created ref that is directly based on the default branch, this is the comparison between the head of the default branch and the after commit. Otherwise, this shows all commits until the after commit.

createdbooleanОбязательно

Whether this push created the ref.

deletedbooleanОбязательно

Whether this push deleted the ref.

enterpriseobject

An enterprise on GitHub.

forcedbooleanОбязательно

Whether this push was a force push of the ref.

head_commitobject or nullОбязательно
installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

pusherobjectОбязательно

Metaproperties for Git author/committer information.

refstringОбязательно

The full git ref that was pushed. Example: refs/heads/main or refs/tags/v3.14.1.

repositoryobjectОбязательно

A git repository

senderobject

A 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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A package was published to a registry.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: published

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

registry_packageobjectОбязательно
repositoryobject

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A draft was saved, or a release or pre-release was published without previously being saved as a draft.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: created

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

releaseobjectОбязательно

The release object.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Предприятия
  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A repository was archived.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: archived

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

A 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.

Доступность

  • Приложения GitHub

Объект полезных данных веб-перехватчика

The event_type that was specified in the POST /repos/{owner}/{repo}/dispatches request body.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно
branchstringОбязательно
client_payloadobject or nullОбязательно
enterpriseobject

An enterprise on GitHub.

installationobjectОбязательно

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

A GitHub user.

repository_import

This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see "Importing a repository with GitHub Importer." For more information about the API to manage imports, see the REST API documentation.

Доступность

  • Репозитории
  • Организации

Объект полезных данных веб-перехватчика

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

A GitHub user.

statusstringОбязательно

Может быть одним из: success, cancelled, failure

repository_vulnerability_alert

This event occurs when there is activity relating to a security vulnerability alert in a repository.

Note: This event is deprecated. Use the dependabot_alert event instead.

Доступность

  • Репозитории
  • Организации

Объект полезных данных веб-перехватчика

Тип действия

A repository vulnerability alert was created.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: create

alertОбязательно
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A secret scanning alert was created.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: created

alertobjectОбязательно
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobject

A 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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

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.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstring

Значение: created

alertobjectОбязательно
installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

locationobjectОбязательно
organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

A GitHub user.

security_advisory

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "About GitHub Security Advisories for repositories." For information about the API to manage security advisories, see the GraphQL documentation.

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "About Dependabot alerts."

Доступность

  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A security advisory was published to the GitHub community.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: published

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobject

A repository on GitHub.

security_advisoryobjectОбязательно

The details of the security advisory, including summary, description, and severity.

senderobject

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
changesobjectОбязательно
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

Full Repository

senderobject

A 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."

Доступность

  • Спонсируемые учетные записи

Объект полезных данных веб-перехватчика

Тип действия

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.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: cancelled

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobject

A repository on GitHub.

senderobjectОбязательно

A GitHub user.

sponsorshipobjectОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

Someone starred a repository.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: created

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

A GitHub user.

starred_atstring or nullОбязательно

The time the star was created. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Will be null for the deleted action.

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
avatar_urlstring or null
branchesarray 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.

commitobjectОбязательно
contextstringОбязательно
created_atstringОбязательно
descriptionstring or nullОбязательно

The optional human-readable description added to the status.

enterpriseobject

An enterprise on GitHub.

idintegerОбязательно

The unique identifier of the status.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

namestringОбязательно
organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

A GitHub user.

shastringОбязательно

The Commit SHA.

statestringОбязательно

The new state. Can be pending, success, failure, or error.

Может быть одним из: pending, success, failure, error

target_urlstring or nullОбязательно

The optional link added to the status.

updated_atstringОбязательно

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

A GitHub user.

teamobjectОбязательно

Groups of organization members that gives permissions on specified repositories.

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.

Доступность

  • Организации
  • Предприятия
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A team was granted access to a repository.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: added_to_repository

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobjectОбязательно

A GitHub organization.

repositoryobject

A git repository

senderobject

A GitHub user.

teamobjectОбязательно

Groups of organization members that gives permissions on specified repositories.

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.

Доступность

  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Someone started watching the repository.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: started

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

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.

Доступность

  • Приложения GitHub

Объект полезных данных веб-перехватчика

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
enterpriseobject

An enterprise on GitHub.

inputsobject or nullОбязательно
installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

refstringОбязательно
repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

A GitHub user.

workflowstringОбязательно

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.

Доступность

  • Предприятия
  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

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.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: completed

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

A GitHub user.

workflow_jobОбязательно
deploymentobject

A request for a specific ref(branch,sha,tag) to be deployed

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.

Доступность

  • Предприятия
  • Репозитории
  • Организации
  • Приложения GitHub

Объект полезных данных веб-перехватчика

Тип действия

A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.

Заголовки
Имя, Тип, Описание
Параметры запроса
Имя, Тип, Описание
actionstringОбязательно

Значение: completed

enterpriseobject

An enterprise on GitHub.

installationobject

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organizationobject

A GitHub organization.

repositoryobjectОбязательно

A repository on GitHub.

senderobjectОбязательно

A GitHub user.

workflowobject or nullОбязательно
workflow_runОбязательно