Webhook 事件和有效负载

了解每个 Webhook 事件何时发生以及有效负载包含的内容。

本文内容

关于 Webhook 事件和有效负载

您可以创建订阅此页面上列出的事件的 Webhook。为了限制发送到您服务器的 HTTP 请求数量，您应该只订阅您计划处理的特定事件。有关更多信息，请参阅“创建 Webhook”。

本页面的每个 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 字符串 必需

值: 已禁用

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

branch_protection_rule

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

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

branch_protection_rule 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

branch_protection_rule 的 Webhook 负载对象

创建了一个分支保护规则。

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

值: 创建

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

rule 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

check_run

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

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

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

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

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

check_run 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

check_run 的 Webhook 有效负载对象

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

Webhook 请求正文参数
action string

值: completed

check_run object 必需

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

check_suite

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

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

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

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

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

check_suite的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

check_suite的 Webhook 有效负载对象

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

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

值: completed

check_suite 对象 必需
enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

code_scanning_alert

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

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

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 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

ref 字符串 必需

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

commit_comment

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

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

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

commit_comment 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

commit_comment 的 Webhook 负载对象

有人评论了提交。

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

执行的操作。可以是 created。

值: 创建

comment 对象 必需

提交评论资源。 提交评论

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

create

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

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

注意:

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

create 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

create 的 Webhook 负载对象

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

存储库的当前描述。

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

master_branch 字符串 必需

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

organization 对象

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

pusher_type 字符串 必需

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

ref 字符串 必需

git ref 资源。 git ref

ref_type 字符串 必需

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

可以是以下之一： tag, branch

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

custom_property

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

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

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

custom_property 的可用性

  • 组织
  • GitHub 应用程序

custom_property 的 Webhook 负载对象

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

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

值: 创建

definition 对象 必需

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

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象 必需

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

sender 对象

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

custom_property_values

当存储库的自定义属性值发生活动时，会发生此事件。

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

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

custom_property_values 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

custom_property_values 的 Webhook 负载对象

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

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

值: updated

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

repository 对象 必需

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

organization 对象 必需

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

sender 对象

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

new_property_values 对象数组 必需

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

old_property_values 对象数组 必需

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

delete

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

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

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

delete 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

delete 的 Webhook 负载对象

Webhook 请求正文参数
enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

pusher_type 字符串 必需

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

ref 字符串 必需

git ref 资源。 git ref

ref_type 字符串 必需

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

可以是以下之一： tag, branch

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

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 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

enterprise 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

deploy_key

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

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

deploy_key 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

deploy_key 的 Webhook 有效负载对象

创建了部署密钥。

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

值: 创建

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

key 对象 必需

有关 部署密钥 资源的信息。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

deployment

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

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

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

deployment 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

deployment 的 Webhook 有效负载对象

创建了部署。

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

值: 创建

deployment 对象 必需

该 部署。

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

workflow 对象或空值 必需
workflow_run 对象或空值 必需

deployment_protection_rule

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

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

deployment_protection_rule 的可用性

  • GitHub 应用程序

deployment_protection_rule 的 Webhook 有效负载对象

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

Webhook 请求正文参数
action string

值: 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 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

sender 对象

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

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 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象 必需

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

repository 对象 必需

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

reviewers 对象数组
sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

since 字符串 必填
workflow_job_run 对象
workflow_job_runs 对象数组
workflow_run 对象或空值 必需

deployment_status

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

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

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

deployment_status 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

deployment_status 的 Webhook 有效负载对象

创建了一个新的部署状态。

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

值: 创建

check_run 对象或 null
deployment 对象 必需

该 部署。

deployment_status 对象 必填
enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

workflow 对象或 null
workflow_run 对象或 null

discussion

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

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

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

注意：GitHub 讨论的 Webhook 事件目前处于测试阶段，可能会发生变化。

discussion 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

discussion 的 Webhook 负载对象

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

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

值: 已回答

answer 对象 必需
discussion 对象 必需

仓库中的讨论。

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

discussion_comment

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

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

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

注意：GitHub 讨论的 Webhook 事件目前处于测试阶段，可能会发生变化。

discussion_comment 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

discussion_comment 的 Webhook 负载对象

讨论中的评论已创建。

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

值: 创建

comment 对象 必需
discussion 对象 必需

仓库中的讨论。

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

fork

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

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

fork 的可用性

  • 企业
  • 存储库
  • 组织
  • GitHub 应用程序

fork 的 Webhook 负载对象

Webhook 请求正文参数
enterprise 对象

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

forkee 对象 必需

