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/2

> 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 应用必须至少具有“管理”仓库权限的读取级访问权限。

branch_protection_configuration 的可用性

  • 仓库
  • 组织
  • GitHub 应用

branch_protection_configuration 的 Webhook 负载对象

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

Webhook 请求正文参数
action 字符串 必填

值: disabled

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

branch_protection_rule

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

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

branch_protection_rule 的可用性

  • 仓库
  • 组织
  • GitHub 应用

branch_protection_rule 的 Webhook 负载对象

已创建分支保护规则。

Webhook 请求正文参数
action 字符串 必填

值: created

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

rule 对象 必填

分支保护规则。包括一个name和所有应用于与名称匹配的分支的分支保护设置。二元设置是布尔值。多级配置为off、non_admins或everyone之一。Actor 和构建列表是字符串数组。

sender 对象 必填

GitHub 用户。

check_run

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

对于与检查套件相关的活动，请使用check-suite事件。

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

存储库和组织 Webhook 仅接收存储库中created和completed事件类型的有效负载。

注意

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

check_run 的可用性

  • 仓库
  • 组织
  • GitHub 应用

check_run 的 Webhook 有效负载对象

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

Webhook 请求正文参数
action 字符串

值： completed

check_run 对象 必需

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

check_suite

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

对于与检查运行相关的活动，请使用check_run事件。

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

存储库和组织 Webhook 仅接收存储库中completed事件类型的有效负载。

注意

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

check_suite 的可用性

  • 仓库
  • 组织
  • GitHub 应用

check_suite 的 Webhook 有效负载对象

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

Webhook 请求正文参数
action 字符串 必填

值： completed

check_suite 对象 必需
enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

code_scanning_alert

当存储库中与代码扫描警报相关的活动发生时，将触发此事件。有关更多信息，请参阅“关于代码扫描”和“关于代码扫描警报”。有关管理代码扫描的 API 信息，请参阅 REST API 文档中的“代码扫描”。

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

code_scanning_alert 的可用性

  • 仓库
  • 组织
  • GitHub 应用

code_scanning_alert 的 Webhook 有效负载对象

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

Webhook 请求正文参数
action 字符串 必填

值： appeared_in_branch

alert 对象 必需

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

commit_oid 字符串 必需

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

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

ref 字符串 必需

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

commit_comment

当与提交注释相关的活动发生时，将触发此事件。有关提交注释的更多信息，请参阅“在拉取请求中发表评论”。有关管理提交注释的 API 信息，请参阅GraphQL API 文档或 REST API 文档中的“提交注释”。

对于与拉取请求审查评论相关的活动，请使用pull_request_review_comment事件。对于与问题评论相关的活动，请使用issue_comment事件。对于与讨论评论相关的活动，请使用discussion_comment事件。

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

commit_comment 的可用性

  • 仓库
  • 组织
  • GitHub 应用

commit_comment 的 Webhook 有效负载对象

有人对提交发表了评论。

Webhook 请求正文参数
action 字符串 必填

执行的操作。可以是created。

值: created

comment 对象 必需

提交注释资源。

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

create

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

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

备注:

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

create 的可用性

  • 仓库
  • 组织
  • GitHub 应用

create 的 Webhook 有效负载对象

Webhook 请求正文参数
description 字符串或 null 必需

存储库的当前描述。

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

master_branch 字符串 必需

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

organization 对象

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

pusher_type 字符串 必需

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

ref 字符串 必需

git ref资源。

ref_type 字符串 必需

在存储库中创建的 Git ref 对象的类型。

可以是以下之一： tag、branch

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

custom_property

当与自定义属性相关的活动发生时，将触发此事件。

有关更多信息，请参阅“管理组织中存储库的自定义属性”。有关管理自定义属性的 API 信息，请参阅 REST API 文档中的“自定义属性”。

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

custom_property 的可用性

  • 组织
  • GitHub 应用

custom_property 的 Webhook 有效负载对象

创建了一个新的自定义属性。

