Webhook 事件和负载

了解每个 Webhook 事件何时发生以及负载包含什么。

本文内容

关于 Webhook 事件和负载

你可以创建订阅此页面上列出的事件的 Webhook。为了限制对服务器的 HTTP 请求数量，你应仅订阅计划处理的特定事件。有关详细信息，请参阅“创建 Webhooks”。

此页面上的每个 Webhook 事件都包含该事件的 Webhook 属性说明。如果事件有多个操作，则包含与每个操作对应的属性。

每个事件仅适用于特定类型的 Webhook。例如，组织 Webhook 可以订阅 team 事件，但仓库 Webhook 不能。每个 Webhook 事件的说明都列出了该事件的可用性。有关详细信息，请参阅“Webhook 类型”。

负载上限

负载上限为 25 MB。如果事件生成了更大的负载，GitHub 将不会为该 Webhook 事件传递负载。例如，如果一次推送了许多分支或标签，则在 create 事件上可能会发生这种情况。我们建议你监视负载大小以确保交付。

交付标头

交付到 Webhook 配置的 URL 端点的 HTTP POST 负载将包含几个特殊标头

  • X-GitHub-Hook-ID：Webhook 的唯一标识符。
  • X-GitHub-Event：触发交付的事件名称。
  • X-GitHub-Delivery：用于标识事件的全局唯一标识符 (GUID)。
  • X-Hub-Signature：如果 Webhook 配置了 secret，则发送此标头。这是请求正文的 HMAC 十六进制摘要，使用 SHA-1 哈希函数和 secret 作为 HMAC key 生成。提供 X-Hub-Signature 是为了与现有集成兼容。我们建议你改用更安全的 X-Hub-Signature-256。
  • X-Hub-Signature-256：如果 Webhook 配置了 secret，则发送此标头。这是请求正文的 HMAC 十六进制摘要，使用 SHA-256 哈希函数和 secret 作为 HMAC key 生成。有关详细信息，请参阅“验证 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/1.1

> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958
> X-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6
> X-Hub-Signature-256: sha256=d57c68ca6f92289e6987922ff26938930f6e66a2d161ef06abdf1859230aa23c
> User-Agent: GitHub-Hookshot/044aadd
> Content-Type: application/json
> Content-Length: 6615
> X-GitHub-Event: issues
> X-GitHub-Hook-ID: 292430182
> X-GitHub-Hook-Installation-Target-ID: 79929171
> X-GitHub-Hook-Installation-Target-Type: repository

> {
>   "action": "opened",
>   "issue": {
>     "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
>     "number": 1347,
>     ...
>   },
>   "repository" : {
>     "id": 1296269,
>     "full_name": "octocat/Hello-World",
>     "owner": {
>       "login": "octocat",
>       "id": 1,
>       ...
>     },
>     ...
>   },
>   "sender": {
>     "login": "octocat",
>     "id": 1,
>     ...
>   }
> }

branch_protection_configuration

当仓库的分支保护配置发生更改时，会发生此事件。有关详细信息，请参阅“关于受保护分支”。有关使用 API 管理分支保护规则的信息，请参阅 GraphQL 文档中的“分支保护规则”或 REST API 文档中的“分支保护”。

要订阅此事件，GitHub App 必须至少具有“管理”仓库权限的读取级别访问权限。

branch_protection_configuration 的可用性

  • 仓库
  • 组织
  • GitHub Apps

branch_protection_configuration 的 Webhook 负载对象

仓库的所有分支保护均已禁用。

Webhook 请求正文参数
action string 必填

值：disabled

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

branch_protection_rule

当有关于分支保护规则的活动时，会发生此事件。有关详细信息，请参阅“关于受保护分支”。有关管理分支保护规则的 API 信息，请参阅GraphQL 文档或 REST API 文档中的“分支保护”。

要订阅此事件，GitHub App 必须至少具有“管理”仓库权限的读取级别访问权限。

branch_protection_rule 的可用性

  • 仓库
  • 组织
  • GitHub Apps

branch_protection_rule 的 Webhook 负载对象

已创建分支保护规则。

Webhook 请求正文参数
action string 必填

值：created

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

rule object 必填

分支保护规则。包括 name 和适用于匹配该名称的分支的所有分支保护设置。二进制设置是布尔值。多级配置为 off、non_admins 或 everyone 之一。参与者和生成列表是字符串数组。

sender object 必填

一个 GitHub 用户。

check_run

当有关于检查运行的活动时，会发生此事件。有关检查运行的信息，请参阅“检查 API 入门”。有关管理检查运行的 API 信息，请参阅GraphQL API 文档或 REST API 文档中的“检查运行”。

有关检查套件的活动，请使用 check-suite 事件。

要订阅此事件，GitHub App 必须至少具有“检查”仓库权限的读取级别访问权限。要接收 rerequested 和 requested_action 事件类型，App 必须至少具有“检查”权限的写入级别访问权限。具有“检查”权限写入级别访问权限的 GitHub App 会自动订阅此 Webhook 事件。

仓库和组织 Webhook 仅接收仓库中 created 和 completed 事件类型的负载。

API 只查找在创建检查运行的仓库中的推送。推送到派生仓库中的分支不会被检测到，并返回一个空的 pull_requests 数组和 head_branch 的 null 值。

check_run 的可用性

  • 仓库
  • 组织
  • GitHub Apps

check_run 的 Webhook 负载对象

检查运行已完成，结论可用。

Webhook 请求正文参数
action string

值：completed

check_run object 必填

对给定代码更改的代码执行的检查

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

check_suite

当有关于检查套件的活动时，会发生此事件。有关检查套件的信息，请参阅“检查 API 入门”。有关管理检查套件的 API 信息，请参阅GraphQL API 文档或 REST API 文档中的“检查套件”。

有关检查运行的活动，请使用 check_run 事件。

要订阅此事件，GitHub App 必须至少具有“检查”权限的读取级别访问权限。要接收 requested 和 rerequested 事件类型，App 必须至少具有“检查”权限的写入级别访问权限。具有“检查”权限写入级别访问权限的 GitHub App 会自动订阅此 Webhook 事件。

仓库和组织 Webhook 仅接收仓库中 completed 事件类型的负载。

API 只查找在创建检查套件的仓库中的推送。推送到派生仓库中的分支不会被检测到，并返回一个空的 pull_requests 数组和 head_branch 的 null 值。

check_suite 的可用性

  • 仓库
  • 组织
  • GitHub Apps

check_suite 的 Webhook 负载对象

检查套件中的所有检查运行均已完成，结论可用。

Webhook 请求正文参数
action string 必填

值：completed

check_suite object 必填
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

code_scanning_alert

当有关于仓库中代码扫描警报的活动时，会发生此事件。有关详细信息，请参阅“关于代码扫描”和“关于代码扫描警报”。有关管理代码扫描的 API 信息，请参阅 REST API 文档中的“代码扫描”。

要订阅此事件，GitHub App 必须至少具有“代码扫描警报”仓库权限的读取级别访问权限。

code_scanning_alert 的可用性

  • 仓库
  • 组织
  • GitHub Apps

code_scanning_alert 的 Webhook 负载对象

先前创建的代码扫描警报出现在另一个分支中。当分支合并到或从具有预先存在的代码扫描警报的分支创建时，可能会发生这种情况。

Webhook 请求正文参数
action string 必填

值：appeared_in_branch

alert object 必填

事件中涉及的代码扫描警报。

commit_oid string 必填

代码扫描警报的提交 SHA。当操作为 reopened_by_user 或 closed_by_user 时，事件由 sender 触发，此值将为空。

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