已创建的 repository 资源。

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

github_app_authorization

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

GitHub 应用默认情况下会收到此 Webhook，并且无法取消订阅此事件。

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

github_app_authorization 的可用性

  • GitHub 应用程序

github_app_authorization 的 Webhook 有效负载对象

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

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

值: revoked

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

gollum

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

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

gollum 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

gollum 的 Webhook 有效负载对象

Webhook 请求正文参数
enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

pages 对象数组 必需

已更新的页面。

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

installation

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

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

installation 的可用性

  • GitHub 应用程序

installation 的 Webhook 有效负载对象

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

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

值: 创建

enterprise 对象

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

installation 对象 必需

安装

organization 对象

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

repositories 对象数组

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

repository 对象

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

requester 对象或 null
sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

installation_repositories

当与 GitHub 应用安装可以访问的存储库相关的活动发生时，会发生此事件。所有 GitHub 应用默认都会收到此事件。您无法手动订阅此事件。

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

installation_repositories 的可用性

  • GitHub 应用程序

installation_repositories 的 Webhook 有效负载对象

GitHub 应用安装已授予对一个或多个存储库的访问权限。

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

值: 添加

enterprise 对象

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

installation 对象 必需

安装

organization 对象

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

repositories_added 对象数组 必需

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

repositories_removed 对象数组 必需

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

repository 对象

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

repository_selection 字符串 必需

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

可以是以下之一: 所有, 已选择

requester 对象或 null 必需
sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

installation_target

当与 GitHub App 安装所在的 用户或组织帐户 相关的活动发生时，会触发此事件。有关更多信息，请参阅“关于应用程序”。有关管理 GitHub 应用程序的 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 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象

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

sender 对象

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

target_type 字符串 必需

issue_comment

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

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

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

issue_comment 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

issue_comment 的 Webhook 负载对象

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

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

值: 创建

comment 对象 必需

评论本身，详情请见 评论。

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

issue 对象 必填

评论所属的 问题。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

issues

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

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

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

issues 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

issues 的 Webhook 负载对象

问题被分配给用户。

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

执行的操作。

值: assigned

assignee 对象或 null
enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

issue 对象 必填

问题本身，详情请见 问题。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

label

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

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

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

label 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

label 的 Webhook 负载对象

创建了标签。

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

值: 创建

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

label object 必需
organization 对象

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

repository 对象 必需

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

sender 对象

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

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 string 必需
enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

marketplace_purchase object 必需
organization 对象

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

previous_marketplace_purchase object
repository 对象

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

member

当发生与仓库协作者相关的活动时，会触发此事件。有关更多信息，请参阅 "在您的组织中向仓库添加外部协作者"。有关管理仓库协作者的 API 的更多信息，请参阅 GraphQL API 文档 或 REST API 文档中的 "协作者"。

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

member 的可用性

  • 企业
  • 存储库
  • 组织
  • GitHub 应用程序

member 的 Webhook 负载对象

GitHub 用户接受了仓库邀请。

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

值: 添加

changes object
enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

member object 或 null 必需
organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

membership

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

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

membership 的可用性

  • 组织
  • 企业
  • GitHub 应用程序

membership 的 Webhook 负载对象

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

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

值: 添加

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

member object 或 null 必需
organization 对象 必需

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

repository 对象

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

scope 字符串 必需

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

值: team

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

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

merge_group

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

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

merge_group 的可用性

  • GitHub 应用程序

merge_group 的 Webhook 负载对象

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

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

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

值: checks_requested

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

merge_group 对象 必需

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

organization 对象

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

repository 对象

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

sender 对象

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

meta

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

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

meta 的可用性

  • GitHub Marketplace
  • 企业
  • 存储库
  • 组织
  • GitHub 应用程序

meta 的 Webhook 有效负载对象

Webhook 已删除。

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

值: deleted

enterprise 对象

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

hook 对象 必需

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

hook_id 整数 必需

修改后的 Webhook 的 ID。

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象

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

sender 对象

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

milestone

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

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

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

milestone 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

milestone 的 Webhook 有效负载对象

里程碑已关闭。

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

值: closed

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

milestone 对象 必需

一组相关的问题和拉取请求。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

org_block

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

如果您希望在组织成员添加或删除时收到事件，请使用organization事件。

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

org_block 的可用性

  • 组织
  • 企业
  • GitHub 应用程序

org_block 的 Webhook 有效负载对象

用户被阻止加入组织。

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

值: blocked

blocked_user 对象或空值 必需
enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象 必需

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

repository 对象

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

organization

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

