跳至主要内容

配置 webhook,以在方案变更时通知您

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

本文内容

注意

本文仅适用于在 GitHub Marketplace 发布应用。有关在 GitHub Marketplace 发布 GitHub Actions 的更多信息,请参阅 在 GitHub Marketplace 发布操作

GitHub Marketplace 事件 webhook 只能在您的应用的 GitHub Marketplace 列表页面进行设置。您可以在应用的开发者设置页面配置所有其他事件。如果您尚未创建 GitHub Marketplace 列表,请阅读为您的应用草拟列表以了解如何操作。

创建 webhook

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

有效负载 URL

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

内容类型

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.

© . This site is unofficial and not affiliated with GitHub, Inc.