Webhook 事件和有效负载

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

本文内容

关于 Webhook 事件和有效负载

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

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

每个事件仅对特定类型的 Webhook 可用。例如，组织 Webhook 可以订阅 team 事件，但存储库 Webhook 无法订阅。每个 Webhook 事件的描述列出了该事件的可用性。有关更多信息，请参阅“Webhook 类型”。

有效负载上限

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

传递标头

传递到 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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 字符串 必需

值: created

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

rule 对象 必需

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

sender 对象 必需

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

check_run

当与检查运行相关的活动发生时，会触发此事件。有关检查运行的信息，请参阅“开始使用检查 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 字符串

值: completed

check_run 对象 必需

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender 对象 必需

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

check_suite

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

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

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

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

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

check_suite 的可用性

  • 存储库
  • 组织
  • GitHub 应用

check_suite 的 Webhook 有效负载对象

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

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

值: completed

check_suite 对象 必需
enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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。

值: created

comment 对象 必需

提交注释 资源。

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 string 或 null 必需

存储库的当前描述。

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

master_branch string 必需

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

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

pusher_type string 必需

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

ref 字符串 必需

git ref 资源。

ref_type string 必需

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

可以是: tag, branch

repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender 对象 必需

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

custom_property

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

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

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

custom_property 的可用性

  • 组织
  • GitHub 应用

custom_property 的 Webhook 有效负载对象

创建了新的自定义属性。

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

值: created

definition object 必需

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

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization object 必需

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

sender object

触发事件的 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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

organization object 必需

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

sender object

触发事件的 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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

pusher_type string 必需

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

ref 字符串 必需

git ref 资源。

ref_type string 必需

存储库中删除的 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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 字符串 必需

值: created

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

key object 必需

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

值: created

deployment object 必需
enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender 对象 必需

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

workflow object 或 null 必需
workflow_run object 或 null 必需

deployment_protection_rule

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

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

deployment_protection_rule 的可用性

  • GitHub 应用

deployment_protection_rule 的 Webhook 有效负载对象

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

Webhook 请求正文参数
action 字符串

值: requested

environment string

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

event string

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

deployment_callback_url string

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

deployment object

部署特定 ref(分支、sha、标签) 的请求

pull_requests array of objects
repository object

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

sender object

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

deployment_review

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

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

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

deployment_review 的可用性

  • GitHub 应用

deployment_review 的 Webhook 有效负载对象

已批准部署审核。

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

值: approved

approver object
comment 字符串
enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization object 必需

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

reviewers 对象数组
sender 对象 必需

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

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

deployment_status

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

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

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

deployment_status 的可用性

  • 存储库
  • 组织
  • GitHub 应用

deployment_status 的 Webhook 有效负载对象

已创建新的部署状态。

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

值: created

check_run 对象或 null
deployment object 必需
deployment_status 对象 必需
enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 字符串 必需

值: created

comment 对象 必需
discussion 对象 必需

存储库中的讨论。

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender 对象 必需

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

fork

此事件在有人 fork 存储库时发生。有关更多信息，请参阅“fork 存储库”。有关管理 fork 的 API 信息，请参阅 REST API 文档中的“fork”。

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

fork 的可用性

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

fork 的 Webhook 有效负载对象

Webhook 请求正文参数
enterprise 对象

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

forkee 对象 必需

创建的 repository 资源。

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 错误的凭据 错误。有关需要 GitHub 应用授权的用户访问令牌的请求的详细信息，请参阅“以用户身份使用 GitHub 应用进行身份验证”。

github_app_authorization 的可用性

  • GitHub 应用

github_app_authorization 的 Webhook 有效负载对象

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

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

值: 已撤销

sender 对象 必需

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

gollum

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

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

gollum 的可用性

  • 存储库
  • 组织
  • GitHub 应用

gollum 的 Webhook 有效负载对象

Webhook 请求正文参数
enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

页面 对象数组 必需

已更新的页面。

repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender 对象 必需

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

安装

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

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

安装 的可用性

  • GitHub 应用

安装 的 Webhook 有效负载对象

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

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

值: created

enterprise 对象

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

安装 对象 必需

安装

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

存储库 对象数组

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

repository object

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

请求者 对象或 null
sender 对象 必需

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

安装存储库

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

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

安装存储库 的可用性

  • GitHub 应用

安装存储库 的 Webhook 有效负载对象

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

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

值: added

enterprise 对象

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

安装 对象 必需