Webhook 请求正文参数
action 字符串 必填

值: created

definition 对象 必需

在组织上定义的自定义属性

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

sender 对象

GitHub 用户。

custom_property_values

当与存储库的自定义属性值相关的活动发生时，将触发此事件。

更多信息，请参阅“管理组织中存储库的自定义属性”。有关管理存储库自定义属性的 API 信息，请参阅 REST API 文档中的“自定义属性”。

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

custom_property_values 的可用性

  • 仓库
  • 组织
  • GitHub 应用

custom_property_values 的 Webhook 负载对象

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

Webhook 请求正文参数
action 字符串 必填

值：updated

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

repository 对象 必填

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

organization 对象 必填

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

sender 对象

GitHub 用户。

new_property_values 对象数组 必填

存储库的新自定义属性值。

old_property_values 对象数组 必填

存储库的旧自定义属性值。

delete

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

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

注意

当一次删除三个以上标签时，不会发生此事件。

delete 的可用性

  • 仓库
  • 组织
  • GitHub 应用

delete 的 Webhook 负载对象

Webhook 请求正文参数
enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

pusher_type 字符串 必需

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

ref 字符串 必需

git ref资源。

ref_type 字符串 必需

在存储库中删除的 Git ref 对象的类型。

可以是以下之一： tag、branch

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

dependabot_alert

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

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

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

注意

Dependabot 警报的 Webhook 事件目前处于公开预览阶段，可能会发生更改。

dependabot_alert 的可用性

  • 仓库
  • 组织
  • GitHub 应用

dependabot_alert 的 Webhook 负载对象

Dependabot 警报已由 Dependabot 自动分类规则自动关闭。

Webhook 请求正文参数
action 字符串 必填

值：auto_dismissed

alert 对象 必需

Dependabot 警报。

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

enterprise 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

deploy_key

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

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

deploy_key 的可用性

  • 仓库
  • 组织
  • GitHub 应用

deploy_key 的 Webhook 负载对象

已创建部署密钥。

Webhook 请求正文参数
action 字符串 必填

值: created

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

key 对象 必填

部署密钥 资源。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

deployment

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

对于与部署状态相关的活动，请使用 deployment_status 事件。

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

deployment 的可用性

  • 仓库
  • 组织
  • GitHub 应用

deployment 的 Webhook 负载对象

已创建部署。

Webhook 请求正文参数
action 字符串 必填

值: created

deployment 对象 必填
enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

workflow 对象或 null 必填
workflow_run 对象或 null 必填

deployment_protection_rule

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

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

deployment_protection_rule 的可用性

  • GitHub 应用

deployment_protection_rule 的 Webhook 负载对象

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

Webhook 请求正文参数
action 字符串

值：requested

environment 字符串

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

event 字符串

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

deployment_callback_url 字符串

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

deployment 对象

请求部署特定 ref（分支、sha、标签）。

pull_requests 对象数组
repository 对象

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

organization 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

sender 对象

GitHub 用户。

deployment_review

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

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

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

deployment_review 的可用性

  • GitHub 应用

deployment_review 的 Webhook 负载对象

部署评审已获批准。

Webhook 请求正文参数
action 字符串 必填

值：approved

approver 对象
comment 字符串
enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象 必填

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

repository 对象 必填

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

reviewers 对象数组
sender 对象 必填

GitHub 用户。

since 字符串 必填
workflow_job_run 对象
workflow_job_runs 对象数组
workflow_run 对象或 null 必填

deployment_status

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

对于与部署创建相关的活动，请使用 deployment 事件。

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

注意

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

deployment_status 的可用性

  • 仓库
  • 组织
  • GitHub 应用

deployment_status 的 Webhook 负载对象

已创建新的部署状态。

Webhook 请求正文参数
action 字符串 必填

值: created

check_run 对象或 null
deployment 对象 必填
deployment_status 对象 必填
enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

workflow 对象或 null
workflow_run 对象或 null

discussion