如果您希望在非成员被阻止或解除阻止加入组织时收到事件，请使用org_block事件。

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

organization 的可用性

  • 组织
  • 企业
  • GitHub 应用程序

organization 的 Webhook 有效负载对象

组织已被删除。

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

值: deleted

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

membership 对象

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

organization 对象 必需

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

repository 对象

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

package

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

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

package 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

package 的 Webhook 有效负载对象

一个包已发布到注册表。

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

值: published

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

package 对象 必需

有关包的信息。

repository 对象

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

page_build

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

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

page_build 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

page_build 的 Webhook 有效负载对象

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

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

id 整数 必需
installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

personal_access_token_request

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

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

注意：细粒度 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 用户。此属性包含在每个 Webhook 负载中。

installation 对象 必需

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

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 用户。此属性包含在每个 Webhook 负载中。

zen 字符串

GitHub zen 的随机字符串。

project_card

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

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

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

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

project_card 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

project_card 的 Webhook 有效负载对象

项目（经典）中的笔记已转换为问题。

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

值: converted

changes 对象 必需
enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

project_card 对象 必需
repository 对象

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

project

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

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

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

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

project 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

project 的 Webhook 负载对象

项目（经典）已关闭。

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

值: closed

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

project 对象 必需
repository 对象

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

project_column

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

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

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

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

project_column 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

project_column 的 Webhook 负载对象

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

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

值: 创建

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

project_column 对象 必需
repository 对象

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

sender 对象

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

projects_v2

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

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

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

注意：项目 Webhook 事件目前处于测试阶段，可能会发生变化。要与 GitHub 分享有关项目 Webhook 的反馈，请参阅项目 Webhook 反馈讨论。

projects_v2的可用性

  • 组织

projects_v2的 Webhook 有效负载对象

组织中的项目已关闭。

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

值: closed

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象 必需

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

projects_v2 对象 必需

一个 projects v2 项目

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

projects_v2_item

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

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

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

注意：项目 Webhook 事件目前处于测试阶段，可能会发生变化。要与 GitHub 分享有关项目 Webhook 的反馈，请参阅项目 Webhook 反馈讨论。

projects_v2_item的可用性

  • 组织

projects_v2_item的 Webhook 有效负载对象

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

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

值: 已归档

changes 对象 必需
installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象 必需

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

projects_v2_item 对象 必需

属于项目的项目

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

public

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

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

public 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

public 的 Webhook 负载对象

Webhook 请求正文参数
enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

pull_request

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

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

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

pull_request 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

pull_request 的 Webhook 负载对象

拉取请求已分配给用户。

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

值: assigned

assignee 对象或 null 必需
enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

number 整数 必需

拉取请求编号。

organization 对象

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

pull_request 对象 必需
repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

pull_request_review_comment

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

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

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

pull_request_review_comment 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

pull_request_review_comment 的 Webhook 负载对象

在拉取请求差异中创建了评论。

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

值: 创建

comment 对象 必需

评论本身。 评论

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

pull_request 对象 必需
repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

pull_request_review

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

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

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

pull_request_review 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

pull_request_review 的 Webhook 负载对象

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

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

值: 已驳回

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

pull_request 对象 必需
repository 对象 必需

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

审查 对象 必需

受影响的审查。

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

pull_request_review_thread

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

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

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

pull_request_review_thread的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

pull_request_review_thread的Webhook有效负载对象

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

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

值: 已解决

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

pull_request 对象 必需
repository 对象 必需

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

sender 对象

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

thread 对象 必需

push

当对仓库分支进行推送时，会发生此事件。这包括推送提交、推送提交标签、删除分支、删除标签或从模板创建仓库时。要仅订阅分支和标签删除，请使用delete Webhook事件。

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

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

push的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

push的Webhook有效负载对象

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

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

base_ref 字符串或空 必需
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 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

pusher 对象 必需

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

ref 字符串 必需

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

repository 对象 必需

一个 Git 仓库

sender 对象

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

registry_package

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

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

注意：GitHub 建议您使用更新的package 事件。

registry_package 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

registry_package 的 Webhook 有效负载对象

一个包已发布到注册表。

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

值: published

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

registry_package 对象 必需
repository 对象

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

release

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

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

release 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

release 的 Webhook 负载对象

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

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

值: 创建

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

release 对象 必需

该发布对象。

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

repository_advisory

当与仓库安全建议相关的活动发生时，会触发此事件。有关仓库安全建议的更多信息，请参阅“关于 GitHub 仓库安全建议”。

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

repository_advisory 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

