Skip to main content

GitHub Marketplace APIのためのwebhookイベント

GitHub Marketplaceアプリケーションは、ユーザのプランに対する変更に関する情報を、Marketplaceの購入イベントwebhookから受け取ります。 Marketplaceの購入イベントは、ユーザが支払いプランの購入、キャンセル、変更をした場合にトリガーされます。

注: この記事は、GitHub Marketplace でのアプリの公開にのみ適用されます。 GitHub Marketplace での GitHub Actions の公開について詳しくは、「GitHub Marketplaceでのアクションの公開」をご覧ください。

GitHub MarketplaceWebhook ペイロードの詳細については、「Webhook のイベントとペイロード」を参照してください。

Webhook の POST 要求には特別なヘッダーがあります。 詳細については、「Webhook のイベントとペイロード」を参照してください。 GitHubは、失敗した配信の試行を再送信しません。 GitHubが送信したすべてのwebhookのペイロードを、アプリケーションが確実に受信できるようにしてください。 GitHub Marketplace Webhook の作成方法と無効にする方法についての詳細は、「webhookの作成」と「Webhook を無効にする」を参照してください。

キャンセル及びダウングレードは、次の支払いサイクルの初日に有効になります。 ダウングレードとキャンセルのイベントは、次の支払いサイクルの開始時に新しいプランが有効になったときに送信されます。 新規の購入とアップグレードのイベントは、すぐに開始されます。 Webhook ペイロードで effective_date を使用して、変更が開始されるタイミングを決定します。

注: スパムのような GitHub Marketplace の購入やその他の悪意のある動作に気付いた場合は、[不正使用を報告] フォームにそのユーザーに関する詳細情報を記入してください。