当与讨论相关的活动发生时，会发生此事件。有关讨论的更多信息，请参阅“GitHub 讨论”。有关管理讨论的 API 信息，请参阅 GraphQL 文档。

对于与讨论中的评论相关的活动，请使用 discussion_comment 事件。

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

注意

GitHub 讨论的 Webhook 事件目前处于公开预览阶段，可能会发生更改。

discussion 的可用性

  • 仓库
  • 组织
  • GitHub 应用

discussion 的 Webhook 负载对象

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

Webhook 请求正文参数
action 字符串 必填

值：answered

answer 对象 必填

discussion 对象 必填

仓库中的讨论。

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

discussion_comment

当讨论中的评论有活动时，就会触发此事件。有关讨论的更多信息，请参阅“GitHub 讨论”。有关管理讨论的 API 信息，请参阅GraphQL 文档。

对于与讨论相关的活动（而不是讨论中的评论），请使用discussion事件。

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

注意

GitHub 讨论的 Webhook 事件目前处于公开预览阶段，可能会发生更改。

discussion_comment 的可用性

  • 仓库
  • 组织
  • GitHub 应用

discussion_comment 的 Webhook 负载对象

创建了讨论中的评论。

Webhook 请求正文参数
action 字符串 必填

值: created

comment 对象 必需
discussion 对象 必填

仓库中的讨论。

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

fork

当有人分叉仓库时，就会触发此事件。有关更多信息，请参阅“分叉仓库”。有关管理分叉的 API 信息，请参阅 REST API 文档中的“分叉”。

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

fork 的可用性

  • 企业
  • 仓库
  • 组织
  • GitHub 应用

fork 的 Webhook 负载对象

Webhook 请求正文参数
enterprise 对象

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

forkee 对象 必填

创建的repository 资源。

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

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 应用

github_app_authorization 的 Webhook 负载对象

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

Webhook 请求正文参数
action 字符串 必填

值： revoked

sender 对象 必填

GitHub 用户。

gollum

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

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

gollum 的可用性

  • 仓库
  • 组织
  • GitHub 应用

gollum 的 Webhook 负载对象

Webhook 请求正文参数
enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

pages 对象数组 必填

已更新的页面。

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

installation

当与 GitHub App 安装相关的活动发生时，就会触发此事件。所有 GitHub App 默认都会收到此事件。您无法手动订阅此事件。

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

installation 的可用性

  • GitHub 应用

installation 的 Webhook 负载对象

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

Webhook 请求正文参数
action 字符串 必填

值: created

enterprise 对象

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

installation 对象 必填

安装

organization 对象

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

repositories 对象数组

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

repository 对象

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

requester 对象或 null
sender 对象 必填

GitHub 用户。

installation_repositories

当与 GitHub App 安装可以访问哪些仓库相关的活动发生时，就会触发此事件。所有 GitHub App 默认都会收到此事件。您无法手动订阅此事件。

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

installation_repositories 的可用性

  • GitHub 应用

installation_repositories 的 Webhook 负载对象

GitHub App 安装被授予对一个或多个仓库的访问权限。

Webhook 请求正文参数
action 字符串 必填

值： added

enterprise 对象

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

installation 对象 必填

安装

organization 对象

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

repositories_added 对象数组 必填

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

repositories_removed 对象数组 必填

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

repository 对象

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

repository_selection 字符串 必填

描述是否已选择所有仓库或是否存在选择。

可以是以下之一： all, selected

requester 对象或 null 必填
sender 对象 必填

GitHub 用户。

installation_target

当与安装 GitHub App 的用户或组织帐户相关的活动发生时，就会触发此事件。有关更多信息，请参阅“关于应用”。有关管理 GitHub App 的 API 信息，请参阅GraphQL API 文档或 REST API 文档中的“应用”。

installation_target 的可用性

  • GitHub 应用

installation_target 的 Webhook 负载对象

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

Webhook 请求正文参数
account 对象 必填
action 字符串 必填

值： renamed

changes 对象 必填
enterprise 对象

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

