Skip to main content

We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the new Branches, Collaborators, Commits, Deploy Keys, Deployments, GitHub Pages, Releases, Metrics, Webhooks REST API pages.

Web 挂钩

Web 挂钩 API 允许您为存储库创建和管理 web 挂钩。

仓库 web 挂钩允许您在仓库内发生特定事件时接收 HTTP POST 有效负载。 Web 挂钩 REST API 可让您管理存储库、组织和应用程序 web 挂钩。 您可以使用此 API 列出 web 挂钩的 web 挂钩交付,或者获取并重新交付 web 挂钩的单个交付,这些交付可以集成到外部应用程序或服务中。 您还可以使用 REST API 更改 web 挂钩的配置。 例如,您可以修改有效负载 URL、内容类型、SSL 验证和机密。 更多信息请参阅:

如果您要设置一个 web 挂钩来接收来自组织所有仓库的事件,请参阅关于组织 web 挂钩的 API 文档。

除了 REST API 之外, GitHub 还可以作为仓库的 PubSubHubbub 枢纽。

接收 web 挂钩

为了让 GitHub Enterprise Cloud 发送 web 挂钩有效负载,您的服务器需要能够从 Internet 访问。 我们还强烈建议使用 SSL,以便我们可以通过 HTTPS 发送加密的有效负载。

Web 挂钩标头

GitHub Enterprise Cloud 发送时将附带几个 HTTP 标头,以区分事件类型和有效负载标识符。 更多信息请参阅 web 挂钩标头

PubSubHubbub

GitHub 还可以作为所有仓库的 PubSubHubbabub 枢纽。 PSHB 是一个简单的发布/订阅协议,允许服务器注册在主题更新时接收更新。 这些更新随 HTTP POST 请求一起发送到回调 URL。 GitHub 仓库推送的主题 URL 采用以下格式:

https://github.com/{owner}/{repo}/events/{event}

事件可以是任何可用的 web 挂钩事件。 更多信息请参阅“web 挂钩事件和有效负载”。

响应格式

默认格式为现有接收后挂钩应具有的格式:作为 POST 中的 payload 参数发送的 JSON 正文。 您还可以指定接收带有 Accept 标头或 .json 扩展名的原始 JSON 正文。

Accept: application/json
https://github.com/{owner}/{repo}/events/push.json

回调 URL

回调 URL 可以使用 http:// 协议。

# Send updates to postbin.org
http://postbin.org/123

订阅

GitHub PubSubHubbub 端点为:https://api.github.com/hub。 使用 cURL 的成功请求如下所示:

curl -u "user" -i \
  https://api.github.com/hub \
  -F "hub.mode=subscribe" \
  -F "hub.topic=https://github.com/{owner}/{repo}/events/push" \
  -F "hub.callback=http://postbin.org/123"

PubSubHubbub 请求可以多次发送。 如果挂钩已经存在,它将根据请求进行修改。

参数

名称类型描述
hub.mode字符串必填。 值为 subscribeunsubscribe
hub.topic字符串必填。 要订阅的 GitHub 仓库的 URI。 路径格式必须为 /{owner}/{repo}/events/{event}
hub.callback字符串要接收主题更新的 URI。
hub.secret字符串用于生成传出正文内容的哈希签名的共享密钥。 您可以通过比较原始请求正文与 X-Hub-SignatureX-Hub-Signature-256 标头 的内容来验证来自 GitHub 的推送。 您可以查看 PubSubHubbub 文档了解详情。