跳至主要内容

配置 Webhook 以通知您计划更改

创建 GitHub Marketplace 草稿列表后,您可以配置一个 Webhook,在客户帐户计划发生更改时通知您。配置 Webhook 后,您可以处理您的应用程序中的marketplace_purchase 事件类型

注意:本文档仅适用于在 GitHub Marketplace 中发布应用程序。有关在 GitHub Marketplace 中发布 GitHub Actions 的更多信息,请参阅“在 GitHub Marketplace 中发布 Actions”。

GitHub Marketplace 事件 Webhook 只能从您的应用程序的 GitHub Marketplace 列表页面设置。您可以从您的应用程序的开发者设置页面配置所有其他事件。如果您尚未创建 GitHub Marketplace 列表,请阅读“为您的应用程序起草列表”,了解如何操作。

创建 Webhook

要为您的 GitHub Marketplace 列表创建 Webhook,请点击您GitHub Marketplace 列表页面左侧边栏中的**Webhook**。您将看到以下配置 Webhook 所需的选项。

有效负载 URL

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

内容类型

Webhook 可以使用不同的内容类型进行传递。

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

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

密钥

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

活动

默认情况下,Webhook 传递处于“活动”状态。您可以在开发期间选择通过取消选中“活动”来禁用 Webhook 有效负载的传递。如果您已禁用 Webhook 传递,则需要在提交应用程序以供审核之前选择“活动”。

查看 Webhook 传递

配置好 GitHub Marketplace Webhook 后,您就可以在应用程序的GitHub Marketplace 列表的**Webhook**页面中检查 POST 请求有效负载。GitHub 不会重新发送失败的传递尝试。确保您的应用程序能够接收 GitHub 发送的所有 Webhook 有效负载。

Screenshot of the recent webhook deliveries for the GitHub Marketplace listing.