有关 Webhook 事件和有效负载
您可以创建订阅此页所列事件的 web 挂钩。 若要限制对服务器的 HTTP 请求数,应仅订阅计划处理的特定事件。 有关详细信息,请参阅“创建 web 挂钩”。
此页面上的每个 Webhook 事件都包含该事件的 Webhook 属性的说明。 如果某个事件包含多个操作,则会包含与每个操作对应的属性。
每个事件仅适用于特定类型的 Webhook。 例如,组织 Webhook 可以订阅 team
事件,但存储库 Webhook 无法订阅。 各个 Webhook 事件的说明列出了事件的可用性。 有关详细信息,请参阅“Webhook 的类型”。
有效负载上限
有效负载上限为 25 MB。 如果事件生成的有效负载较大,GitHub 将不会为该 Webhook 事件传递有效负载。 例如,如果同时推送多个分支或标记,这种情况可能会发生在 create
事件中。 我们建议监控有效负载的大小以确保成功递送。
递送标头
递送到 web 挂钩已配置 URL 端点的 HTTP POST 有效负载将包含几个特殊标头:
X-GitHub-Hook-ID
:Webhook 的唯一标识符。X-GitHub-Event
:触发交付的事件名称。X-GitHub-Delivery
:用于标识事件的全局唯一标识符 (GUID)。X-GitHub-Enterprise-Version
:发送 HTTP POST 有效负载的 GitHub Enterprise Server 实例的版本。X-GitHub-Enterprise-Host
:发送 HTTP POST 有效负载的 GitHub Enterprise Server 实例的主机名。X-Hub-Signature
:如果 Webhook 配置了secret
,则会发送此标头。 这是请求正文的 HMAC 十六进制摘要,它是使用 SHA-1 哈希函数和作为 HMACkey
的secret
生成的。 提供X-Hub-Signature
以便与现有集成兼容。 建议改用更加安全的X-Hub-Signature-256
。X-Hub-Signature-256
:如果 Webhook 配置了secret
,则会发送此标头。 这是请求正文的 HMAC 十六进制摘要,是使用 SHA-256 哈希函数和作为 HMACkey
的secret
生成的。 有关详细信息,请参阅“验证 Webhook 交付”。User-Agent
:此标头始终具有前缀GitHub-Hookshot/
。X-GitHub-Hook-Installation-Target-Type
:创建 Webhook 的资源的类型。X-GitHub-Hook-Installation-Target-ID
:创建 Webhook 的资源的唯一标识符。
要查看每个标头在 Webhook 有效负载中可能呈现的内容,请参阅“Webhook 传递示例”。
Webhook 传递示例
可以选择将有效负载以 JSON 格式 (application/json
) 或作为 URL 编码数据 (x-www-form-urlencoded
) 传递。 下面是一个使用 JSON 格式的 Webhook POST 请求的示例。
> 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_configuration
This event occurs when there is a change to branch protection configurations for a repository. For more information, see "About protected branches." For information about using the APIs to manage branch protection rules, see "Branch protection rule" in 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_configuration
的可用性
- 存储库
- 组织
- GitHub 应用
branch_protection_configuration
的 Webhook 有效负载对象
All branch protections were disabled for a repository.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
branch_protection_rule
This event occurs when there is activity relating to branch protection rules. For more information, see "About protected branches." For information about the APIs to manage branch protection rules, see the GraphQL documentation or "Branch protection" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.
branch_protection_rule
的可用性
- 存储库
- 组织
- GitHub 应用
branch_protection_rule
的 Webhook 有效负载对象
A branch protection rule was created.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
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 应用
cache_sync
的 Webhook 有效负载对象
名称, 类型, 说明 |
---|
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 A GitHub user. |
check_run
This event occurs when there is activity relating to a check run. For information about check runs, see "Getting started with the Checks API." For information about the APIs to manage check runs, see the GraphQL API documentation or "Check Runs" in the REST API documentation.
For activity relating to check suites, use the check-suite
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the rerequested
and requested_action
event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created
and completed
event types in repositories.
Note
The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests
array and a null
value for head_branch
.
check_run
的可用性
- 存储库
- 组织
- GitHub 应用
check_run
的 Webhook 有效负载对象
A check run was completed, and a conclusion is available.
名称, 类型, 说明 |
---|
action string 值: |
check_run object 必须A check performed on the code of a given code change |
Properties of |
installation 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 必须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 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 应用
check_suite
的 Webhook 有效负载对象
All check runs in a check suite have completed, and a conclusion is available.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
code_scanning_alert
This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "About code scanning" and "About code scanning alerts." For information about the API to manage code scanning, see "Code scanning" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission.
code_scanning_alert
的可用性
- 存储库
- 组织
- GitHub 应用
code_scanning_alert
的 Webhook 有效负载对象
A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.
名称, 类型, 说明 |
---|
action string 必须值: |
alert object 必须The code scanning alert involved in the event. |
Properties of |
commit_oid string 必须The commit SHA of the code scanning alert. When the action is |
enterprise 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 必须A GitHub user. |
commit_comment
This event occurs when there is activity relating to commit comments. For more information about commit comments, see "Commenting on a pull request." For information about the APIs to manage commit comments, see the GraphQL API documentation or "Commit comments" in the REST API documentation.
For activity relating to comments on pull request reviews, use the pull_request_review_comment
event. For activity relating to issue comments, use the issue_comment
event. For activity relating to discussion comments, use the discussion_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
commit_comment
的可用性
- 存储库
- 组织
- GitHub 应用
commit_comment
的 Webhook 有效负载对象
Someone commented on a commit.
名称, 类型, 说明 |
---|
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 必须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.
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 应用
create
的 Webhook 有效负载对象
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
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 应用
delete
的 Webhook 有效负载对象
名称, 类型, 说明 |
---|
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 必须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 public preview and subject to change.
dependabot_alert
的可用性
- 存储库
- 组织
- GitHub 应用
dependabot_alert
的 Webhook 有效负载对象
A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.
名称, 类型, 说明 |
---|
action string 必须值: |
alert object 必须A Dependabot alert. |
Properties of |
installation 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 必须A GitHub user. |
deploy_key
This event occurs when there is activity relating to deploy keys. For more information, see "Managing deploy keys." For information about the APIs to manage deploy keys, see the GraphQL API documentation or "Deploy keys" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.
deploy_key
的可用性
- 存储库
- 组织
- GitHub 应用
deploy_key
的 Webhook 有效负载对象
A deploy key was created.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
deployment
This event occurs when there is activity relating to deployments. For more information, see "About deployments." For information about the APIs to manage deployments, see the GraphQL API documentation or "Deployments" in the REST API documentation.
For activity relating to deployment status, use the deployment_status
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.
deployment
的可用性
- 存储库
- 组织
- GitHub 应用
deployment
的 Webhook 有效负载对象
A deployment was created.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
workflow object or null 必须 |
Properties of |
workflow_run object or null 必须 |
Properties of |
deployment_protection_rule
This event occurs when there is activity relating to deployment protection rules. For more information, see "Using environments for deployment." For information about the API to manage deployment protection rules, see the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.
deployment_protection_rule
的可用性
- GitHub 应用
deployment_protection_rule
的 Webhook 有效负载对象
A deployment protection rule was requested for an environment.
名称, 类型, 说明 |
---|
action string 值: |
environment string The name of the environment that has the deployment protection rule. |
event string The event that triggered the deployment protection rule. |
deployment_callback_url string The URL to review the deployment protection rule. |
deployment object A request for a specific ref(branch,sha,tag) to be deployed |
Properties of |
pull_requests array of objects |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
sender object A GitHub user. |
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 应用
deployment_review
的 Webhook 有效负载对象
A deployment review was approved.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
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.
Note
A webhook event is not fired for deployment statuses with an inactive
state.
deployment_status
的可用性
- 存储库
- 组织
- GitHub 应用
deployment_status
的 Webhook 有效负载对象
A new deployment status was created.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
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 public preview and subject to change.
discussion
的可用性
- 存储库
- 组织
- GitHub 应用
discussion
的 Webhook 有效负载对象
A comment on the discussion was marked as the answer.
名称, 类型, 说明 |
---|
action string 必须值: |
answer object 必须 |
Properties of |
discussion object 必须A Discussion in a repository. |
Properties of |
enterprise 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 必须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 public preview and subject to change.
discussion_comment
的可用性
- 存储库
- 组织
- GitHub 应用
discussion_comment
的 Webhook 有效负载对象
A comment on a discussion was created.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
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
的可用性
- 企业
enterprise
的 Webhook 有效负载对象
Anonymous Git read access was disabled.
名称, 类型, 说明 |
---|
action string 必须值: |
sender object A GitHub user. |
fork
This event occurs when someone forks a repository. For more information, see "Fork a repo." For information about the API to manage forks, see "Forks" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
fork
的可用性
- 企业
- 存储库
- 组织
- GitHub 应用
fork
的 Webhook 有效负载对象
名称, 类型, 说明 |
---|
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 必须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 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 应用
github_app_authorization
的 Webhook 有效负载对象
Someone revoked their authorization of a GitHub App.
名称, 类型, 说明 |
---|
action string 必须值: |
sender object 必须A GitHub user. |
gollum
This event occurs when someone creates or updates a wiki page. For more information, see "About wikis."
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
gollum
的可用性
- 存储库
- 组织
- GitHub 应用
gollum
的 Webhook 有效负载对象
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
installation
This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
For more information about GitHub Apps, see "About apps." For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.
installation
的可用性
- GitHub 应用
installation
的 Webhook 有效负载对象
Someone installed a GitHub App on a user or organization account.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
installation_repositories
This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
For more information about GitHub Apps, see "About apps." For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.
installation_repositories
的可用性
- GitHub 应用
installation_repositories
的 Webhook 有效负载对象
A GitHub App installation was granted access to one or more repositories.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
installation_target
This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see "About apps." For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.
installation_target
的可用性
- GitHub 应用
installation_target
的 Webhook 有效负载对象
Somebody renamed the user or organization account that a GitHub App is installed on.
名称, 类型, 说明 |
---|
account object 必须 |
Properties of |
action string 必须值: |
changes object 必须 |
Properties of |
enterprise 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 A GitHub user. |
target_type string 必须 |
issue_comment
This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "About issues" and "About pull requests." For information about the APIs to manage issue comments, see the GraphQL documentation or "Issue comments" in the REST API documentation.
For activity relating to an issue as opposed to comments on an issue, use the issue
event. For activity related to pull request reviews or pull request review comments, use the pull_request_review
or pull_request_review_comment
events. For more information about the different types of pull request comments, see "Working with comments."
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
issue_comment
的可用性
- 存储库
- 组织
- GitHub 应用
issue_comment
的 Webhook 有效负载对象
A comment on an issue or pull request was created.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
issues
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
issues
的可用性
- 存储库
- 组织
- GitHub 应用
issues
的 Webhook 有效负载对象
An issue was assigned to a user.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
label
This event occurs when there is activity relating to labels. For more information, see "Managing labels." For information about the APIs to manage labels, see the GraphQL documentation or "Labels" in the REST API documentation.
If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled
or unlabeled
action type for the issues
, pull_request
, or discussion
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.
label
的可用性
- 存储库
- 组织
- GitHub 应用
label
的 Webhook 有效负载对象
A label was created.
名称, 类型, 说明 |
---|
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 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.
member
的可用性
- 企业
- 存储库
- 组织
- GitHub 应用
member
的 Webhook 有效负载对象
A GitHub user accepted an invitation to a repository.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
membership
This event occurs when there is activity relating to team membership. For more information, see "About teams." For more information about the APIs to manage team memberships, see the GraphQL API documentation or "Team members" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
membership
的可用性
- 组织
- 企业
- GitHub 应用
membership
的 Webhook 有效负载对象
An organization member was added to a team.
名称, 类型, 说明 |
---|
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 市场
- 企业
- 存储库
- 组织
- GitHub 应用
meta
的 Webhook 有效负载对象
The webhook was deleted.
名称, 类型, 说明 |
---|
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 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.
milestone
的可用性
- 存储库
- 组织
- GitHub 应用
milestone
的 Webhook 有效负载对象
A milestone was closed.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
organization
This event occurs when there is activity relating to an organization and its members. For more information, see "About organizations." For information about the APIs to manage organizations, see the GraphQL documentation or "Organizations" in the REST API documentation.
If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block
event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
organization
的可用性
- 组织
- 企业
- GitHub 应用
organization
的 Webhook 有效负载对象
An organization was deleted.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
package
This event occurs when there is activity relating to GitHub Packages. For more information, see "Introduction to GitHub Packages." For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or "Packages" in the REST API documentation.
To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.
package
的可用性
- 存储库
- 组织
- GitHub 应用
package
的 Webhook 有效负载对象
A package was published to a registry.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
page_build
This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see "Configuring a publishing source for your GitHub Pages site." For information about the API to manage GitHub Pages, see "Pages" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission.
page_build
的可用性
- 存储库
- 组织
- GitHub 应用
page_build
的 Webhook 有效负载对象
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
personal_access_token_request
This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "Creating a personal access token."
To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission.
Note
Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.
personal_access_token_request
的可用性
- GitHub 应用
personal_access_token_request
的 Webhook 有效负载对象
A fine-grained personal access token request was approved.
名称, 类型, 说明 |
---|
action string 必须值: |
personal_access_token_request object 必须Details of a Personal Access Token Request. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
organization object 必须A GitHub organization. Webhook payloads contain the |
sender object 必须A GitHub user. |
installation object 必须The GitHub App installation. Webhook payloads contain the |
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 市场
ping
的 Webhook 有效负载对象
名称, 类型, 说明 |
---|
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 A GitHub user. |
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 应用
project_card
的 Webhook 有效负载对象
A note in a project (classic) was converted to an issue.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
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 应用
project
的 Webhook 有效负载对象
A project (classic) was closed.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
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 应用
project_column
的 Webhook 有效负载对象
A column was added to a project (classic).
名称, 类型, 说明 |
---|
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 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 public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
projects_v2
的可用性
- 组织
projects_v2
的 Webhook 有效负载对象
A project in the organization was closed.
名称, 类型, 说明 |
---|
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 必须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 public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
projects_v2_item
的可用性
- 组织
projects_v2_item
的 Webhook 有效负载对象
An item on an organization project was archived. For more information, see "Archiving items from your project."
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
public
This event occurs when repository visibility changes from private to public. For more information, see "Setting repository visibility."
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.
public
的可用性
- 存储库
- 组织
- GitHub 应用
public
的 Webhook 有效负载对象
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
pull_request
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, issue_comment
, or pull_request_review_thread
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.
pull_request
的可用性
- 存储库
- 组织
- GitHub 应用
pull_request
的 Webhook 有效负载对象
A pull request was assigned to a user.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
pull_request_review_comment
This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "Commenting on a pull request." For information about the APIs to manage pull request review comments, see the GraphQL API documentation or "Pull request review comments" in the REST API documentation.
For activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review
, issue_comment
, or pull_request_review_thread
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.
pull_request_review_comment
的可用性
- 存储库
- 组织
- GitHub 应用
pull_request_review_comment
的 Webhook 有效负载对象
A comment on a pull request diff was created.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
pull_request_review
This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "About pull request reviews." For information about the APIs to manage pull request reviews, see the GraphQL API documentation or "Pull request reviews" in the REST API documentation.
For activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment
, issue_comment
, or pull_request_review_thread
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.
pull_request_review
的可用性
- 存储库
- 组织
- GitHub 应用
pull_request_review
的 Webhook 有效负载对象
A review on a pull request was dismissed.
名称, 类型, 说明 |
---|
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 必须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 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 应用
pull_request_review_thread
的 Webhook 有效负载对象
A comment thread on a pull request was marked as resolved.
名称, 类型, 说明 |
---|
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 A GitHub user. |
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 应用
push
的 Webhook 有效负载对象
名称, 类型, 说明 |
---|
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 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.
registry_package
的可用性
- 存储库
- 组织
- GitHub 应用
registry_package
的 Webhook 有效负载对象
A package was published to a registry.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
release
This event occurs when there is activity relating to releases. For more information, see "About releases." For information about the APIs to manage releases, see the GraphQL API documentation or "Releases" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
release
的可用性
- 存储库
- 组织
- GitHub 应用
release
的 Webhook 有效负载对象
A draft was saved, or a release or pre-release was published without previously being saved as a draft.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
repository
This event occurs when there is activity relating to repositories. For more information, see "About repositories." For information about the APIs to manage repositories, see the GraphQL documentation or "Repositories" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.
repository
的可用性
- GitHub 应用
- 企业
- 组织
- 存储库
repository
的 Webhook 有效负载对象
Someone disabled anonymous Git read access to the repository. For more information, see "Enabling anonymous Git read access for a repository."
名称, 类型, 说明 |
---|
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 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. 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 应用
repository_dispatch
的 Webhook 有效负载对象
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
repository_ruleset
This event occurs when there is activity relating to repository rulesets. For more information about repository rulesets, see "Managing rulesets." For more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or "Repository rules" and "Organization rules in the REST API documentation."
To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission.
repository_ruleset
的可用性
- 存储库
- 组织
- GitHub 应用
repository_ruleset
的 Webhook 有效负载对象
A repository ruleset was created.
名称, 类型, 说明 |
---|
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 |
repository_ruleset object 必须A set of rules to apply when specified conditions are met. |
Properties of |
sender object 必须A GitHub user. |
repository_vulnerability_alert
This event occurs when there is activity relating to a security vulnerability alert in a repository.
Warning
Closing down notice: This event is closing down. Use the dependabot_alert
event instead.
repository_vulnerability_alert
的可用性
- 存储库
- 组织
repository_vulnerability_alert
的 Webhook 有效负载对象
A repository vulnerability alert was created.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
secret_scanning_alert
This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "About secret scanning." For information about the API to manage secret scanning alerts, see "Secret scanning" in the REST API documentation.
For activity relating to secret scanning alert locations, use the secret_scanning_alert_location
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.
secret_scanning_alert
的可用性
- 存储库
- 组织
- GitHub 应用
secret_scanning_alert
的 Webhook 有效负载对象
A secret scanning alert was created.
名称, 类型, 说明 |
---|
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 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.
secret_scanning_alert_location
的可用性
- 存储库
- 组织
- GitHub 应用
secret_scanning_alert_location
的 Webhook 有效负载对象
A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.
名称, 类型, 说明 |
---|
action string 值: |
alert object 必须 |
Properties of |
installation 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 必须A GitHub user. |
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 应用
security_advisory
的 Webhook 有效负载对象
A security advisory was published to the GitHub community.
名称, 类型, 说明 |
---|
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 A GitHub user. |
security_and_analysis
This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "GitHub security features."
To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.
security_and_analysis
的可用性
- 存储库
- 组织
- GitHub 应用
security_and_analysis
的 Webhook 有效负载对象
名称, 类型, 说明 |
---|
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 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."
sponsorship
的可用性
- 赞助帐户
sponsorship
的 Webhook 有效负载对象
A sponsorship was cancelled and the last billing cycle has ended.
This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.
名称, 类型, 说明 |
---|
action string 必须值: |
enterprise 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 必须A GitHub user. |
sponsorship object 必须 |
Properties of |
star
This event occurs when there is activity relating to repository stars. For more information about stars, see "Saving repositories with stars." For information about the APIs to manage stars, see the GraphQL documentation or "Starring" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.
star
的可用性
- 存储库
- 组织
- GitHub 应用
star
的 Webhook 有效负载对象
Someone starred a repository.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
starred_at string or null 必须The time the star was created. This is a timestamp in ISO 8601 format: |
status
This event occurs when the status of a Git commit changes. For example, commits can be marked as error
, failure
, pending
, or success
. For more information, see "About status checks." For information about the APIs to manage commit statuses, see the GraphQL documentation or "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 应用
status
的 Webhook 有效负载对象
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
sha string 必须The Commit SHA. |
state string 必须The new state. Can be 可以是以下选项之一: |
target_url string or null 必须The optional link added to the status. |
updated_at string 必须 |
team_add
This event occurs when a team is added to a repository. For more information, see "Managing teams and people with access to your repository."
For activity relating to teams, see the teams
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
team_add
的可用性
- 存储库
- 组织
- GitHub 应用
team_add
的 Webhook 有效负载对象
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
team object 必须Groups of organization members that gives permissions on specified repositories. |
Properties of |
team
This event occurs when there is activity relating to teams in an organization. For more information, see "About teams."
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
team
的可用性
- 组织
- 企业
- GitHub 应用
team
的 Webhook 有效负载对象
A team was granted access to a repository.
名称, 类型, 说明 |
---|
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 A GitHub user. |
team object 必须Groups of organization members that gives permissions on specified repositories. |
Properties of |
user
This event occurs when there is activity relating to user accounts in an enterprise.
user
的可用性
- 企业
user
的 Webhook 有效负载对象
A user account was added to the enterprise.
名称, 类型, 说明 |
---|
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 A GitHub user. |
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 应用
watch
的 Webhook 有效负载对象
Someone started watching the repository.
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
workflow_dispatch
This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "Manually running a workflow."
For activity relating to workflow runs, use the workflow_run
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
workflow_dispatch
的可用性
- GitHub 应用
workflow_dispatch
的 Webhook 有效负载对象
名称, 类型, 说明 |
---|
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 必须A GitHub user. |
workflow string 必须 |
workflow_job
This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "Using jobs in a workflow." For information about the API to manage workflow jobs, see "Workflow jobs" in the REST API documentation.
For activity relating to a workflow run instead of a job in a workflow run, use the workflow_run
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.
workflow_job
的可用性
- 企业
- 存储库
- 组织
- GitHub 应用
workflow_job
的 Webhook 有效负载对象
A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.
名称, 类型, 说明 |
---|
action string 必须值: |
enterprise 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 必须A GitHub user. |
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 应用
workflow_run
的 Webhook 有效负载对象
A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.
名称, 类型, 说明 |
---|
action string 必须值: |
enterprise 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 必须A GitHub user. |
workflow object or null 必须 |
Properties of |
workflow_run object 必须 |
Properties of |