installation 对象 必填

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象

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

sender 对象

GitHub 用户。

target_type 字符串 必填

issue_comment

当与问题或拉取请求的评论相关的活动发生时，就会触发此事件。有关问题和拉取请求的更多信息，请参阅“关于问题”和“关于拉取请求”。有关管理问题评论的 API 信息，请参阅GraphQL 文档或 REST API 文档中的“问题评论”。

对于与问题相关的活动（而不是问题上的评论），请使用issue事件。对于与拉取请求审查或拉取请求审查评论相关的活动，请使用pull_request_review或pull_request_review_comment事件。有关不同类型的拉取请求评论的更多信息，请参阅“使用评论”。

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

issue_comment 的可用性

  • 仓库
  • 组织
  • GitHub 应用

issue_comment 的 Webhook 负载对象

在问题或拉取请求上创建了评论。

Webhook 请求正文参数
action 字符串 必填

值: created

comment 对象 必需

评论本身。评论

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

issue 对象 必填

评论所属的问题。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

issues

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

对于与问题上的评论相关的活动，请使用issue_comment事件。

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

issues 的可用性

  • 仓库
  • 组织
  • GitHub 应用

issues 的 Webhook 负载对象

问题已分配给用户。

Webhook 请求正文参数
action 字符串 必填

执行的操作。

值： assigned

assignee 对象或 null
enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

issue 对象 必填

问题本身。问题

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

label

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

如果希望在向问题、拉取请求或讨论添加或删除标签时接收事件，请改为使用 issues、pull_request 或 discussion 事件的 labeled 或 unlabeled 操作类型。

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

label 的可用性

  • 仓库
  • 组织
  • GitHub 应用

label 的 Webhook 负载对象

创建了一个标签。

Webhook 请求正文参数
action 字符串 必填

值: created

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

label 对象 必需
organization 对象

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

repository 对象 必填

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

sender 对象

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 字符串 必填

值：cancelled

effective_date 字符串 必需
enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

marketplace_purchase 对象 必需
organization 对象

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

previous_marketplace_purchase 对象
repository 对象

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

sender 对象 必填

GitHub 用户。

member

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

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

member 的可用性

  • 企业
  • 仓库
  • 组织
  • GitHub 应用

member 的 Webhook 负载对象

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

Webhook 请求正文参数
action 字符串 必填

值： added

changes 对象
enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

member 对象或 null 必需
organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

membership

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

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

membership 的可用性

  • 组织
  • 企业
  • GitHub 应用

membership 的 Webhook 负载对象

组织成员被添加到团队中。

Webhook 请求正文参数
action 字符串 必填

值： added

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

member 对象或 null 必需
organization 对象 必填

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

repository 对象

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

scope 字符串 必需

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

值：team

sender 对象或 null 必需
team 对象 必需

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

merge_group

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

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

merge_group 的可用性

  • GitHub 应用

merge_group 的 Webhook 负载对象

已为合并组请求状态检查。当合并队列创建或添加合并组（因为拉取请求已排队）时，就会发生这种情况。

收到此事件时，应对头部 SHA 执行检查，并使用检查运行或提交状态报告结果。

Webhook 请求正文参数
action 字符串 必填

值：checks_requested

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

merge_group 对象 必需

合并队列已组合在一起以进行合并的一组拉取请求。

organization 对象

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

repository 对象

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

sender 对象

GitHub 用户。

meta

当 Webhook 本身相关活动发生时，将触发此事件。

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

meta 的可用性

  • GitHub Marketplace
  • 企业
  • 仓库
  • 组织
  • GitHub 应用

meta 的 Webhook 负载对象

Webhook 已删除。

Webhook 请求正文参数
action 字符串 必填

值：deleted

enterprise 对象

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

hook 对象 必需

已修改的 Webhook。这将包含基于其 Webhook 类型（存储库、组织、业务、应用或 GitHub Marketplace）的不同键。

hook_id 整数 必需