ref string 必填

代码扫描警报的 Git 引用。当操作为 reopened_by_user 或 closed_by_user 时，事件由 sender 触发，此值将为空。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

commit_comment

当有关于提交评论的活动时，会发生此事件。有关提交评论的详细信息，请参阅“评论拉取请求”。有关管理提交评论的 API 信息，请参阅GraphQL API 文档或 REST API 文档中的“提交评论”。

有关拉取请求审阅评论的活动，请使用 pull_request_review_comment 事件。有关议题评论的活动，请使用 issue_comment 事件。有关讨论评论的活动，请使用 discussion_comment 事件。

要订阅此事件，GitHub App 必须至少具有“内容”仓库权限的读取级别访问权限。

commit_comment 的可用性

  • 仓库
  • 组织
  • GitHub Apps

commit_comment 的 Webhook 负载对象

有人评论了提交。

Webhook 请求正文参数
action string 必填

执行的操作。可以是 created。

值：created

comment object 必填

提交评论资源。

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

create

当创建 Git 分支或标签时，会发生此事件。

要订阅此事件，GitHub App 必须至少具有“内容”仓库权限的读取级别访问权限。

注意:

  • 一次创建超过三个标签时，此事件将不会发生。
  • 负载上限为 25 MB。如果事件生成了更大的负载，GitHub 将不会为该 Webhook 事件传递负载。例如，如果一次推送了许多分支或标签，则可能会发生这种情况。我们建议你监视负载大小以确保交付。

create 的可用性

  • 仓库
  • 组织
  • GitHub Apps

create 的 Webhook 负载对象

Webhook 请求正文参数
description string or null 必填

仓库的当前描述。

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

master_branch string 必填

仓库默认分支的名称（通常为 main）。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

pusher_type string 必填

事件的推送者类型。可以是 user 或部署密钥。

ref string 必填

git ref 资源。

ref_type string 必填

仓库中创建的 Git ref 对象的类型。

可以是以下之一：tag、branch

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

custom_property

当有关于自定义属性的活动时，会发生此事件。

有关详细信息，请参阅“管理组织中仓库的自定义属性”。有关管理自定义属性的 API 信息，请参阅 REST API 文档中的“自定义属性”。

要订阅此事件，GitHub App 必须至少具有“自定义属性”组织权限的读取级别访问权限。

custom_property 的可用性

  • 企业
  • 组织
  • GitHub Apps

custom_property 的 Webhook 负载对象

已创建新的自定义属性。

Webhook 请求正文参数
action string 必填

值：created

definition object 必填

组织上定义的自定义属性

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

sender object

一个 GitHub 用户。

custom_property_values

当有关于仓库自定义属性值的活动时，会发生此事件。

有关详细信息，请参阅“管理组织中仓库的自定义属性”。有关管理仓库自定义属性的 API 信息，请参阅 REST API 文档中的“自定义属性”。

要订阅此事件，GitHub App 必须至少具有“自定义属性”组织权限的读取级别访问权限。

custom_property_values 的可用性

  • 仓库
  • 组织
  • GitHub Apps

custom_property_values 的 Webhook 负载对象

仓库的自定义属性值已更新。

Webhook 请求正文参数
action string 必填

值：updated

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

organization object 必填

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

sender object

一个 GitHub 用户。

new_property_values array of objects 必填

仓库的新自定义属性值。

old_property_values array of objects 必填

仓库的旧自定义属性值。

delete

当 Git 分支或标签被删除时，会发生此事件。要订阅对仓库的所有推送，包括分支和标签删除，请使用 push Webhook 事件。

要订阅此事件，GitHub App 必须至少具有“内容”仓库权限的读取级别访问权限。

一次删除超过三个标签时，此事件将不会发生。

delete 的可用性

  • 仓库
  • 组织
  • GitHub Apps

delete 的 Webhook 负载对象

Webhook 请求正文参数
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

pusher_type string 必填

事件的推送者类型。可以是 user 或部署密钥。

ref string 必填

git ref 资源。

ref_type string 必填

仓库中删除的 Git ref 对象类型。

可以是以下之一：tag、branch

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

dependabot_alert

当有关于 Dependabot 警报的活动时，会发生此事件。

有关 Dependabot 警报的详细信息，请参阅“关于 Dependabot 警报”。有关管理 Dependabot 警报的 API 信息，请参阅 REST API 文档中的“Dependabot 警报”。

要订阅此事件，GitHub App 必须至少具有“Dependabot 警报”仓库权限的读取级别访问权限。

dependabot_alert 的可用性

  • 仓库
  • 组织
  • GitHub Apps

dependabot_alert 的 Webhook 负载对象

Dependabot 警报的受让人已更新。

Webhook 请求正文参数
action string 必填

值：assignees_changed

alert object 必填

一个 Dependabot 警报。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

deploy_key

当有关于部署密钥的活动时，会发生此事件。有关详细信息，请参阅“管理部署密钥”。有关管理部署密钥的 API 信息，请参阅GraphQL API 文档或 REST API 文档中的“部署密钥”。

要订阅此事件，GitHub App 必须至少具有“部署”仓库权限的读取级别访问权限。

deploy_key 的可用性

  • 仓库
  • 组织
  • GitHub Apps

deploy_key 的 Webhook 负载对象

已创建部署密钥。

Webhook 请求正文参数
action string 必填

值：created

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

key object 必填

部署密钥资源。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

deployment

当有关于部署的活动时，会发生此事件。有关详细信息，请参阅“关于部署”。有关管理部署的 API 信息，请参阅GraphQL API 文档或 REST API 文档中的“部署”。

有关部署状态的活动，请使用 deployment_status 事件。

要订阅此事件，GitHub App 必须至少具有“部署”仓库权限的读取级别访问权限。

deployment 的可用性

  • 仓库
  • 组织
  • GitHub Apps

deployment 的 Webhook 负载对象

已创建部署。

Webhook 请求正文参数
action string 必填

值：created

deployment object 必填
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

workflow object or null 必填
workflow_run object or null 必填

deployment_protection_rule

当有关于部署保护规则的活动时，会发生此事件。有关详细信息，请参阅“使用环境进行部署”。有关管理部署保护规则的 API 信息，请参阅REST API 文档。

要订阅此事件，GitHub App 必须至少具有“部署”仓库权限的读取级别访问权限。

deployment_protection_rule 的可用性

  • GitHub Apps

deployment_protection_rule 的 Webhook 负载对象

已为环境请求部署保护规则。

Webhook 请求正文参数
action string

值：requested

environment string

具有部署保护规则的环境名称。

event string

触发部署保护规则的事件。

sha string

触发工作流的提交 SHA。始终从检查套件填充，无论是否创建部署。

ref string

触发工作流的引用（分支或标签）。始终从检查套件填充，无论是否创建部署。

deployment_callback_url string

用于审查部署保护规则的 URL。

deployment object or null

部署特定引用（分支、SHA、标签）的请求

pull_requests array of objects
repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

sender object

一个 GitHub 用户。

deployment_review

当有关于部署审阅的活动时，会发生此事件。有关详细信息，请参阅“关于部署”。有关管理部署的 API 信息，请参阅GraphQL API 文档或 REST API 文档中的“部署”。

有关部署创建或部署状态的活动，请使用 deployment 或 deployment_status 事件。

要订阅此事件，GitHub App 必须至少具有“部署”仓库权限的读取级别访问权限。

deployment_review 的可用性

  • GitHub Apps

deployment_review 的 Webhook 负载对象

部署审阅已获批准。