安装

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repositories_added 对象数组 必需

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

repositories_removed 对象数组 必需

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

repository object

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

repository_selection 字符串 必需

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

可以是: all, selected

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

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

installation_target

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

installation_target 的可用性

  • GitHub 应用

installation_target 的 Webhook 有效负载对象

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

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

值: renamed

changes 对象 必需
enterprise 对象

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

安装 对象 必需

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository object

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender object

触发事件的 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 字符串 必需

值: created

comment 对象 必需

评论本身。

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 字符串 必需

执行的操作。

值: 已分配

assignee 对象或 null
enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

issue 对象 必需

问题本身。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender 对象 必需

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

标签

此事件发生在与标签相关的活动时。有关更多信息，请参阅“管理标签”。有关管理标签的 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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

label 对象 必需
organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender object

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

市场购买

此事件发生在与 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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

marketplace_purchase 对象 必需
organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

previous_marketplace_purchase 对象
repository object

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender 对象 必需

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

成员

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

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

member 的可用性

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

member 的 Webhook 有效负载对象

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

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

值: added

changes 对象
enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

member 对象或 null 必需
organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender 对象 必需

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

成员资格

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

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

membership 的可用性

  • 组织
  • 企业
  • GitHub 应用

membership 的 Webhook 有效负载对象

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

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

值: added

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

member 对象或 null 必需
organization object 必需

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository object

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

scope 字符串 必需

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

值: team

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

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

合并组

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

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

merge_group 的可用性

  • GitHub 应用

merge_group 的 Webhook 有效负载对象

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

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

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

值: checks_requested

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

merge_group 对象 必需

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

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository object

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender object

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

meta

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

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

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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository object

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender object

触发事件的 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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

milestone 对象 必需

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

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender 对象 必需

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

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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization object 必需

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository object

事件发生的 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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

membership 对象

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

organization object 必需

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository object

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender 对象 必需

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

package

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

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

package 的可用性

  • 存储库
  • 组织
  • GitHub 应用

package 的 Webhook 有效负载对象

已将一个包发布到注册表。

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

值: 已发布

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

package 对象 必需

有关包的信息。

repository object

事件发生的 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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 object 必需

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

sender 对象 必需

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

安装 对象 必需

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 object

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender object

触发事件的 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 字符串 必需

值: 已转换

changes 对象 必需
enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

project_card 对象 必需
repository object

事件发生的 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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

project 对象 必需
repository object

事件发生的 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 字符串 必需

值: created

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

project_column 对象 必需
repository object

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender object

触发事件的 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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization object 必需

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

projects_v2 对象 必需

projects v2 项目

sender 对象 必需

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

projects_v2_item

当与组织级项目上的项目相关联的活动发生时，此事件发生。有关详细信息，请参阅“关于项目”。有关 Projects API 的信息，请参阅 GraphQL 文档。

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

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

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

projects_v2_item 的可用性

  • 组织

projects_v2_item 的 Webhook 有效负载对象

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

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

值: 已存档

changes 对象 必需
installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization object 必需

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

projects_v2_item 对象 必需

属于项目的项目

sender 对象 必需

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

public

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

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

public 的可用性

  • 存储库
  • 组织
  • GitHub 应用

public 的 Webhook 有效负载对象

Webhook 请求正文参数
enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 字符串 必需

值: 已分配

assignee 对象或 null 必需
enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 字符串 必需

值: created

comment 对象 必需

评论本身。

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

pull_request 对象 必需
repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

review 对象 必需

受影响的审核。

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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

pull_request 对象 必需
repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender object

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

thread 对象 必需

push

当将内容推送到存储库分支时，会发生此事件。这包括在推送提交、推送提交标记、删除分支、删除标记或从模板创建存储库时。若要仅订阅分支和标记删除，请使用 delete Webhook 事件。

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

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

push 的可用性

  • 存储库
  • 组织
  • GitHub 应用

push 的 Webhook 有效负载对象

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

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

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

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

commits 对象数组 必需

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

compare 字符串 必需

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

created 布尔值 必需

此推送是否创建了ref。

deleted 布尔值 必需

此推送是否删除了ref。

enterprise 对象

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

forced 布尔值 必需

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

head_commit 对象或 null 必需
installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

pusher 对象 必需

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

ref 字符串 必需

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

repository 对象 必需

一个 git 存储库

sender object

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

registry_package

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

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

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

