| title | intro | redirect_from | versions | topics | shortTitle | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Configuring a webhook to notify you of plan changes |
After [creating a draft {% data variables.product.prodname_marketplace %} listing](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/), you can configure a webhook that notifies you when changes to customer account plans occur. After you configure the webhook, you can [handle the `marketplace_purchase` event types](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) in your app. |
|
|
|
Webhooks for plan changes |
{% data reusables.marketplace.marketplace-apps-not-actions %}
The {% data variables.product.prodname_marketplace %} event webhook can only be set up from your application's {% data variables.product.prodname_marketplace %} listing page. You can configure all other events from your application's developer settings page. If you haven't created a {% data variables.product.prodname_marketplace %} listing, read "AUTOTITLE" to learn how.
To create a webhook for your {% data variables.product.prodname_marketplace %} listing, click Webhook in the left sidebar of your {% data variables.product.prodname_marketplace %} listing page. You'll see the following webhook configuration options needed to configure your webhook:
{% data reusables.webhooks.payload_url %}
{% data reusables.webhooks.content_type %} GitHub recommends using the application/json content type.
{% data reusables.webhooks.secret %}
By default, webhook deliveries are "Active." You can choose to disable the delivery of webhook payloads during development by deselecting "Active." If you've disabled webhook deliveries, you will need to select "Active" before you submit your app for review.
Once you've configured your {% data variables.product.prodname_marketplace %} webhook, you'll be able to inspect POST request payloads from the Webhook page of your application's {% data variables.product.prodname_marketplace %} listing. GitHub doesn't resend failed delivery attempts. Ensure your app can receive all webhook payloads sent by GitHub.