Webhook 请求正文参数
action string 必填

值：approved

approver object
comment string
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object 必填

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

reviewers array of objects
sender object 必填

一个 GitHub 用户。

since string 必填
workflow_job_run object
workflow_job_runs array of objects
workflow_run object or null 必填

deployment_status

当有关于部署状态的活动时，会发生此事件。有关详细信息，请参阅“关于部署”。有关管理部署的 API 信息，请参阅GraphQL API 文档或 REST API 文档中的“部署”。

有关部署创建的活动，请使用 deployment 事件。

要订阅此事件，GitHub App 必须至少具有“部署”仓库权限的读取级别访问权限。

状态为 inactive 的部署状态不会触发 Webhook 事件。

deployment_status 的可用性

  • 仓库
  • 组织
  • GitHub Apps

deployment_status 的 Webhook 负载对象

已创建新的部署状态。

Webhook 请求正文参数
action string 必填

值：created

check_run object or null
deployment object 必填
deployment_status object 必填
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

workflow object or null
workflow_run object or null

discussion

当有关于讨论的活动时，会发生此事件。有关讨论的详细信息，请参阅“GitHub Discussions”。有关管理讨论的 API 信息，请参阅GraphQL 文档。

有关讨论评论的活动，请使用 discussion_comment 事件。

要订阅此事件，GitHub App 必须至少具有“讨论”仓库权限的读取级别访问权限。

GitHub Discussions 的 Webhook 事件目前处于公开预览阶段，可能会有所更改。

discussion 的可用性

  • 仓库
  • 组织
  • GitHub Apps

discussion 的 Webhook 负载对象

讨论中的评论被标记为答案。

Webhook 请求正文参数
action string 必填

值：answered

answer object 必填
discussion object 必填

仓库中的讨论。

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

discussion_comment

当有关于讨论评论的活动时，会发生此事件。有关讨论的详细信息，请参阅“GitHub Discussions”。有关管理讨论的 API 信息，请参阅GraphQL 文档。

有关讨论本身的活动而不是评论的活动，请使用 discussion 事件。

要订阅此事件，GitHub App 必须至少具有“讨论”仓库权限的读取级别访问权限。

GitHub Discussions 的 Webhook 事件目前处于公开预览阶段，可能会有所更改。

discussion_comment 的可用性

  • 仓库
  • 组织
  • GitHub Apps

discussion_comment 的 Webhook 负载对象

已创建讨论评论。

Webhook 请求正文参数
action string 必填

值：created

comment object 必填
discussion object 必填

仓库中的讨论。

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

fork

当有人派生仓库时，会发生此事件。有关详细信息，请参阅“派生仓库”。有关管理派生仓库的 API 信息，请参阅 REST API 文档中的“派生”。

要订阅此事件，GitHub App 必须至少具有“内容”仓库权限的读取级别访问权限。

fork 的可用性

  • 企业
  • 仓库
  • 组织
  • GitHub Apps

fork 的 Webhook 负载对象

Webhook 请求正文参数
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

forkee object 必填

创建的仓库资源。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

github_app_authorization

当用户撤销对 GitHub App 的授权时，会发生此事件。有关详细信息，请参阅“关于应用程序”。有关管理 GitHub App 的 API 信息，请参阅GraphQL API 文档或 REST API 文档中的“应用程序”。

GitHub App 默认接收此 Webhook，无法取消订阅此事件。

任何人都可以从其GitHub 帐户设置页面撤销对 GitHub App 的授权。撤销对 GitHub App 的授权不会卸载 GitHub App。你应该对 GitHub App 进行编程，使其在收到此 Webhook 时停止代表撤销令牌的人员调用 API。如果你的 GitHub App 继续使用已撤销的访问令牌，它将收到 401 Bad Credentials 错误。有关需要 GitHub App 授权的用户访问令牌请求的详细信息，请参阅“代表用户进行 GitHub App 身份验证”。

github_app_authorization 的可用性

  • GitHub Apps

github_app_authorization 的 Webhook 负载对象

有人撤销了他们对 GitHub App 的授权。

Webhook 请求正文参数
action string 必填

值：revoked

sender object 必填

一个 GitHub 用户。

gollum

当有人创建或更新 Wiki 页面时，会发生此事件。有关详细信息，请参阅“关于 Wiki”。

要订阅此事件，GitHub App 必须至少具有“内容”仓库权限的读取级别访问权限。

gollum 的可用性

  • 仓库
  • 组织
  • GitHub Apps

gollum 的 Webhook 负载对象

Webhook 请求正文参数
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

pages array of objects 必填

已更新的页面。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

installation

当有关于 GitHub App 安装的活动时，会发生此事件。所有 GitHub App 默认接收此事件。你无法手动订阅此事件。

有关 GitHub App 的详细信息，请参阅“关于应用程序”。有关管理 GitHub App 的 API 信息，请参阅GraphQL API 文档或 REST API 文档中的“应用程序”。

installation 的可用性

  • GitHub Apps

installation 的 Webhook 负载对象

有人在用户或组织帐户上安装了 GitHub App。

Webhook 请求正文参数
action string 必填

值：created

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object 必填

安装

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repositories array of objects

安装可以访问的仓库对象数组。

repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

requester object or null
sender object 必填

一个 GitHub 用户。

installation_repositories

当有关于 GitHub App 安装可以访问哪些仓库的活动时，会发生此事件。所有 GitHub App 默认接收此事件。你无法手动订阅此事件。

有关 GitHub App 的详细信息，请参阅“关于应用程序”。有关管理 GitHub App 的 API 信息，请参阅GraphQL API 文档或 REST API 文档中的“应用程序”。

installation_repositories 的可用性

  • GitHub Apps

installation_repositories 的 Webhook 负载对象

GitHub App 安装获得了对一个或多个仓库的访问权限。

Webhook 请求正文参数
action string 必填

值：added

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object 必填

安装

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repositories_added array of objects 必填

已添加到安装的仓库对象数组。

repositories_removed array of objects 必填

已从安装中删除的仓库对象数组。

repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

repository_selection string 必填

描述是否已选择所有仓库或涉及选择

可以是以下之一：all、selected

requester object or null 必填
sender object 必填

一个 GitHub 用户。

installation_target

当有关于安装了 GitHub App 的用户或组织帐户的活动时，会发生此事件。有关详细信息，请参阅“关于应用程序”。有关管理 GitHub App 的 API 信息，请参阅GraphQL API 文档或 REST API 文档中的“应用程序”。

installation_target 的可用性

  • GitHub Apps

installation_target 的 Webhook 负载对象

有人重命名了安装了 GitHub App 的用户或组织帐户。

Webhook 请求正文参数
account object 必填
action string 必填

值：renamed

changes object 必填
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object 必填

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object

一个 GitHub 用户。

target_type string 必填

issue_comment

当有关于议题或拉取请求评论的活动时，会发生此事件。有关议题和拉取请求的详细信息，请参阅“关于议题”和“关于拉取请求”。有关管理议题评论的 API 信息，请参阅GraphQL 文档或 REST API 文档中的“议题评论”。

有关议题本身的活动而不是评论的活动，请使用 issue 事件。有关拉取请求审阅或拉取请求审阅评论的活动，请使用 pull_request_review 或 pull_request_review_comment 事件。有关不同类型的拉取请求评论的详细信息，请参阅“使用评论”。

要订阅此事件，GitHub App 必须至少具有“议题”仓库权限的读取级别访问权限。

issue_comment 的可用性

  • 仓库
  • 组织
  • GitHub Apps

issue_comment 的 Webhook 负载对象

