跳至主要内容

配置 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 所需的以下 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.