已修改的 Webhook 的 ID。

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象

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

sender 对象

GitHub 用户。

milestone

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

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

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

milestone 的可用性

  • 仓库
  • 组织
  • GitHub 应用

milestone 的 Webhook 负载对象

里程碑已关闭。

Webhook 请求正文参数
action 字符串 必填

值：closed

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

milestone 对象 必需

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

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

org_block

当组织所有者或版主阻止或取消阻止非成员在组织的存储库上进行协作时，将触发此事件。有关更多信息，请参阅“阻止用户访问您的组织”。有关管理被阻止用户的 API 信息，请参阅GraphQL 文档或 REST API 文档中的“阻止用户”。

如果希望在向组织添加或从中删除成员时接收事件，请改为使用 organization 事件。

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

org_block 的可用性

  • 组织
  • 企业
  • GitHub 应用

org_block 的 Webhook 负载对象

用户已被阻止访问组织。

Webhook 请求正文参数
action 字符串 必填

值：blocked

blocked_user 对象或 null 必需
enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象 必填

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

repository 对象

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

sender 对象 必填

GitHub 用户。

organization

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

如果希望在阻止或取消阻止非成员访问组织时接收事件，请改为使用 org_block 事件。

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

organization 的可用性

  • 组织
  • 企业
  • GitHub 应用

organization 的 Webhook 负载对象

一个组织已被删除。

Webhook 请求正文参数
action 字符串 必填

值：deleted

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

membership 对象

用户与组织之间的成员关系。当操作为member_invited时，此对象不存在。

organization 对象 必填

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

repository 对象

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

sender 对象 必填

GitHub 用户。

package

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

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

package 的可用性

  • 仓库
  • 组织
  • GitHub 应用

package 的 Webhook 负载对象

一个软件包已发布到注册表。

Webhook 请求正文参数
action 字符串 必填

值： published

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

package 对象 必填

有关软件包的信息。

repository 对象

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

sender 对象 必填

GitHub 用户。

page_build

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

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

page_build 的可用性

  • 仓库
  • 组织
  • GitHub 应用

page_build 的 Webhook 负载对象

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

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

id 整数 必填
installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

personal_access_token_request

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

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

注意

细粒度 PAT 处于公开预览阶段。相关的 API、事件和功能可能会发生变化。

personal_access_token_request 的可用性

  • GitHub 应用

personal_access_token_request 的 Webhook 负载对象

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

Webhook 请求正文参数
action 字符串 必填

值：approved

personal_access_token_request 对象 必填

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

enterprise 对象

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

organization 对象 必填

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

sender 对象 必填

GitHub 用户。

installation 对象 必填

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

ping

当您创建新的 Webhook 时，将触发此事件。ping 事件是 GitHub 对您已正确配置 Webhook 的确认。

ping 的可用性

  • 仓库
  • 组织
  • GitHub 应用
  • 企业
  • GitHub Marketplace

ping 的 Webhook 负载对象

Webhook 请求正文参数
hook 对象

正在 ping 的 Webhook

hook_id 整数

触发 ping 的 Webhook 的 ID。

organization 对象

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

repository 对象

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

sender 对象

GitHub 用户。

zen 字符串

GitHub zen 的随机字符串。

project_card

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

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

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

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

project_card 的可用性

  • 仓库
  • 组织
  • GitHub 应用

project_card 的 Webhook 负载对象

项目（经典）中的注释已转换为问题。

Webhook 请求正文参数
action 字符串 必填

值： converted

changes 对象 必填
enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

project_card 对象 必填
repository 对象

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

sender 对象 必填

GitHub 用户。

project

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

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

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

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

project 的可用性

  • 仓库
  • 组织
  • GitHub 应用

project 的 Webhook 负载对象

一个项目（经典）已关闭。

Webhook 请求正文参数
action 字符串 必填

值：closed

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

project 对象 必填
repository 对象

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

sender 对象 必填

GitHub 用户。

project_column

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

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

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

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