已创建议题或拉取请求评论。

Webhook 请求正文参数
action string 必填

值：created

comment object 必填

评论本身。

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

issue object 必填

评论所属的议题。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

issue_dependencies

当有关于议题依赖项的活动时，例如阻塞或被阻塞关系，会发生此事件。

更普遍地，有关议题的活动，请改用 issues 事件。

要订阅此事件，GitHub App 必须至少具有“议题”仓库权限的读取级别访问权限。

issue_dependencies 的可用性

  • 仓库
  • 组织
  • GitHub Apps

issue_dependencies 的 Webhook 负载对象

一个议题已被标记为受另一个议题阻塞。

Webhook 请求正文参数
action string 必填

值：blocked_by_added

blocked_issue_id number

被阻塞议题 (blocked issue) 的 ID。

blocked_issue object

议题是跟踪项目任务、增强功能和 bug 的绝佳方式。

blocking_issue_id number

阻塞议题 (blocking issue) 的 ID。

blocking_issue object

议题是跟踪项目任务、增强功能和 bug 的绝佳方式。

blocking_issue_repo object

GitHub 上的仓库。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object 必填

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

issues

当有关于议题的活动时，会发生此事件。有关议题的详细信息，请参阅“关于议题”。有关管理议题的 API 信息，请参阅GraphQL 文档或 REST API 文档中的“议题”。

有关议题评论的活动，请使用 issue_comment 事件。

要订阅此事件，GitHub App 必须至少具有“议题”仓库权限的读取级别访问权限。

issues 的可用性

  • 仓库
  • 组织
  • GitHub Apps

issues 的 Webhook 负载对象

议题已分配给用户。

Webhook 请求正文参数
action string 必填

执行的操作。

值：assigned

assignee object or null
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

issue object 必填

评论所属的议题。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

label

当有关于标签的活动时，会发生此事件。有关详细信息，请参阅“管理标签”。有关管理标签的 API 信息，请参阅GraphQL 文档或 REST API 文档中的“标签”。

如果你想在标签被添加到议题、拉取请求或讨论或从中删除时接收事件，请改用 issues、pull_request 或 discussion 事件的 labeled 或 unlabeled 操作类型。

要订阅此事件，GitHub App 必须至少具有“元数据”仓库权限的读取级别访问权限。

label 的可用性

  • 仓库
  • 组织
  • GitHub Apps

label 的 Webhook 负载对象

已创建标签。

Webhook 请求正文参数
action string 必填

值：created

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

label object 必填
organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object

一个 GitHub 用户。

marketplace_purchase

当有关于 GitHub Marketplace 购买的活动时，会发生此事件。有关详细信息，请参阅“GitHub Marketplace”。有关管理 GitHub Marketplace 列表的 API 信息，请参阅GraphQL 文档或 REST API 文档中的“GitHub Marketplace”。

marketplace_purchase 的可用性

  • GitHub Marketplace

用于 marketplace_purchase 的 Webhook 负载对象

有人取消了 GitHub Marketplace 计划，并且最后一个计费周期已结束。此更改将立即对帐户生效。

Webhook 请求正文参数
action string 必填

值：cancelled

effective_date 字符串 必需
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

marketplace_purchase 对象 必需
organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

previous_marketplace_purchase 对象
repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

member

此事件在存储库中的协作者有活动时发生。有关更多信息，请参阅“向组织中的存储库添加外部协作者”。有关管理存储库协作者 API 的更多信息，请参阅GraphQL API 文档或 REST API 文档中的“协作者”。

要订阅此事件，GitHub App 必须至少具有“成员”组织权限的读取级别访问权限。

member 的可用性

  • 企业
  • 仓库
  • 组织
  • GitHub Apps

用于 member 的 Webhook 负载对象

GitHub 用户接受了对存储库的邀请。

Webhook 请求正文参数
action string 必填

值：added

changes 对象
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

member 对象或空值 必需
organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

membership

此事件在团队成员资格有活动时发生。有关更多信息，请参阅“关于团队”。有关管理团队成员资格 API 的更多信息，请参阅GraphQL API 文档或 REST API 文档中的“团队成员”。

要订阅此事件，GitHub App 必须至少具有“成员”组织权限的读取级别访问权限。

membership 的可用性

  • 组织
  • 企业
  • GitHub Apps

用于 membership 的 Webhook 负载对象

组织成员被添加到一个团队。

Webhook 请求正文参数
action string 必填

值：added

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

member 对象或空值 必需
organization object 必填

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

scope 字符串 必需

成员资格的范围。目前只能是 team。

值：team

sender 对象或空值 必需
team 对象 必需

组织成员组，授予对指定存储库的权限。

merge_group

此事件在合并队列中的合并组有活动时发生。有关更多信息，请参阅“管理合并队列”。

要订阅此事件，GitHub App 必须至少具有“合并队列”存储库权限的读取级别访问权限。

merge_group 的可用性

  • GitHub Apps

用于 merge_group 的 Webhook 负载对象

已为合并组请求状态检查。这发生在合并队列创建或添加合并组时，因为拉取请求已排队。

收到此事件时，您应该对 HEAD SHA 执行检查，并使用检查运行或提交状态报告状态。

Webhook 请求正文参数
action string 必填

值：checks_requested

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

merge_group 对象 必需

合并队列已分组在一起要合并的一组拉取请求。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object

一个 GitHub 用户。

meta

此事件在与 Webhook 本身相关的活动发生时触发。

要订阅此事件，GitHub App 必须至少具有“元数据”应用权限的读取级别访问权限。

meta 的可用性

  • GitHub Marketplace
  • 企业
  • 仓库
  • 组织
  • GitHub Apps

用于 meta 的 Webhook 负载对象

Webhook 已删除。

Webhook 请求正文参数
action string 必填

值：deleted

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

hook 对象 必需

已删除的 Webhook。这将根据 Webhook 的类型（存储库、组织、业务、应用或 GitHub Marketplace）包含不同的键。

hook_id 整数 必需

修改后的 Webhook 的 ID。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository 对象或空值

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object

一个 GitHub 用户。

milestone

此事件在与里程碑相关的活动发生时触发。有关更多信息，请参阅“关于里程碑”。有关管理里程碑 API 的信息，请参阅GraphQL 文档或 REST API 文档中的“里程碑”。

如果要接收问题或拉取请求被添加到或从里程碑中删除的事件，请改为使用 issues 或 pull_request 事件的 milestoned 或 demilestoned 操作类型。

要订阅此事件，GitHub App 必须至少具有“问题”或“拉取请求”存储库权限的读取级别访问权限。

milestone 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 milestone 的 Webhook 负载对象

里程碑已关闭。

Webhook 请求正文参数
action string 必填

值：closed

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

milestone 对象 必需

相关问题和拉取请求的集合。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

org_block

此事件在组织所有者或管理员阻止或解除阻止非成员在组织的存储库上协作时触发。有关更多信息，请参阅“从组织中阻止用户”。有关管理被阻止用户 API 的信息，请参阅GraphQL 文档或 REST API 文档中的“阻止用户”。

如果要接收成员被添加到或从组织中删除的事件，请改为使用 organization 事件。

要订阅此事件，GitHub App 必须至少具有“管理”组织权限的读取级别访问权限。

org_block 的可用性

  • 组织
  • 企业
  • GitHub Apps

用于 org_block 的 Webhook 负载对象

用户已被组织阻止。

Webhook 请求正文参数
action string 必填

值：blocked

blocked_user 对象或空值 必需
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object 必填

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

organization

