当前位置：首页 > news >正文

Github webhook 是什么以及它的用途

news 来源：原创 2025/5/25 4:41:44

关于webhook

当 GitHub 上发生某些事件时，Webhooks 可以提供一种方式将通知传递到外部 Web 服务器。

Webhook 允许您订阅软件系统中发生的事件，并在这些事件发生时自动接收发送到您服务器的数据。

Webhook 用于实时接收数据，而不是轮询 API（间歇性调用 API）来查看数据是否可用。使用 Webhook，您只需在创建 Webhook 时表达一次对事件的关注。

Webhook 的用途非常广泛，包括：

在外部 CI 服务器上触发 CI（持续集成）流水线。例如，在代码推送到分支时在 Jenkins 或 CircleCI 中触发 CI。
将 GitHub 上发生的事件通知发送到协作平台。例如，在拉取请求获得审核时向 Discord 或 Slack 发送通知。
更新外部问题跟踪器（例如 Jira）。
部署到生产服务器。
在 GitHub 上实时记录事件，以便进行审计。

关于 GitHub 上的 Webhook

创建 Webhook 时，您需要指定一个 URL 并订阅 GitHub 上发生的事件。当 Webhook 订阅的事件发生时，GitHub 会向您指定的 URL 发送一个包含事件相关数据的 HTTP 请求。如果您的服务器已设置为监听该 URL 上的 Webhook 传递，则可以在收到 Webhook 时采取行动。

例如，您可以将 Webhook 订阅到以下事件：代码推送到仓库、拉取请求发起、GitHub Pages 网站构建或新成员添加到团队。您的服务器可以通过将代码部署到生产环境、触发 CI 流水线、发送通知或为新团队成员创建 GitHub 项目来响应这些事件。

您必须在特定的仓库、组织、GitHub Marketplace 帐户、GitHub Sponsors 帐户或 GitHub App 中创建 Webhook。 Webhook 只能访问安装它的仓库、组织、GitHub Marketplace 帐户、GitHub Sponsors 帐户或 GitHub App 中可用的资源。