repository_advisory 的 Webhook 负载对象

发布了仓库安全建议。

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

值: published

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

repository_advisory 对象 必需

仓库安全建议。

sender 对象

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

repository

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

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

repository 的可用性

  • 企业
  • 存储库
  • 组织
  • GitHub 应用程序

repository 的 Webhook 负载对象

仓库已存档。

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

值: 已归档

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

repository_dispatch

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

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

repository_dispatch 的可用性

  • GitHub 应用程序

repository_dispatch 的 Webhook 负载对象

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

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

branch 字符串 必需
client_payload 对象或空 必需

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

enterprise 对象

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

installation 对象 必需

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

repository_import

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

repository_import 的可用性

  • 存储库
  • 组织

repository_import 的 Webhook 负载对象

Webhook 请求正文参数
enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

status 字符串 必需

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

repository_ruleset

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

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

repository_ruleset 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

repository_ruleset 的 Webhook 负载对象

创建了一个仓库规则集。

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

值: 创建

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象

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

repository_ruleset 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

repository_vulnerability_alert

当存储库中出现与安全漏洞警报相关的活动时，会发生此事件。

注意：此事件已弃用。请改用 dependabot_alert 事件。

repository_vulnerability_alert 的可用性

  • 存储库
  • 组织

repository_vulnerability_alert 的 Webhook 有效负载对象

创建了一个存储库漏洞警报。

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

值: 创建

alert 对象 必需

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

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

secret_scanning_alert

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

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

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

secret_scanning_alert 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

secret_scanning_alert 的 Webhook 有效负载对象

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

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

值: 创建

alert 对象 必需
enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

secret_scanning_alert_location

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

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

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

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

secret_scanning_alert_location 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

secret_scanning_alert_location 的 Webhook 有效负载对象

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

Webhook 请求正文参数
action string

值: 创建

alert 对象 必需
installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

location object 必填
organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

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 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象

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

security_advisory object 必填

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

sender 对象

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

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 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

完整仓库

sender 对象

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

sponsorship

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

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

sponsorship 的可用性

  • 赞助帐户

sponsorship 的 Webhook 有效负载对象

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

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

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

值: cancelled

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

sponsorship 对象 必需

star

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

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

star 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

star 的 Webhook 负载对象

有人给仓库加了星标。

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

值: 创建

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

starred_at 字符串或 null 必需

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

status

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

要订阅此事件，GitHub 应用必须至少具有 "Commit statuses" 仓库权限的读取级别访问权限。

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 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

name 字符串 必需
organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

sha 字符串 必需

提交 SHA。

state 字符串 必需

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

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

target_url 字符串或空 必需

添加到状态的可选链接。

updated_at 字符串 必需

team_add

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

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

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

team_add 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

team_add 的 Webhook 负载对象

Webhook 请求正文参数
enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

team 对象 必需

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

team

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

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

team 的可用性

  • 组织
  • 企业
  • GitHub 应用程序

team 的 Webhook 负载对象

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

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

值: added_to_repository

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象 必需

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

repository 对象

一个 Git 仓库

sender 对象

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

team 对象 必需

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

watch

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

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

watch 的可用性

  • 存储库
  • 组织
  • GitHub 应用程序

watch 的 Webhook 负载对象

有人开始关注仓库。

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

值: started

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

workflow_dispatch

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

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

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

workflow_dispatch 的可用性

  • GitHub 应用程序

workflow_dispatch 的 Webhook 负载对象

Webhook 请求正文参数
enterprise 对象

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

inputs 对象或 null 必需
installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

ref 字符串 必需
repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

workflow 字符串 必需

workflow_job

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

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

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

workflow_job 的可用性

  • 企业
  • 存储库
  • 组织
  • GitHub 应用程序

workflow_job 的 Webhook 负载对象

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

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

值: completed

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

workflow_job 对象 必需
deployment 对象

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

workflow_run

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

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

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

workflow_run 的可用性

  • 企业
  • 存储库
  • 组织
  • GitHub 应用程序

workflow_run 的 Webhook 负载对象

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

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

值: completed

enterprise 对象

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

installation 对象

GitHub 应用程序安装。当为 GitHub 应用程序配置事件并将其发送到 GitHub 应用程序时，webhook 有效负载包含 installation 属性。有关更多信息，请参阅“使用 GitHub 应用程序的 webhook”。

organization 对象

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

repository 对象 必需

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

sender 对象 必需

触发事件的 GitHub 用户。此属性包含在每个 Webhook 负载中。

workflow 对象或空值 必需
workflow_run 对象 必需