此事件在与组织及其成员相关的活动发生时触发。有关更多信息，请参阅“关于组织”。有关管理组织 API 的信息，请参阅GraphQL 文档或 REST API 文档中的“组织”。

如果要接收非成员被组织阻止或解除阻止的事件，请改为使用 org_block 事件。

要订阅此事件，GitHub App 必须至少具有“成员”组织权限的读取级别访问权限。

organization 的可用性

  • 组织
  • 企业
  • GitHub Apps

用于 organization 的 Webhook 负载对象

组织已删除。

Webhook 请求正文参数
action string 必填

值：deleted

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

membership 对象

用户和组织之间的成员资格。当操作为 member_invited 时不存在。

organization object 必填

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

package

此事件在与 GitHub Packages 相关的活动发生时触发。有关更多信息，请参阅“GitHub Packages 简介”。有关管理 GitHub Packages API 的信息，请参阅GraphQL API 文档或 REST API 文档中的“Packages”。

package 的可用性

  • 仓库
  • 组织

用于 package 的 Webhook 负载对象

包已发布到注册表。

Webhook 请求正文参数
action string 必填

值：published

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

package 对象 必需

有关包的信息。

repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

page_build

此事件在尝试构建 GitHub Pages 站点时触发。无论构建是否成功，此事件都会发生。有关更多信息，请参阅“为 GitHub Pages 站点配置发布源”。有关管理 GitHub Pages API 的信息，请参阅 REST API 文档中的“Pages”。

要订阅此事件，GitHub App 必须至少具有“Pages”存储库权限的读取级别访问权限。

page_build 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 page_build 的 Webhook 负载对象

Webhook 请求正文参数
build 对象 必需
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

id 整数 必需
installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

personal_access_token_request

当有活动涉及请求细粒度个人访问令牌以访问需要令牌访问批准的资源所有者所属的资源时，会发生此事件。有关更多信息，请参阅“创建个人访问令牌”。

要订阅此事件，GitHub App 必须至少具有“个人访问令牌请求”组织权限的读取级别访问权限。

personal_access_token_request 的可用性

  • GitHub Apps
  • 组织

用于 personal_access_token_request 的 Webhook 负载对象

已批准细粒度个人访问令牌请求。

Webhook 请求正文参数
action string 必填

值：approved

personal_access_token_request 对象 必需

个人访问令牌请求的详细信息。

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

organization object 必填

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

sender object 必填

一个 GitHub 用户。

installation object 必填

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

ping

此事件在您创建新的 Webhook 时触发。ping 事件是 GitHub 发出的确认，表示您已正确配置 Webhook。

ping 的可用性

  • 仓库
  • 组织
  • GitHub Apps
  • 企业
  • GitHub Marketplace

用于 ping 的 Webhook 负载对象

Webhook 请求正文参数
hook 对象

正在 ping 的 Webhook

hook_id 整数

触发 ping 的 Webhook 的 ID。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object

一个 GitHub 用户。

zen 字符串

GitHub zen 的随机字符串。

project_card

当项目（经典版）上的卡片有活动时，会发生此事件。有关更多信息，请参阅“关于项目（经典版）”。有关管理经典项目 API 的信息，请参阅GraphQL API 文档或 REST API 文档中的“项目（经典版）”。

对于项目（经典版）或项目（经典版）上的列相关的活动，请使用 project 和 project_column 事件。

此事件仅与项目（经典版）相关。对于新的项目体验相关的活动，请改为使用 projects_v2 事件。

要订阅此事件，GitHub App 必须至少具有“项目”存储库或组织权限的读取级别访问权限。

project_card 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 project_card 的 Webhook 负载对象

项目（经典版）中的备注已转换为议题。

Webhook 请求正文参数
action string 必填

值：converted

changes object 必填
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

project_card 对象 必需
repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

project

此事件在项目（经典版）有活动时触发。有关更多信息，请参阅“关于项目（经典版）”。有关管理经典项目 API 的信息，请参阅GraphQL API 文档或 REST API 文档中的“项目（经典版）”。

对于项目（经典版）上的卡片或列相关的活动，请使用 project_card 和 project_column 事件。

此事件仅与项目（经典版）相关。对于新的项目体验相关的活动，请改为使用 projects_v2 事件。

要订阅此事件，GitHub App 必须至少具有“项目”存储库或组织权限的读取级别访问权限。

project 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 project 的 Webhook 负载对象

项目（经典版）已关闭。

Webhook 请求正文参数
action string 必填

值：closed

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

project 对象 必需
repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

project_column

此事件在项目（经典版）上的列有活动时触发。有关更多信息，请参阅“关于项目（经典版）”。有关管理经典项目 API 的信息，请参阅GraphQL API 文档或 REST API 文档中的“项目（经典版）”。

对于项目（经典版）或项目（经典版）上的卡片相关的活动，请使用 project 和 project_card 事件。

此事件仅与项目（经典版）相关。对于新的项目体验相关的活动，请改为使用 projects_v2 事件。

要订阅此事件，GitHub App 必须至少具有“项目”存储库或组织权限的读取级别访问权限。

project_column 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 project_column 的 Webhook 负载对象

列已添加到项目（经典版）。

Webhook 请求正文参数
action string 必填

值：created

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

project_column 对象 必需
repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object

一个 GitHub 用户。

projects_v2

当组织级项目有活动时，会发生此事件。有关更多信息，请参阅“关于项目”。有关项目 API 的信息，请参阅GraphQL 文档。

对于项目上的项相关的活动，请使用 projects_v2_item 事件。对于项目（经典版）相关的活动，请改为使用 project、project_card 和 project_column 事件。

要订阅此事件，GitHub App 必须至少具有“项目”组织权限的读取级别访问权限。

项目的 Webhook 事件目前处于公共预览阶段，可能会有所更改。要向 GitHub 分享有关项目 Webhook 的反馈，请参阅项目 Webhook 反馈讨论。

projects_v2 的可用性

  • 组织

用于 projects_v2 的 Webhook 负载对象

组织中的项目已关闭。

Webhook 请求正文参数
action string 必填

值：closed

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object 必填

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

projects_v2 对象 必需

项目 v2 项目

sender object 必填

一个 GitHub 用户。

projects_v2_item

当组织级项目上的项有活动时，会发生此事件。有关更多信息，请参阅“关于项目”。有关项目 API 的信息，请参阅GraphQL 文档。

对于项目相关的活动（而非项目上的项），请使用 projects_v2 事件。对于项目（经典版）相关的活动，请改为使用 project、project_card 和 project_column 事件。

要订阅此事件，GitHub App 必须至少具有“项目”组织权限的读取级别访问权限。

项目的 Webhook 事件目前处于公共预览阶段，可能会有所更改。要向 GitHub 分享有关项目 Webhook 的反馈，请参阅项目 Webhook 反馈讨论。

projects_v2_item 的可用性

  • 组织

用于 projects_v2_item 的 Webhook 负载对象

组织项目上的项已存档。有关更多信息，请参阅“从项目中存档项”。

Webhook 请求正文参数
action string 必填

值：archived

changes object 必填
installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object 必填

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

projects_v2_item 对象 必需

属于项目的一个项

sender object 必填

一个 GitHub 用户。

projects_v2_status_update

当组织级项目上的状态更新有活动时，会发生此事件。有关更多信息，请参阅“关于项目”。

对于项目相关的活动，请使用 projects_v2 事件。

要订阅此事件，GitHub App 必须至少具有“项目”组织权限的读取级别访问权限。

要向 GitHub 分享有关项目 Webhook 的反馈，请参阅项目 Webhook 反馈讨论。

