Skip to main content

Enterprise Server 3.20 目前作为发布候选版本提供。

Webhook 的类型

可以通过创建 Webhook 订阅特定存储库、组织、GitHub Enterprise、 或 GitHub App 中发生的事件。

关于 Webhook 类型

Webhook 仅可访问安装了 Webhook 的存储库,组织,GitHub Enterprise, 或 GitHub App 中的可用事件。

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

要创建和管理 Webhook,必须拥有创建 Webhook 并侦听事件的资源或拥有该资源的管理员访问权限。 例如,若要管理组织内的 Webhook,您需要具有该组织的管理员权限。

某些 Webhook 事件是特定类型的 Webhook 独有的。 例如,组织 Webhook 可以订阅仅在组织级别发生的事件,存储库 Webhook 无法订阅这些事件。 有关每个 webhook 的具体可用性的详细信息,请参阅 Webhook 事件和有效负载

有关详细信息,请参阅“关于 网络钩子”。

仓库网络钩子

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

可以在单个存储库中创建多个 Webhook。 但是,仅能创建最多 250 个订阅各个事件类型 的 Webhook。 例如,在单个存储库中,仅能创建最多 250 个订阅 push 事件的不同 Webhook。

可以使用 GitHub Web 界面或 REST API 来管理存储库 Webhook。 有关详细信息,请参阅“创建网络钩子”、“测试 Webhook”和“禁用网络钩子 (Webhook)”。 有关使用 REST API 管理存储库 Webhook 的详细信息,请参阅“存储库 Webhook 的 REST API 终结点”。

组织 web 挂钩

可以在组织中创建 Webhook 以订阅在该组织中发生的事件。 组织 Webhook 可以订阅组织拥有的所有存储库中发生的事件。 用户还可以订阅在组织级别发生的、超出任何特定存储库范围的事件,例如新增组织成员时的情况。

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

可以在单个组织中创建多个 Webhook。 但是,仅能创建最多 250 个订阅各个事件类型 的 Webhook。 例如,在单个组织中,仅能创建最多 250 个订阅 push 事件的不同 Webhook。

可以使用 GitHub Web 界面或 REST API 来管理组织 Webhook。 有关详细信息,请参阅“创建网络钩子”、“测试 Webhook”和“禁用网络钩子 (Webhook)”。 有关使用 REST API 管理组织 Webhook 的详细信息,请参阅“用于组织 Webhooks 的 REST API 接口节点”。

GitHub Enterprise

的全局 Webhook

企业所有者可以创建全局 Webhook 以订阅企业或企业拥有的组织和存储库中发生的事件。

可以在单个企业中创建多个 Webhook。 但是,仅能创建最多 250 个订阅各个事件类型 的 Webhook。 例如,在单个企业中,仅能创建最多 250 个订阅 membership 事件的不同 Webhook。

可以使用 GitHub Web 界面来管理全局 Webhook。 有关详细信息,请参阅“创建网络钩子”、“测试 Webhook”和“禁用网络钩子 (Webhook)”。 你还可以使用 REST API 管理全局 Webhook。 有关终结点的完整列表,请参阅“适用于全球 Webhook 的 REST API 终结点”。

GitHub App Webhook

可以配置 GitHub App,使其在应用有权访问的仓库或组织中发生特定事件时接收 Webhook 通知。

每个 GitHub App 都有一个 Webhook,该 Webhook 由 GitHub 自动创建。 默认情况下,Webhook 不会订阅任何事件。 您可以配置 Webhook 所订阅的事件。 GitHub App Webhook 无法删除,但停用即可停止接收 Webhook 交付。

可以使用 GitHub Web 界面或 REST API 来管理 GitHub App Webhook。 有关详细信息,请参阅“创建网络钩子”、“测试 Webhook”和“禁用网络钩子 (Webhook)”。 有关使用 REST API 管理 GitHub App Webhook 的详细信息,请参阅“GitHub App Webhooks 的 REST API 接口终端”。