project_column 的可用性

  • 仓库
  • 组织
  • GitHub 应用

project_column 的 Webhook 负载对象

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

Webhook 请求正文参数
action 字符串 必填

值: created

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

project_column 对象 必填
repository 对象

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

sender 对象

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 字符串 必填

值：closed

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象 必填

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

projects_v2 对象 必填

一个项目 v2 项目

sender 对象 必填

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 字符串 必填

值： archived

changes 对象 必填
installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象 必填

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

projects_v2_item 对象 必填

属于项目的项目

sender 对象 必填

GitHub 用户。

projects_v2_status_update

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

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

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

注意

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

projects_v2_status_update 的可用性

  • 组织

projects_v2_status_update 的 Webhook 负载对象

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

Webhook 请求正文参数
action 字符串 必填

值: created

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象 必填

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

projects_v2_status_update 对象 必填

属于项目的状更新

sender 对象 必填

GitHub 用户。

public

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

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

public 的可用性

  • 仓库
  • 组织
  • GitHub 应用

public 的 Webhook 负载对象

Webhook 请求正文参数
enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

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 应用

pull_request 的 Webhook 负载对象

一个拉取请求被分配给了一个用户。

Webhook 请求正文参数
action 字符串 必填

值： assigned

assignee 对象或 null 必需
enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

number 整数 必需

拉取请求编号。

organization 对象

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

pull_request 对象 必需
repository 对象 必填

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

sender 对象 必填

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 应用

pull_request_review_comment 的 Webhook 负载对象

在拉取请求差异上创建了一个评论。

Webhook 请求正文参数
action 字符串 必填

值: created

comment 对象 必需

评论本身。

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

pull_request 对象 必需
repository 对象 必填

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

sender 对象 必填

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 应用

pull_request_review 的 Webhook 负载对象

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

Webhook 请求正文参数
action 字符串 必填

值：dismissed

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

pull_request 对象 必需
repository 对象 必填

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

review 对象 必需

受影响的审查。

sender 对象 必填

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 应用

pull_request_review_thread 的 Webhook 负载对象

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

Webhook 请求正文参数
action 字符串 必填

值：resolved

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

pull_request 对象 必需
repository 对象 必填

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

sender 对象

GitHub 用户。

thread 对象 必需

push

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

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

注意

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

push 的可用性

  • 仓库
  • 组织
  • GitHub 应用

push 的 Webhook 负载对象

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

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

base_ref 字符串或 null 必需
before 字符串 必需

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

commits 对象数组 必需

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

compare 字符串 必需

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

created 布尔值 必需

此推送是否创建了ref。

deleted 布尔值 必需

此推送是否删除了ref。

enterprise 对象

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

forced 布尔值 必需

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

head_commit 对象或 null 必需
installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

pusher 对象 必需

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

ref 字符串 必需

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

repository 对象 必填

一个 Git 存储库

sender 对象

GitHub 用户。

registry_package

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

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

注意

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

registry_package 的可用性

  • 仓库
  • 组织
  • GitHub 应用

registry_package 的 Webhook 负载对象

一个软件包已发布到注册表。

Webhook 请求正文参数
action 字符串 必填

值： published

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

registry_package 对象 必需
repository 对象

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

sender 对象 必填

GitHub 用户。

release

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

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

release 的可用性

  • 仓库
  • 组织
  • GitHub 应用

release 的 Webhook 负载对象

保存了草稿，或发布了发布或预发布，而之前没有将其保存为草稿。

Webhook 请求正文参数
action 字符串 必填

值: created

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

release 对象 必需

发布对象。

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

repository_advisory

当存储库安全公告有活动时，将触发此事件。有关存储库安全公告的更多信息，请参阅“关于 GitHub 存储库安全公告”。

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

repository_advisory 的可用性

  • 仓库
  • 组织
  • GitHub 应用

repository_advisory 的 Webhook 负载对象

发布了一个存储库安全公告。

Webhook 请求正文参数
action 字符串 必填

值： published

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

repository_advisory 对象 必需