projects_v2_status_update 的可用性

  • 组织

用于 projects_v2_status_update 的 Webhook 负载对象

组织中的项目已添加状态更新。

Webhook 请求正文参数
action string 必填

值：created

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object 必填

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

projects_v2_status_update 对象 必需

属于项目的状态更新

sender object 必填

一个 GitHub 用户。

public

此事件在存储库可见性从私有更改为公共时触发。有关更多信息，请参阅“设置存储库可见性”。

要订阅此事件，GitHub App 必须至少具有“元数据”仓库权限的读取级别访问权限。

public 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 public 的 Webhook 负载对象

Webhook 请求正文参数
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

pull_request

此事件在拉取请求有活动时触发。有关更多信息，请参阅“关于拉取请求”。有关管理拉取请求 API 的信息，请参阅GraphQL API 文档或 REST API 文档中的“拉取”。

对于与拉取请求审查、拉取请求审查评论、拉取请求评论或拉取请求审查线程相关的活动，请改为使用 pull_request_review、pull_request_review_comment、issue_comment 或 pull_request_review_thread 事件。

要订阅此事件，GitHub App 必须至少具有“拉取请求”存储库权限的读取级别访问权限。

pull_request 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 pull_request 的 Webhook 负载对象

拉取请求已分配给用户。

Webhook 请求正文参数
action string 必填

值：assigned

assignee 对象或空值 必需
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

number 整数 必需

拉取请求编号。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

pull_request 对象 必需
repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

pull_request_review_comment

此事件在拉取请求审查评论有活动时触发。拉取请求审查评论是对拉取请求差异的评论。有关更多信息，请参阅“评论拉取请求”。有关管理拉取请求审查评论 API 的信息，请参阅GraphQL API 文档或 REST API 文档中的“拉取请求审查评论”。

对于与拉取请求审查、拉取请求评论或拉取请求审查线程相关的活动，请改为使用 pull_request_review、issue_comment 或 pull_request_review_thread 事件。

要订阅此事件，GitHub App 必须至少具有“拉取请求”存储库权限的读取级别访问权限。

pull_request_review_comment 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 pull_request_review_comment 的 Webhook 负载对象

已创建对拉取请求差异的评论。

Webhook 请求正文参数
action string 必填

值：created

comment object 必填

评论本身。

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

pull_request 对象 必需
repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

pull_request_review

此事件在拉取请求审查有活动时触发。拉取请求审查是一组拉取请求审查评论，此外还包括正文评论和状态。有关更多信息，请参阅“关于拉取请求审查”。有关管理拉取请求审查 API 的信息，请参阅GraphQL API 文档或 REST API 文档中的“拉取请求审查”。

对于与拉取请求审查评论、拉取请求评论或拉取请求审查线程相关的活动，请改为使用 pull_request_review_comment、issue_comment 或 pull_request_review_thread 事件。

要订阅此事件，GitHub App 必须至少具有“拉取请求”存储库权限的读取级别访问权限。

pull_request_review 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 pull_request_review 的 Webhook 负载对象

拉取请求上的审查已驳回。

Webhook 请求正文参数
action string 必填

值：dismissed

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

pull_request 对象 必需
repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

review 对象 必需

受影响的审查。

sender object 必填

一个 GitHub 用户。

pull_request_review_thread

此事件在拉取请求上的评论线程有活动时触发。有关更多信息，请参阅“关于拉取请求审查”。有关管理拉取请求审查 API 的信息，请参阅GraphQL API 文档或 REST API 文档中的“拉取请求审查评论”。

对于与拉取请求审查评论、拉取请求评论或拉取请求审查相关的活动，请改为使用 pull_request_review_comment、issue_comment 或 pull_request_review 事件。

要订阅此事件，GitHub App 必须至少具有“拉取请求”存储库权限的读取级别访问权限。

pull_request_review_thread 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 pull_request_review_thread 的 Webhook 负载对象

拉取请求上的评论线程已标记为已解决。

Webhook 请求正文参数
action string 必填

值：resolved

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

pull_request 对象 必需
repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object

一个 GitHub 用户。

thread 对象 必需
updated_at 字符串或空值

push

当有推送到存储库分支的活动时，会发生此事件。这包括推送提交、推送提交标签、删除分支、删除标签或从模板创建存储库。要仅订阅分支和标签删除，请使用 delete Webhook 事件。

要订阅此事件，GitHub App 必须至少具有“内容”仓库权限的读取级别访问权限。

如果一次推送超过 5000 个分支，则不会创建事件。如果一次推送超过三个标签，则不会创建标签事件。

push 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 push 的 Webhook 负载对象

Webhook 请求正文参数
after 字符串 必需

推送后 ref 上最新提交的 SHA。

base_ref 字符串或空值 必需
before 字符串 必需

推送前 ref 上最新提交的 SHA。

commits 对象数组 必需

描述已推送提交的提交对象数组。（已推送的提交是 before 提交和 after 提交之间的 compare 中包含的所有提交。）该数组最多包含 2048 个提交。如有必要，您可以使用提交 API 来获取额外的提交。

compare 字符串 必需

显示此 ref 更新中从 before 提交到 after 提交的更改的 URL。对于直接基于默认分支的新创建 ref，这是默认分支的 HEAD 与 after 提交之间的比较。否则，这会显示直到 after 提交的所有提交。

created 布尔值 必需

此推送是否创建了 ref。

deleted 布尔值 必需

此推送是否删除了 ref。

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

forced 布尔值 必需

此推送是否为 ref 的强制推送。

head_commit 对象或空值 必需
installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

pusher 对象 必需

Git 作者/提交者信息的元属性。

ref string 必填

已推送的完整 git ref。示例：refs/heads/main 或 refs/tags/v3.14.1。

repository object 必填

一个 git 存储库

sender object

一个 GitHub 用户。

registry_package

此事件在与 GitHub Packages 相关的活动发生时触发。有关更多信息，请参阅“GitHub Packages 简介”。有关管理 GitHub Packages API 的信息，请参阅GraphQL API 文档或 REST API 文档中的“Packages”。

要在 GitHub App 上安装此事件，该应用必须至少具有“Packages”存储库权限的读取级别访问权限。

GitHub 建议您改用较新的 package 事件。

registry_package 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 registry_package 的 Webhook 负载对象

包已发布到注册表。

Webhook 请求正文参数
action string 必填

值：published

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

registry_package 对象 必需
repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

release

此事件在与发布相关的活动发生时触发。有关更多信息，请参阅“关于发布”。有关管理发布 API 的信息，请参阅GraphQL API 文档或 REST API 文档中的“发布”。

要订阅此事件，GitHub App 必须至少具有“内容”仓库权限的读取级别访问权限。

release 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 release 的 Webhook 负载对象

草稿已保存，或发布或预发布已发布，但之前未保存为草稿。

Webhook 请求正文参数
action string 必填

值：created

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

release 对象 必需

发布对象。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

repository_advisory

当有活动涉及存储库安全咨询时，会发生此事件。有关存储库安全咨询的更多信息，请参阅“关于 GitHub 存储库安全咨询”。

要订阅此事件，GitHub App 必须至少具有“存储库安全咨询”权限的读取级别访问权限。

repository_advisory 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 repository_advisory 的 Webhook 负载对象

存储库安全咨询已发布。

Webhook 请求正文参数
action string 必填

值：published

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

repository_advisory 对象 必需

存储库安全咨询。

sender object

一个 GitHub 用户。

repository

