关于 webhook 类型
Webhook 只能访问其所在的仓库、组织、GitHub Marketplace 账户、GitHub Sponsors 账户或 GitHub 应用中可用的事件。
您无法为个人用户账户创建 webhook,也不能订阅特定于用户资源的事件,例如个人通知或提及。
要创建和管理 webhook,您必须拥有或拥有对创建 webhook 并监听事件的资源的管理员访问权限。例如,要管理组织中的 webhook,您需要该组织的管理员权限。
某些 webhook 事件仅限于特定类型的 webhook。例如,组织 webhook 可以订阅仅在组织层面发生的事件,而仓库 webhook 则无法订阅此类事件。有关每种 webhook 的具体可用性,请参阅 Webhook 事件和有效负载。
欲了解更多信息,请参阅 关于 webhook。
仓库 webhook
您可以在仓库中创建 webhook,以订阅该仓库中发生的事件。您必须是仓库所有者或拥有仓库的管理员访问权限,才能在仓库中创建和管理 webhook。若您没有所需权限,则无法在仓库中创建、编辑或删除 webhook。
您可以在单个仓库中创建多个 webhook。但对每种单独的事件类型,最多只能创建 20 个订阅该事件的 webhook。例如,在同一仓库中,您最多只能创建 20 个各自订阅 push 事件的不同 webhook。
您可以使用 GitHub 网页界面或 REST API 来管理仓库 webhook。有关详细信息,请参阅 创建 webhook、编辑 webhook 和 停用 webhook。如需了解使用 REST API 管理仓库 webhook 的更多信息,请参阅 仓库 webhook 的 REST API 端点。
组织 webhook
您可以在组织中创建 webhook,以订阅该组织中发生的事件。组织 webhook 可以订阅组织拥有的所有仓库中的事件,也可以订阅在任何特定仓库之外、在组织层面发生的事件,例如向组织添加新成员。
您必须是组织所有者才能在组织中创建和管理 webhook。
您可以在单个组织中创建多个 webhook。但对每种单独的事件类型,最多只能创建 20 个订阅该事件的 webhook。例如,在同一组织中,您最多只能创建 20 个各自订阅 push 事件的不同 webhook。
您可以使用 GitHub 网页界面或 REST API 来管理组织 webhook。有关详细信息,请参阅 创建 webhook、编辑 webhook 和 停用 webhook。如需了解使用 REST API 管理组织 webhook 的更多信息,请参阅 组织 webhook 的 REST API 端点.
GitHub Marketplace webhook
您可以创建 webhook,以订阅与您在 GitHub Marketplace 上发布的应用相关的事件。每个 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 未订阅任何事件。您可以配置其订阅的事件。GitHub 应用 webhook 不能被删除,但您可以将其停用以停止接收 webhook 投递。
您可以使用 GitHub 网页界面或 REST API 来管理 GitHub 应用 webhook。有关详细信息,请参阅 创建 webhook、编辑 webhook 和 停用 webhook。如需了解使用 REST API 管理 GitHub 应用 webhook 的更多信息,请参阅 GitHub 应用 webhook 的 REST API 端点.