跳至主要内容

Webhook 类型

您可以创建 Webhook 来订阅特定仓库、组织、GitHub Marketplace 帐户、GitHub Sponsors 帐户或 GitHub App 中发生的事件。

关于 Webhook 类型

Webhook 只能访问其安装所在的仓库、组织、GitHub Marketplace 帐户、GitHub Sponsors 帐户或 GitHub App 中可用的事件。

您无法为单个用户帐户创建 Webhook,也无法为特定于用户资源的事件创建 Webhook,例如个人通知或提及。

要创建和管理 Webhook,您必须拥有或具有创建 Webhook 所在资源的管理员权限,并监听该资源上的事件。例如,要管理组织中的 Webhook,您需要该组织的管理员权限。

某些 Webhook 事件是特定类型的 Webhook 独有的。例如,组织 Webhook 可以订阅仅在组织级别发生的事件,而仓库 Webhook 无法订阅这些事件。有关每个 Webhook 的特定可用性的更多信息,请参阅“Webhook 事件和有效负载”。

有关更多信息,请参阅“关于 Webhook”。

仓库 Webhook

您可以在仓库中创建 Webhook 来订阅该仓库中发生的事件。您必须是仓库所有者或具有仓库的管理员权限才能在仓库中创建和管理 Webhook。您无法在您没有所需权限的仓库中创建、编辑或删除 Webhook。

您可以在单个仓库中创建多个 Webhook。但是,您最多只能创建 20 个订阅每个单独事件类型的 Webhook。例如,在单个仓库中,您最多只能创建 20 个不同的 Webhook,每个 Webhook 都订阅 push 事件。

您可以使用 GitHub 网页界面或 REST API 来管理仓库 Webhook。有关更多信息,请参阅“创建 Webhook”、“编辑 Webhook”和“禁用 Webhook”。有关使用 REST API 管理仓库 Webhook 的更多信息,请参阅“仓库 Webhook 的 REST API 端点”。

组织 Webhook

您可以在组织中创建 Webhook,以订阅该组织中发生的事件。组织 Webhook 可以订阅发生在组织拥有的所有存储库中的事件。它们还可以订阅发生在组织级别且不在任何特定存储库中的事件,例如当向组织添加新成员时。

您必须是组织所有者才能在组织中创建和管理 Webhook。

您可以在单个组织中创建多个 Webhook。但是,您最多只能创建 20 个订阅每个单独事件类型的 Webhook。例如,在单个组织中,您最多只能创建 20 个不同的 Webhook,每个 Webhook 都订阅 push 事件。

您可以使用 GitHub 网页界面或 REST API 来管理组织 Webhook。有关更多信息,请参阅“创建 Webhook”,“编辑 Webhook”和“禁用 Webhook”。有关使用 REST API 管理组织 Webhook 的更多信息,请参阅“组织 Webhook 的 REST API 端点”。

GitHub Marketplace Webhook

您可以创建 Webhook 来订阅与您在 GitHub Marketplace 中发布的应用相关的事件。您只能为 GitHub Marketplace 中的每个应用创建一个 Webhook。只有应用的所有者或拥有该应用的组织的应用管理员才能创建和管理 GitHub Marketplace Webhook。

GitHub Marketplace Webhook 不能删除,但您可以将其停用以停止接收 Webhook 传递。

您可以使用 GitHub 网页界面来管理 GitHub Marketplace Webhook。有关更多信息,请参阅“创建 Webhook”,“编辑 Webhook”和“禁用 Webhook”。

GitHub Sponsors Webhook

您可以创建 Webhook 来订阅与 GitHub Sponsors 相关的事件。您最多只能为 GitHub Sponsors 帐户创建 20 个 Webhook。

您必须是帐户所有者或在赞助帐户中拥有管理员权限才能管理赞助 Webhook。

您可以使用 GitHub 网页界面管理 GitHub Sponsors Webhook。有关更多信息,请参阅“创建 Webhook”,“编辑 Webhook”和“禁用 Webhook”。

GitHub 应用 Webhook

您可以配置 GitHub 应用以在应用程序被授予访问权限的存储库或组织中发生特定事件时接收 Webhook。

每个 GitHub 应用都有一个由 GitHub 自动创建的单个 Webhook。默认情况下,Webhook 未订阅任何事件。您可以配置 Webhook 订阅的事件。无法删除 GitHub 应用 Webhook,但您可以将其停用以停止接收 Webhook 传递。

您可以使用 GitHub 网页界面或 REST API 来管理 GitHub 应用 Webhook。有关更多信息,请参阅“创建 Webhook”,“编辑 Webhook”和“禁用 Webhook”。有关使用 REST API 管理 GitHub 应用 Webhook 的更多信息,请参阅“GitHub 应用 Webhook 的 REST API 端点”。