注意:GitHub Webhook 目前不支持 IPv6,但将来会支持 IPv6。 /meta
REST API 终结点返回 IPv6 范围以启用该转换。
Webhook 允许生成或设置集成,例如 GitHub Apps 或 OAuth Apps,以订阅 GitHub.com 上的某些事件。 当触发其中某个事件时,我们将向 web 挂钩的配置 URL 发送 HTTP POST 有效负载。 Web 挂钩可用于更新外部议题跟踪器、触发 CI 构建、更新备份镜像,甚至部署到生产服务器。 您只受想象力的限制。
Webhook 可以安装在 组织、特定存储库或 GitHub App 上。 安装后,每当发生一个或多个订阅事件时,都会发送 web 挂钩。
最多可以为每个安装目标 (特定组织或特定存储库)上的每个事件创建最多 20 个 Webhook。
事件
配置 web 挂钩时,您可以使用 UI 或 API 选择哪些事件将向您发送有效负载。 仅订阅您计划处理的特定事件可限制对服务器的 HTTP 请求数。 您也可以订阅所有当前和未来的事件。 默认情况下,web 挂钩只订阅推送事件。 您可以随时更改订阅事件的列表。
每个事件对应于您的组织和/或仓库可能发生的一组特定操作。 例如,如果订阅了 issues
事件,则在每次打开、关闭、标记问题等时,你都会收到详细的有效负载。
有关可用 Webhook 事件及其有效负载的完整列表,请参阅“Webhook 事件和有效负载”。
Ping 事件
当你创建新的 Webhook 时,我们将向你发送一个简单的 ping
事件,让你知道你已正确设置 Webhook。 此事件不会存储,因此无法通过事件 API 终结点进行检索。
有关 ping
事件 Webhook 有效负载的详细信息,请参阅 ping
事件。