registry_package的可用性

  • 存储库
  • 组织
  • GitHub 应用

registry_package的 Webhook 负载对象

已将一个包发布到注册表。

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

值: 已发布

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

registry_package 对象 必需
repository object

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender 对象 必需

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

release

当与版本相关的活动发生时，将触发此事件。有关详细信息，请参阅“关于版本”。有关管理版本的 API 的信息，请参阅 GraphQL API 文档 或 REST API 文档中的“版本”。

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

release的可用性

  • 存储库
  • 组织
  • GitHub 应用

release的 Webhook 负载对象

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

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

值: created

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 字符串 必需

值: 已发布

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

repository_advisory 对象 必需

存储库安全建议。

sender object

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

repository

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

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

repository 的可用性

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

repository 的 Webhook 有效负载对象

存储库已存档。

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

值: 已存档

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 对象或 null 必需

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

enterprise 对象

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

安装 对象 必需

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 字符串 必需

值: created

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository object

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

repository_ruleset 对象 必需

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

sender 对象 必需

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

repository_vulnerability_alert

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

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

repository_vulnerability_alert 的可用性

  • 存储库
  • 组织

repository_vulnerability_alert 的 Webhook 有效负载对象

创建了存储库漏洞警报。

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

值: create

alert 对象 必需

漏洞依赖项的安全警报。

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender 对象 必需

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

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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender object

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

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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

location 对象 必需
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 字符串 必需

值: 已发布

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository object

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

security_advisory 对象 必需

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

sender object

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

security_and_analysis

当为存储库启用或禁用代码安全和分析功能时，会发生此事件。有关详细信息，请参阅“GitHub 安全功能”。

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

security_and_analysis 的可用性

  • 存储库
  • 组织
  • GitHub 应用

security_and_analysis 的 Webhook 有效负载对象

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

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository 对象 必需

完整存储库

sender object

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

sponsorship

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

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

sponsorship 的可用性

  • 赞助帐户

sponsorship 的 Webhook 有效负载对象

赞助已取消，并且最后一个账单周期已结束。

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

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

值: cancelled

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository object

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender 对象 必需

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

sponsorship 对象 必需

star

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

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

star 的可用性

  • 存储库
  • 组织
  • GitHub 应用

star 的 Webhook 有效负载对象

有人标星了一个存储库。

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

值: created

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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。

状态

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

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

status 的可用性

  • 存储库
  • 组织
  • GitHub 应用

status 的 Webhook 有效负载对象

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

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

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

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

enterprise 对象

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

id 整数 必需

状态的唯一标识符。

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 字符串或 null 必需

添加到状态的可选链接。

updated_at 字符串 必需

team_add

此事件在向代码仓库添加团队时发生。有关详细信息，请参阅“管理有权访问代码仓库的团队和人员”。

有关团队相关活动的详细信息，请参阅teams 事件。

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

team_add 的可用性

  • 存储库
  • 组织
  • GitHub 应用

team_add 的 Webhook 有效负载对象

Webhook 请求正文参数
enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization object 必需

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository object

一个 git 存储库

sender object

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

team 对象 必需

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

watch

此事件在与关注或订阅代码仓库相关的活动发生时发生。有关关注的详细信息，请参阅“管理订阅”。有关用于管理关注的 API 的详细信息，请参阅 REST API 文档中的“关注”。

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

watch 的可用性

  • 存储库
  • 组织
  • GitHub 应用

watch 的 Webhook 有效负载对象

有人开始关注此代码仓库。

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

值: started

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 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 应用必须至少具有“操作”存储库权限的读取级别访问权限。

workflow_job 的可用性

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

workflow_job 的 Webhook 有效负载对象

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

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

值: completed

enterprise 对象

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

installation 对象

GitHub App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender 对象 必需

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

workflow_job 对象 必需
deployment object

部署特定 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 App 安装。当针对 GitHub App 配置事件并将其发送到 GitHub App 时，Webhook 有效负载包含 installation 属性。更多信息，请参阅“使用 GitHub App 的 Webhook”。

organization 对象

GitHub 组织。当为组织配置 Webhook，或当事件发生在属于组织的存储库中的活动时，Webhook 有效负载包含 organization 属性。

repository 对象 必需

事件发生的 GitHub 上的存储库。当事件发生在存储库中的活动时，Webhook 有效负载包含 repository 属性。

sender 对象 必需

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

workflow object 或 null 必需
workflow_run 对象 必需