一个存储库安全公告。

sender 对象

GitHub 用户。

repository

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

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

repository 的可用性

  • 企业
  • 仓库
  • 组织
  • GitHub 应用

repository 的 Webhook 负载对象

归档了一个仓库。

Webhook 请求正文参数
action 字符串 必填

值： archived

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

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 应用

repository_dispatch 的 Webhook 负载对象

Webhook 请求正文参数
action 字符串 必填

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

branch 字符串 必填
client_payload 对象或 null 必填

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

enterprise 对象

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

installation 对象 必填

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

repository_import

当仓库导入到 GitHub 时，将触发此事件。有关更多信息，请参阅“使用 GitHub 导入器导入仓库”。有关管理导入的 API 的更多信息，请参阅 REST API 文档。

repository_import 的可用性

  • 仓库
  • 组织

repository_import 的 Webhook 负载对象

Webhook 请求正文参数
enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

status 字符串 必填

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

repository_ruleset

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

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

repository_ruleset 的可用性

  • 仓库
  • 组织
  • GitHub 应用

repository_ruleset 的 Webhook 负载对象

创建了一个仓库规则集。

Webhook 请求正文参数
action 字符串 必填

值: created

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象

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

repository_ruleset 对象 必填

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

sender 对象 必填

GitHub 用户。

repository_vulnerability_alert

当与仓库中的安全漏洞警报相关的活动发生时，将触发此事件。

警告

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

repository_vulnerability_alert 的可用性

  • 仓库
  • 组织

repository_vulnerability_alert 的 Webhook 负载对象

创建了一个仓库漏洞警报。

Webhook 请求正文参数
action 字符串 必填

值： create

alert 对象 必需

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

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

secret_scanning_alert

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

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

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

secret_scanning_alert 的可用性

  • 仓库
  • 组织
  • GitHub 应用

secret_scanning_alert 的 Webhook 负载对象

创建了一个秘密扫描警报。

Webhook 请求正文参数
action 字符串 必填

值: created

alert 对象 必需
enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象

GitHub 用户。

secret_scanning_alert_location

当与秘密扫描警报中秘密的位置相关的活动发生时，将触发此事件。

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

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

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

secret_scanning_alert_location 的可用性

  • 仓库
  • 组织
  • GitHub 应用

secret_scanning_alert_location 的 Webhook 负载对象

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

Webhook 请求正文参数
action 字符串

值: created

alert 对象 必需
installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

location 对象 必填
organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

security_advisory

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

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

security_advisory 的可用性

  • GitHub 应用

security_advisory 的 Webhook 负载对象

将安全公告发布到 GitHub 社区。

Webhook 请求正文参数
action 字符串 必填

值： published

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象

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

security_advisory 对象 必填

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

sender 对象

GitHub 用户。

security_and_analysis

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

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

security_and_analysis 的可用性

  • 仓库
  • 组织
  • GitHub 应用

security_and_analysis 的 Webhook 负载对象

Webhook 请求正文参数
changes 对象 必填
enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

完整仓库

sender 对象

GitHub 用户。

sponsorship

当与赞助列表相关的活动发生时，将触发此事件。有关更多信息，请参阅“关于 GitHub Sponsors”。有关管理赞助商的 API 的信息，请参阅 GraphQL 文档。

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

sponsorship 的可用性

  • 赞助帐户

sponsorship 的 Webhook 负载对象

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

仅当取消定期（每月）赞助时才会发送此事件；对于一次性赞助不会发送此事件。

Webhook 请求正文参数
action 字符串 必填

值：cancelled

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象

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

sender 对象 必填

GitHub 用户。

sponsorship 对象 必填

star

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

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

star 的可用性

  • 仓库
  • 组织
  • GitHub 应用

star 的 Webhook 负载对象

有人给仓库加了星标。

Webhook 请求正文参数
action 字符串 必填

值: created

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

starred_at 字符串或 null 必填

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

status

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

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