此事件在与存储库相关的活动发生时触发。有关更多信息，请参阅“关于存储库”。有关管理存储库 API 的信息，请参阅GraphQL 文档或 REST API 文档中的“存储库”。

要订阅此事件，GitHub App 必须至少具有“元数据”仓库权限的读取级别访问权限。

repository 的可用性

  • 企业
  • 仓库
  • 组织
  • GitHub Apps

用于 repository 的 Webhook 负载对象

存储库已存档。

Webhook 请求正文参数
action string 必填

值：archived

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

repository_dispatch

此事件在 GitHub App 向 /repos/{owner}/{repo}/dispatches 发送 POST 请求时触发。有关更多信息，请参阅创建存储库调度事件的 REST API 文档。在负载中，action 将是 POST /repos/{owner}/{repo}/dispatches 请求正文中指定的 event_type。

要订阅此事件，GitHub App 必须至少具有“内容”仓库权限的读取级别访问权限。

repository_dispatch 的可用性

  • GitHub Apps

用于 repository_dispatch 的 Webhook 负载对象

Webhook 请求正文参数
action string 必填

在 POST /repos/{owner}/{repo}/dispatches 请求正文中指定的 event_type。

branch string 必填
client_payload 对象或空值 必需

在 POST /repos/{owner}/{repo}/dispatches 请求正文中指定的 client_payload。

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object 必填

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

repository_import

当存储库导入到 GitHub 时，会发生此事件。有关更多信息，请参阅“使用 GitHub Importer 导入存储库”。有关管理导入 API 的更多信息，请参阅REST API 文档。

repository_import 的可用性

  • 仓库
  • 组织

用于 repository_import 的 Webhook 负载对象

Webhook 请求正文参数
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

status 字符串 必需

可以是以下之一：success、cancelled、failure

repository_ruleset

此事件在存储库规则集有活动时触发。有关存储库规则集的更多信息，请参阅“管理规则集”。有关通过 API 管理规则集的更多信息，请参阅 GraphQL 文档中的存储库规则集或 REST API 文档中的“存储库规则”和“组织规则”。

要订阅此事件，GitHub App 必须至少具有“管理”存储库或组织权限的读取级别访问权限。

repository_ruleset 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 repository_ruleset 的 Webhook 负载对象

存储库规则集已创建。

Webhook 请求正文参数
action string 必填

值：created

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

repository_ruleset 对象 必需

满足指定条件时应用的一组规则。

sender object 必填

一个 GitHub 用户。

repository_vulnerability_alert

此事件在存储库中的安全漏洞警报有活动时触发。

关闭通知：此事件即将关闭。请改用 dependabot_alert 事件。

repository_vulnerability_alert 的可用性

  • 仓库
  • 组织

用于 repository_vulnerability_alert 的 Webhook 负载对象

存储库漏洞警报已创建。

Webhook 请求正文参数
action string 必填

值：create

alert object 必填

易受攻击依赖项的安全警报。

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

secret_scanning_alert

此事件在秘密扫描警报有活动时触发。有关秘密扫描的更多信息，请参阅“关于秘密扫描”。有关管理秘密扫描警报 API 的信息，请参阅 REST API 文档中的“秘密扫描”。

对于与秘密扫描警报位置相关的活动，请使用 secret_scanning_alert_location 事件。

要订阅此事件，GitHub App 必须至少具有“秘密扫描警报”存储库权限的读取级别访问权限。

secret_scanning_alert 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 secret_scanning_alert 的 Webhook 负载对象

秘密扫描警报已分配。

Webhook 请求正文参数
action string 必填

值：assigned

alert object 必填
assignee 对象

一个 GitHub 用户。

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object

一个 GitHub 用户。

secret_scanning_alert_location

此事件在秘密扫描警报中秘密位置有活动时触发。

有关秘密扫描的更多信息，请参阅“关于秘密扫描”。有关管理秘密扫描警报 API 的信息，请参阅 REST API 文档中的“秘密扫描”。

对于与秘密扫描警报相关的活动，请使用 secret_scanning_alert 事件。

要订阅此事件，GitHub App 必须至少具有“秘密扫描警报”存储库权限的读取级别访问权限。

secret_scanning_alert_location 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 secret_scanning_alert_location 的 Webhook 负载对象

在存储库中检测到以前检测到的秘密的新实例，并且秘密的位置已添加到现有警报中。

Webhook 请求正文参数
action string

值：created

alert object 必填
installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

location 对象 必需
organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

secret_scanning_scan

此事件在秘密扫描完成对存储库的某些扫描时触发。有关秘密扫描的更多信息，请参阅“关于秘密扫描”。

扫描可能源于多种事件，例如自定义模式的更新、推送到存储库或合作伙伴模式的更新。有关自定义模式的更多信息，请参阅“关于自定义模式”。

要订阅此事件，GitHub App 必须至少具有“秘密扫描警报”存储库权限的读取级别访问权限。

secret_scanning_scan 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 secret_scanning_scan 的 Webhook 负载对象

秘密扫描已完成。

Webhook 请求正文参数
action string 必填

值：completed

type 字符串 必需

已完成的扫描类型

可以是以下之一：backfill、custom-pattern-backfill、pattern-version-backfill

source 字符串 必需

已扫描的内容类型

可以是以下之一：git、issues、pull-requests、discussions、wiki

started_at 字符串 必需

警报解决的时间，ISO 8601 格式：YYYY-MM-DDTHH:MM:SSZ。

completed_at 字符串 必需

警报解决的时间，ISO 8601 格式：YYYY-MM-DDTHH:MM:SSZ。

secret_types 字符串数组或空值

已更新的模式列表。对于普通回填扫描或自定义模式更新，此项将为空。

custom_pattern_name 字符串或空值

如果扫描是由自定义模式更新触发的，则此项将是已更新模式的名称

custom_pattern_scope 字符串或空值

如果扫描是由自定义模式更新触发的，则此项将是已更新模式的范围

可以是以下之一：repository、organization、enterprise、null

repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

sender object

一个 GitHub 用户。

security_advisory

此事件在 GitHub 审查的全球安全咨询有活动时触发。GitHub 审查的全球安全咨询提供有关已映射到我们支持的生态系统中的软件包的安全漏洞或恶意软件的信息。有关全球安全咨询的更多信息，请参阅“关于全球安全咨询”。有关管理安全咨询 API 的信息，请参阅REST API 文档或GraphQL 文档。

GitHub Dependabot 警报也由安全咨询数据集提供支持。有关更多信息，请参阅“关于 Dependabot 警报”。

security_advisory 的可用性

  • GitHub Apps

用于 security_advisory 的 Webhook 负载对象

安全咨询已发布到 GitHub 社区。

Webhook 请求正文参数
action string 必填

值：published

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

security_advisory 对象 必需

安全咨询的详细信息，包括摘要、描述和严重性。

sender object

一个 GitHub 用户。

security_and_analysis

此事件在为存储库启用或禁用代码安全和分析功能时触发。有关更多信息，请参阅“GitHub 安全功能”。

要订阅此事件，GitHub App 必须至少具有“管理”仓库权限的读取级别访问权限。

security_and_analysis 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 security_and_analysis 的 Webhook 负载对象

Webhook 请求正文参数
changes object 必填
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

完整存储库

sender object

一个 GitHub 用户。

sponsorship

此事件在赞助列表有活动时触发。有关更多信息，请参阅“关于 GitHub 赞助者”。有关管理赞助者 API 的信息，请参阅GraphQL 文档。

您只能在 GitHub.com 上创建赞助 Webhook。有关更多信息，请参阅“为赞助帐户中的事件配置 Webhook”。

