Skip to main content

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

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

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

创建 Webhook

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

有效负载 URL

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

内容类型

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

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

选择最符合你需要的预设。 GitHub 建议使用 application/json 内容类型。

机密

通过设置 Webhook 机密,可以确保发送到有效负载 URL 的 POST 请求来自 GitHub Enterprise Cloud。 设置机密时,你将在 Webhook POST 请求中收到 X-Hub-SignatureX-Hub-Signature-256 标头。 有关如何使用带有签名标头的机密来保护 Webhook 有效负载的详细信息,请参阅“保护 Webhook”。

活动

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

查看 web 挂钩交付

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

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