Сведения о событиях и полезных данных веб-перехватчика
Вы можете создавать веб-перехватчики, которые подписываются на события, указанные на этой странице. Чтобы ограничить количество HTTP-запросов на сервер, следует подписаться только на определенные события, которые вы планируете обрабатывать. Дополнительные сведения см. в разделе Создание веб-перехватчиков.
Каждое событие веб-перехватчика на этой странице содержит описание свойств веб-перехватчика для этого события. Если событие имеет несколько действий, будут включены свойства, соответствующие каждому действию.
Каждое событие доступно только для определенных типов веб-перехватчиков. Например, веб-перехватчик организации может подписаться на team
событие, но веб-перехватчик репозитория не может. Описание каждого события веб-перехватчика содержит сведения о доступности этого события. Дополнительные сведения см. в разделе Типы веб-перехватчиков.
Крышка полезных данных
Полезные данные ограничены на 25 МБ. Если событие создает большую полезные данные, GitHub не будет доставлять полезные данные для этого события веб-перехватчика. Это может произойти, например, при событии create
в случае одновременной принудительной отправки большого количества ветвей или тегов. Рекомендуем отслеживать размер полезных данных, чтобы обеспечить доставку.
Заголовки доставки
Полезные данные HTTP POST, которые доставляются на настроенную конечную точку URL-адреса вашего веб-перехватчика, будут содержать несколько специальных заголовков:
X-GitHub-Hook-ID
: уникальный идентификатор веб-перехватчика.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
: этот заголовок отправляется, если веб-перехватчик настроен с помощьюsecret
. Это хэш-хэш HMAC текста запроса и создается с помощью хэш-функции SHA-1 иsecret
HMACkey
.X-Hub-Signature
предоставляется для обеспечения совместимости с существующими интеграциями. Вместо этого рекомендуется использовать более безопасныйX-Hub-Signature-256
вариант.X-Hub-Signature-256
: этот заголовок отправляется, если веб-перехватчик настроен с помощьюsecret
. Это шестнадцатеричный дайджест HMAC текста запроса, который генерируется с использованием хэш-функции SHA-256 иsecret
в качестве HMACkey
. Дополнительные сведения см. в разделе Проверка доставки веб-перехватчика.User-Agent
: этот заголовок всегда будет иметь префиксGitHub-Hookshot/
.X-GitHub-Hook-Installation-Target-Type
: тип ресурса, в котором был создан веб-перехватчик.X-GitHub-Hook-Installation-Target-ID
: уникальный идентификатор ресурса, в котором был создан веб-перехватчик.
Сведения о том, как выглядит каждый заголовок в полезных данных веб-перехватчика, см. в разделе "Пример доставки веб-перехватчика".
Пример доставки веб-перехватчика
Полезные данные, доставленные в формате JSON () или в формате URL-адреса (application/json``x-www-form-urlencoded
). Ниже приведен пример запроса POST веб-перехватчика, использующего формат JSON.
> POST /payload HTTP/2
> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958
> X-GitHub-Enterprise-Version: 2.15.0
> X-GitHub-Enterprise-Host: example.com
> 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
> X-GitHub-Hook-ID: 292430182
> X-GitHub-Hook-Installation-Target-ID: 79929171
> X-GitHub-Hook-Installation-Target-Type: repository
> {
> "action": "opened",
> "issue": {
> "url": "http(s)://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
Объект полезных данных webhook для branch_protection_rule
A branch protection rule was created.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
rule object Обязательное полеThe branch protection rule. Includes a |
Properties of |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
cache_sync
This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see "About repository caching."
Доступность для cache_sync
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных webhook для cache_sync
Имя., Тип, Description |
---|
after string Обязательное поле |
before string Обязательное поле |
cache_location string Обязательное поле |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
ref string Обязательное поле |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для check_run
A check run was completed, and a conclusion is available.
Имя., Тип, Description |
---|
action string значение: |
check_run object Обязательное полеA check performed on the code of a given code change |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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 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 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
Объект полезных данных webhook для check_suite
All check runs in a check suite have completed, and a conclusion is available.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
check_suite object Обязательное полеThe check_suite. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для 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.
Имя., Тип, Description |
---|
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 object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
ref string Обязательное полеThe Git reference of the code scanning alert. When the action is |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для commit_comment
Someone commented on a commit.
Имя., Тип, Description |
---|
action string Обязательное полеThe action performed. Can be значение: |
comment object Обязательное полеThe commit comment resource. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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.
Notes:
- This event will not occur when more than three tags are created at once.
- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.
Доступность для create
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных webhook для create
Имя., Тип, Description |
---|
description string or null Обязательное полеThe repository's current description. |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
master_branch string Обязательное полеThe name of the repository's default branch (usually |
organization object A GitHub organization. Webhook payloads contain the |
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 Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
delete
This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including
branch and tag deletions, use the push
webhook event.
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
Объект полезных данных webhook для delete
Имя., Тип, Description |
---|
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
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 Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для 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.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
alert object Обязательное полеA Dependabot alert. |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для deploy_key
A deploy key was created.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
key object Обязательное полеThe |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для deployment
A deployment was created.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
deployment object Обязательное полеThe deployment. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
workflow object or null Обязательное поле |
Properties of |
workflow_run object or null Обязательное поле |
Properties of |
deployment_review
This event occurs when there is activity relating to deployment reviews. 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 or deployment status, use the deployment
or deployment_status
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.
Доступность для deployment_review
- Приложения GitHub
Объект полезных данных webhook для deployment_review
A deployment review was approved.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
approver object |
Properties of |
comment string |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object Обязательное полеA GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
reviewers array of objects |
Properties of |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
since string Обязательное поле |
workflow_job_run object |
Properties of |
workflow_job_runs array of objects |
Properties of |
workflow_run object or null Обязательное поле |
Properties of |
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
Объект полезных данных webhook для deployment_status
A new deployment status was created.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
check_run object or null |
Properties of |
deployment object Обязательное полеThe deployment. |
Properties of |
deployment_status object Обязательное полеThe deployment status. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
workflow object or null |
Properties of |
workflow_run object or null |
Properties of |
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
Объект полезных данных webhook для discussion
A comment on the discussion was marked as the answer.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
answer object Обязательное поле |
Properties of |
discussion object Обязательное полеA Discussion in a repository. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для discussion_comment
A comment on a discussion was created.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
comment object Обязательное поле |
Properties of |
discussion object Обязательное полеA Discussion in a repository. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
enterprise
This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see "Enforcing repository management policies in your enterprise."
Доступность для enterprise
- Предприятия
Объект полезных данных webhook для enterprise
Anonymous Git read access was disabled.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для fork
Имя., Тип, Description |
---|
enterprise object An enterprise on GitHub. Webhook payloads contain the |
forkee object Обязательное полеThe created |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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 requests with a user access token, which require GitHub App authorization, see "Authenticating with a GitHub App on behalf of a user."
Доступность для github_app_authorization
- Приложения GitHub
Объект полезных данных webhook для github_app_authorization
Someone revoked their authorization of a GitHub App.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для gollum
Имя., Тип, Description |
---|
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
pages array of objects Обязательное полеThe pages that were updated. |
Properties of |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для installation
Someone installed a GitHub App on a user or organization account.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object Обязательное полеInstallation |
organization object A GitHub organization. Webhook payloads contain the |
repositories array of objects An array of repository objects that the installation can access. |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
requester object or null |
Properties of |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для installation_repositories
A GitHub App installation was granted access to one or more repositories.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object Обязательное полеInstallation |
organization object A GitHub organization. Webhook payloads contain the |
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 object The repository on GitHub where the event occurred. Webhook payloads contain the |
repository_selection string Обязательное полеDescribe whether all repositories have been selected or there's a selection involved Возможные значения: |
requester object or null Обязательное поле |
Properties of |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для installation_target
Somebody renamed the user or organization account that a GitHub App is installed on.
Имя., Тип, Description |
---|
account object Обязательное поле |
Properties of |
action string Обязательное полезначение: |
changes object Обязательное поле |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object Обязательное полеThe GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
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" repository permission.
Доступность для issue_comment
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных webhook для issue_comment
A comment on an issue or pull request was created.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
comment object Обязательное полеThe comment itself. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
issue object Обязательное полеThe issue the comment belongs to. |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для issues
An issue was assigned to a user.
Имя., Тип, Description |
---|
action string Обязательное полеThe action that was performed. значение: |
assignee object or null |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
issue object Обязательное полеThe issue itself. |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для label
A label was created.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
label object Обязательное поле |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для member
A GitHub user accepted an invitation to a repository.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
changes object |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
member object or null Обязательное поле |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для membership
An organization member was added to a team.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
member object or null Обязательное поле |
Properties of |
organization object Обязательное полеA GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
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 |
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
Объект полезных данных webhook для meta
The webhook was deleted.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
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 object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для milestone
A milestone was closed.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
milestone object Обязательное полеA collection of related issues and pull requests. |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для organization
An organization was deleted.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
membership object The membership between the user and the organization. Not present when the action is |
Properties of |
organization object Обязательное полеA GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для package
A package was published to a registry.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
package object Обязательное полеInformation about the package. |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для page_build
Имя., Тип, Description |
---|
build object Обязательное полеThe List GitHub Pages builds itself. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
id integer Обязательное поле |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для ping
Имя., Тип, Description |
---|
hook object The webhook that is being pinged |
Properties of |
hook_id integer The ID of the webhook that triggered the ping. |
organization object A GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
zen string Random string of GitHub zen. |
project_card
This event occurs when there is activity relating to a card on a project (classic). 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 (classic) or a column on a project (classic), use the project
and project_column
event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, 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
Объект полезных данных webhook для project_card
A note in a project (classic) was converted to an issue.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
changes object Обязательное поле |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
project_card object Обязательное поле |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
project
This event occurs when there is activity relating to a project (classic). 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 (classic), use the project_card
and project_column
event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, 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
Объект полезных данных webhook для project
A project (classic) was closed.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
project object Обязательное поле |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
project_column
This event occurs when there is activity relating to a column on a project (classic). 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 (classic) or a card on a project (classic), use the project
and project_card
event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, 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
Объект полезных данных webhook для project_column
A column was added to a project (classic).
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
project_column object Обязательное поле |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
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
- Организации
Объект полезных данных webhook для projects_v2
A project in the organization was closed.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
installation object The GitHub App installation. Webhook payloads contain the |
organization object Обязательное полеA GitHub organization. Webhook payloads contain the |
projects_v2 object Обязательное полеA projects v2 project |
Properties of |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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.
Доступность для projects_v2_item
- Организации
Объект полезных данных webhook для projects_v2_item
An item on an organization project was archived. For more information, see "Archiving items from your project."
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
changes object Обязательное поле |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object Обязательное полеA GitHub organization. Webhook payloads contain the |
projects_v2_item object Обязательное полеAn item belonging to a project |
Properties of |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для public
Имя., Тип, Description |
---|
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для pull_request
A pull request was assigned to a user.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
assignee object or null Обязательное поле |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
number integer Обязательное полеThe pull request number. |
organization object A GitHub organization. Webhook payloads contain the |
pull_request object Обязательное поле |
Properties of |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для pull_request_review_comment
A comment on a pull request diff was created.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
comment object Обязательное полеThe comment itself. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
pull_request object Обязательное поле |
Properties of |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для pull_request_review
A review on a pull request was dismissed.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
pull_request object Обязательное поле |
Properties of |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
review object Обязательное полеThe review that was affected. |
Properties of |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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 reviews, see the GraphQL API documentation or "Pull request review comments" 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
Объект полезных данных webhook для pull_request_review_thread
A comment thread on a pull request was marked as resolved.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
pull_request object Обязательное поле |
Properties of |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
thread object Обязательное поле |
Properties of |
push
This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,
when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch
and tag deletions, use the delete
webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Note: Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.
Доступность для push
- Репозитории
- Организации
- Приложения GitHub
Объект полезных данных webhook для push
Имя., Тип, Description |
---|
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 object An enterprise on GitHub. Webhook payloads contain the |
forced boolean Обязательное полеWhether this push was a force push of the |
head_commit object or null Обязательное поле |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
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 object The GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для registry_package
A package was published to a registry.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
registry_package object Обязательное поле |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для release
A draft was saved, or a release or pre-release was published without previously being saved as a draft.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
release object Обязательное полеThe release object. |
Properties of |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
- Предприятия
- Организации
- Репозитории
Объект полезных данных webhook для repository
Someone disabled anonymous Git read access to the repository. For more information, see "Enabling anonymous Git read access for a repository."
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
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. In the payload, the action
will be the event_type
that was specified in the POST /repos/{owner}/{repo}/dispatches
request body.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Доступность для repository_dispatch
- Приложения GitHub
Объект полезных данных webhook для repository_dispatch
Имя., Тип, Description |
---|
action string Обязательное полеThe |
branch string Обязательное поле |
client_payload object or null Обязательное полеThe |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object Обязательное полеThe GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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.
Доступность для repository_vulnerability_alert
- Репозитории
- Организации
Объект полезных данных webhook для repository_vulnerability_alert
A repository vulnerability alert was created.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
alert object Обязательное полеThe security alert of the vulnerable dependency. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для secret_scanning_alert
A secret scanning alert was created.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
alert object Обязательное поле |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для 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.
Имя., Тип, Description |
---|
action string значение: |
alert object Обязательное поле |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
location object Обязательное поле |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
security_advisory
This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "About global security advisories." For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.
GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "About Dependabot alerts."
Доступность для security_advisory
- Приложения GitHub
Объект полезных данных webhook для security_advisory
A security advisory was published to the GitHub community.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
security_advisory object Обязательное полеThe details of the security advisory, including summary, description, and severity. |
Properties of |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для security_and_analysis
Имя., Тип, Description |
---|
changes object Обязательное поле |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеFull Repository |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
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
- Спонсируемые учетные записи
Объект полезных данных webhook для 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.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для star
Someone starred a repository.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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 "Commit 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
Объект полезных данных webhook для status
Имя., Тип, Description |
---|
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 object An enterprise on GitHub. Webhook payloads contain the |
id integer Обязательное полеThe unique identifier of the status. |
installation object The GitHub App installation. Webhook payloads contain the |
name string Обязательное поле |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для team_add
Имя., Тип, Description |
---|
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для team
A team was granted access to a repository.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object Обязательное полеA GitHub organization. Webhook payloads contain the |
repository object A git repository |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
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
- Предприятия
Объект полезных данных webhook для user
A user account was added to the enterprise.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
user object or null |
Properties of |
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
Объект полезных данных webhook для watch
Someone started watching the repository.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для workflow_dispatch
Имя., Тип, Description |
---|
enterprise object An enterprise on GitHub. Webhook payloads contain the |
inputs object or null Обязательное поле |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
ref string Обязательное поле |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
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
Объект полезных данных webhook для 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.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
workflow_job object Обязательное поле |
Properties of |
deployment object A 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
Объект полезных данных webhook для workflow_run
A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.
Имя., Тип, Description |
---|
action string Обязательное полезначение: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object Обязательное полеThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object Обязательное полеThe GitHub user that triggered the event. This property is included in every webhook payload. |
workflow object or null Обязательное поле |
Properties of |
workflow_run object Обязательное поле |
Properties of |