我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

关于 web 挂钩

了解 Webhook 如何帮助您构建和设置集成的基础知识。

本文内容

Web 挂钩允许您构建或设置集成,例如 GitHub 应用程序OAuth 应用程序,以订阅 GitHub.com 上的某些事件。 当触发其中某个事件时,我们将向 web 挂钩的配置 URL 发送 HTTP POST 有效负载。 Web 挂钩可用于更新外部议题跟踪器、触发 CI 构建、更新备份镜像,甚至部署到生产服务器。 您只受想象力的限制。

Web 挂钩可以安装在组织、特定仓库或 GitHub 应用程序 上。 安装后,每当发生一个或多个订阅事件时,都会发送 web 挂钩。

您可以为每个安装目标(特定组织或特定仓库)上的每个事件创建最多 20 个 web 挂钩。

事件

配置 web 挂钩时,您可以使用 UI 或 API 选择哪些事件将向您发送有效负载。 仅订阅您计划处理的特定事件可限制对服务器的 HTTP 请求数。 您也可以订阅所有当前和未来的事件。 默认情况下,web 挂钩只订阅推送事件。 您可以随时更改订阅事件的列表。

每个事件对应于您的组织和/或仓库可能发生的一组特定操作。 例如,如果您订阅了 issues,则每当议题被打开、关闭、标记等操作时,您都会收到详细的有效负载。

要了解可用 web 挂钩事件及其有效负载的完整列表,请参阅“web 挂钩事件和有效负载”。

Ping 事件

当您创建新的 web 挂钩时,我们将向您发送一个简单的 ping 事件,让您知道您已正确设置 web 挂钩。 此事件不会存储,因此无法通过事件 API 端点检索它。

有关 ping 事件 web 挂钩有效负载的更多信息,请参阅 ping 事件。

此文档对您有帮助吗?

Privacy policy

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。