status 的可用性

  • 仓库
  • 组织
  • GitHub 应用

status 的 Webhook 负载对象

Webhook 请求正文参数
avatar_url 字符串或 null
branches 对象数组 必填

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

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

添加到状态的可选人性化描述。

enterprise 对象

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

id 整数 必填

状态的唯一标识符。

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

name 字符串 必填
organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

sha 字符串 必填

提交 SHA。

state 字符串 必填

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

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

target_url 字符串或 null 必填

添加到状态的可选链接。

updated_at 字符串 必填

sub_issues

当与子问题相关的活动发生时，将触发此事件。

对于与问题更普遍相关的活动，请改用 issues 事件。

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

sub_issues 的可用性

  • 仓库
  • 组织
  • GitHub 应用

sub_issues 的 Webhook 负载对象

一个父问题已添加到某个问题中。

Webhook 请求正文参数
action 字符串 必填

值： parent_issue_added

parent_issue_id 数字 必填

父问题的 ID。

parent_issue 对象 必填

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

parent_issue_repo 对象 必填

GitHub 上的一个仓库。

sub_issue_id 数字 必填

子问题的 ID。

sub_issue 对象 必填

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象

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

sender 对象

GitHub 用户。

team_add

当团队被添加到仓库时，会发生此事件。有关更多信息，请参阅“管理有权访问您仓库的团队和人员”。

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

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

team_add 的可用性

  • 仓库
  • 组织
  • GitHub 应用

team_add 的 Webhook 有效负载对象

Webhook 请求正文参数
enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

team 对象 必需

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

team

当组织中与团队相关的活动发生时，会发生此事件。有关更多信息，请参阅“关于团队”。

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

team 的可用性

  • 组织
  • 企业
  • GitHub 应用

team 的 Webhook 有效负载对象

团队被授予对仓库的访问权限。

Webhook 请求正文参数
action 字符串 必填

值： added_to_repository

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象 必填

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

repository 对象

一个 Git 存储库

sender 对象

GitHub 用户。

team 对象 必需

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

watch

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

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

watch 的可用性

  • 仓库
  • 组织
  • GitHub 应用

watch 的 Webhook 有效负载对象

有人开始监视该仓库。

Webhook 请求正文参数
action 字符串 必填

值： started

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

workflow_dispatch

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

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

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

workflow_dispatch 的可用性

  • GitHub 应用

workflow_dispatch 的 Webhook 有效负载对象

Webhook 请求正文参数
enterprise 对象

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

inputs 对象或 null 必填
installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

ref 字符串 必需
repository 对象 必填

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

sender 对象 必填

GitHub 用户。

workflow 字符串 必填

workflow_job

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

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

要订阅此事件，GitHub 应用程序必须至少具有“操作”仓库权限的读取级访问权限。

workflow_job 的可用性

  • 企业
  • 仓库
  • 组织
  • GitHub 应用

workflow_job 的 Webhook 有效负载对象

工作流运行中的某个作业已完成。当工作流中的作业完成时，无论作业成功还是失败，都会发生此事件。

Webhook 请求正文参数
action 字符串 必填

值： completed

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

workflow_job 对象 必填
deployment 对象

请求部署特定 ref（分支、sha、标签）。

workflow_run

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

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

要订阅此事件，GitHub 应用程序必须至少具有“操作”仓库权限的读取级访问权限。

workflow_run 的可用性

  • 企业
  • 仓库
  • 组织
  • GitHub 应用

workflow_run 的 Webhook 有效负载对象

工作流运行已完成。当工作流运行完成时，无论工作流成功还是失败，都会发生此事件。

Webhook 请求正文参数
action 字符串 必填

值： completed

enterprise 对象

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

installation 对象

GitHub 应用安装。当事件为 GitHub 应用配置并发送到 GitHub 应用时，Webhook 负载包含 installation 属性。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。

organization 对象

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

repository 对象 必填

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

sender 对象 必填

GitHub 用户。

workflow 对象或 null 必填
workflow_run 对象 必填