sponsorship 的可用性

  • 赞助帐户

用于 sponsorship 的 Webhook 负载对象

赞助已取消，最后一个计费周期已结束。

此事件仅在取消重复（每月）赞助时发送；不会为一次性赞助发送。

Webhook 请求正文参数
action string 必填

值：cancelled

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

sponsorship 对象 必需

star

此事件在与存储库星标相关的活动发生时触发。有关星标的更多信息，请参阅“使用星标保存存储库”。有关管理星标 API 的信息，请参阅GraphQL 文档或 REST API 文档中的“加星”。

要订阅此事件，GitHub App 必须至少具有“元数据”仓库权限的读取级别访问权限。

star 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 star 的 Webhook 负载对象

有人为存储库加星标。

Webhook 请求正文参数
action string 必填

值：created

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

starred_at 字符串或空值 必需

星标创建的时间。这是 ISO 8601 格式的时间戳：YYYY-MM-DDTHH:MM:SSZ。对于 deleted 操作将为 null。

status

此事件在 Git 提交的状态更改时触发。例如，提交可以标记为 error、failure、pending 或 success。有关更多信息，请参阅“关于状态检查”。有关管理提交状态 API 的信息，请参阅GraphQL 文档或 REST API 文档中的“提交状态”。

要订阅此事件，GitHub App 必须至少具有“提交状态”存储库权限的读取级别访问权限。

status 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 status 的 Webhook 负载对象

Webhook 请求正文参数
avatar_url 字符串或空值
branches 对象数组 必需

包含状态 SHA 的分支对象数组。每个分支都包含给定的 SHA，但 SHA 可能（也可能不）是分支的头部。该数组最多包含 10 个分支。

commit 对象 必需
context string 必填
created_at 字符串 必需
description string or null 必填

添加到状态的可选人类可读描述。

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

id 整数 必需

状态的唯一标识符。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

name string 必填
organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

sha 字符串 必需

提交 SHA。

state 字符串 必需

新状态。可以是 pending、success、failure 或 error。

可以是以下之一：pending、success、failure、error

target_url 字符串或空值 必需

添加到状态的可选链接。

updated_at 字符串 必需

sub_issues

此事件在与子议题相关的活动发生时触发。

更普遍地，有关议题的活动，请改用 issues 事件。

要订阅此事件，GitHub App 必须至少具有“议题”仓库权限的读取级别访问权限。

sub_issues 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 sub_issues 的 Webhook 负载对象

父议题已添加到议题。

Webhook 请求正文参数
action string 必填

值：parent_issue_added

parent_issue_id 数字 必需

父议题的 ID。

parent_issue 对象 必需

议题是跟踪项目任务、增强功能和 bug 的绝佳方式。

parent_issue_repo 对象 必需

GitHub 上的仓库。

sub_issue_id 数字 必需

子议题的 ID。

sub_issue 对象 必需

议题是跟踪项目任务、增强功能和 bug 的绝佳方式。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object

一个 GitHub 用户。

team_add

此事件在团队添加到存储库时触发。有关更多信息，请参阅“管理具有存储库访问权限的团队和人员”。

对于与团队相关的活动，请参阅 teams 事件。

要订阅此事件，GitHub App 必须至少具有“成员”组织权限的读取级别访问权限。

team_add 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 team_add 的 Webhook 负载对象

Webhook 请求正文参数
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

team 对象 必需

组织成员组，授予对指定存储库的权限。

team

此事件在组织中的团队有活动时触发。有关更多信息，请参阅“关于团队”。

要订阅此事件，GitHub App 必须至少具有“成员”组织权限的读取级别访问权限。

team 的可用性

  • 组织
  • 企业
  • GitHub Apps

用于 team 的 Webhook 负载对象

团队已获得对存储库的访问权限。

Webhook 请求正文参数
action string 必填

值：added_to_repository

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object 必填

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object

一个 git 存储库

sender object

一个 GitHub 用户。

team 对象 必需

组织成员组，授予对指定存储库的权限。

watch

此事件在与监视或订阅存储库相关的活动发生时触发。有关监视的更多信息，请参阅“管理您的订阅”。有关管理监视 API 的信息，请参阅 REST API 文档中的“监视”。

要订阅此事件，GitHub App 必须至少具有“元数据”仓库权限的读取级别访问权限。

watch 的可用性

  • 仓库
  • 组织
  • GitHub Apps

用于 watch 的 Webhook 负载对象

有人开始监视存储库。

Webhook 请求正文参数
action string 必填

值：started

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

workflow_dispatch

此事件在手动触发 GitHub Actions 工作流时发生。有关更多信息，请参阅“手动运行工作流”。

对于与工作流运行相关的活动，请使用 workflow_run 事件。

要订阅此事件，GitHub App 必须至少具有“内容”仓库权限的读取级别访问权限。

workflow_dispatch 的可用性

  • GitHub Apps

用于 workflow_dispatch 的 Webhook 负载对象

Webhook 请求正文参数
enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

inputs 对象或空值 必需
installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

ref string 必填
repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

workflow 字符串 必需

workflow_job

此事件在 GitHub Actions 工作流中的作业有活动时发生。有关更多信息，请参阅“在工作流中使用作业”。有关管理工作流作业 API 的信息，请参阅 REST API 文档中的“工作流作业”。

对于与工作流运行相关的活动（而非工作流运行中的作业），请使用 workflow_run 事件。

要订阅此事件，GitHub App 必须至少具有“Actions”存储库权限的读取级别访问权限。

workflow_job 的可用性

  • 企业
  • 仓库
  • 组织
  • GitHub Apps

用于 workflow_job 的 Webhook 负载对象

工作流运行中的作业已完成。此事件在工作流中的作业完成后触发，无论作业成功还是失败。

Webhook 请求正文参数
action string 必填

值：completed

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

workflow_job 对象 必需
deployment 对象

部署特定引用（分支、SHA、标签）的请求

workflow_run

此事件在 GitHub Actions 工作流的运行有活动时触发。有关更多信息，请参阅“关于工作流”。有关管理工作流运行 API 的信息，请参阅GraphQL 文档或 REST API 文档中的“工作流运行”。

对于与工作流运行中的作业相关的活动，请使用 workflow_job 事件。

要订阅此事件，GitHub App 必须至少具有“Actions”存储库权限的读取级别访问权限。

workflow_run 的可用性

  • 企业
  • 仓库
  • 组织
  • GitHub Apps

用于 workflow_run 的 Webhook 负载对象

工作流运行已完成。此事件在工作流运行完成后触发，无论工作流成功还是失败。

Webhook 请求正文参数
action string 必填

值：completed

enterprise object

GitHub 上的企业。当 Webhook 配置在企业帐户或属于企业帐户的组织上时，Webhook 负载包含 enterprise 属性。有关详细信息，请参阅“关于企业帐户”。

installation object

GitHub App 安装。当事件配置为 GitHub App 并发送给 GitHub App 时，Webhook 负载包含 installation 属性。有关详细信息，请参阅“将 Webhooks 与 GitHub Apps 结合使用”。

organization object

一个 GitHub 组织。当 Webhook 为组织配置，或当事件由组织拥有的仓库中的活动引起时，Webhook 负载包含 organization 属性。

repository object 必填

发生事件的 GitHub 仓库。当事件由仓库中的活动引起时，Webhook 负载包含 repository 属性。

sender object 必填

一个 GitHub 用户。

workflow object or null 必填
workflow_run 对象 必需
© . This site is unofficial and not affiliated with GitHub, Inc.