配置 web 挂钩以通知您计划更改

创建 GitHub Marketplace 上架信息草稿 后,您可以配置 web 挂钩,以便在客户帐户计划发生更改时通知您。 配置 web 挂钩后,您可以在应用程序中处理 marketplace_purchase 事件类型

GitHub Marketplace 事件 web 挂钩只能在应用程序的 GitHub Marketplace 上架页面中进行设置。 您可以在应用程序的开发者设置页面中配置所有其他事件。 如果您尚未创建 GitHub Marketplace 上架信息,请阅读“创建 GitHub Marketplace 上架信息”了解方法。

创建 web 挂钩

要为 GitHub Marketplace 上架信息创建 web 挂钩,请在 GitHub Marketplace 上架页面的左边栏中单击 Webhook(web 挂钩)。 您将看到配置 web 挂钩所需的以下 web 挂钩配置选项:

有效负载 URL

有效负载 URL 是接收 web 挂钩 POST 请求的服务器的 URL。

内容类型

Web 挂钩可通过不同的内容类型传递:

  • application/json 内容类型将直接传递 JSON 有效负载,作为 POST 请求的正文。
  • application/x-www-form-urlencoded 内容类型将发送 JSON 有效负载,作为名为 payload 的表单参数。

选择最适合您需求的项。 GitHub 建议使用 application/json 内容类型。

密钥

设置 web 挂钩密钥使您可以确保将 POST 请求发送到来自 GitHub 的有效负载 URL。 在设置机密时,您将在 web 挂钩 POST 请求中收到 X-Hub-SignatureX-Hub-Signature-256 标头。 有关如何使用密钥和签名标头来保护 web 挂钩有效负载的更多信息,请参阅“保护 web 挂钩”。

已激活

默认情况下,web 挂钩交付为“Active(激活)”。 您可以通过取消选择“Active(激活)”来选择在开发过程中禁用 web 挂钩交付。 如果您禁用了 web 挂钩交付,则在提交应用程序以供审查之前需要选择“Active(激活)”。

查看 web 挂钩交付

配置 GitHub Marketplace web 挂钩后,您可以在应用程序的 GitHub Marketplace 上架信息Webhook(web 挂钩)页面中检查 POST 请求有效负载。 GitHub 不会重新发送失败的递送尝试。 确保您的应用程序可以接收 GitHub 发送的所有 web 挂钩有效负载。

检查最近的 GitHub Marketplace web 挂钩交付

此文档对您有帮助吗?隐私政策

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

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

做出贡献

或, 了解如何参与。