Managing webhook API versions

• You're familiar with how webhooks work.

• You're familiar with the webhooks best practices.

• You're authenticated with the GraphQL Admin API or REST Admin API.

Before you select a newer webhook API version, you need to test it against your code.

Add logic to your code so that it handles webhooks differently depending on their API versions. To check the API version, your app can use the X-Shopify-Api-Version request header in every webhook POST request.

From your store's notification settings, add some webhooks that use the newer version, and then send some test payloads. Your existing webhooks will continue to use the older API version. Check that your code correctly handles the test webhooks, and make any necessary adjustments.

1. From the Shopify admin, go to Settings > Notifications.

2. Click Create webhook, or click an existing webhook.

3. If this is a new webhook, then provide the event, format, and URL.

4. Select an API version from the Webhook API version drop-down list.

Select the newer API version for your app. Your updated webhook uses that version.

Select a webhook API version for a public or custom app by following the steps below:

1. From your Partner Dashboard, go to Apps.

2. Click the app that you want to update.

3. Click Configuration.

4. In the Event version section, from the Event version drop-down list, select an API version.

5. Click Save and release.

Make sure that your code handles the updated webhook payloads correctly. After you've verified that everything is working, update your code to remove the following:

• The logic that you added

• References to the old webhook API version

• View a report of your app’s webhook deliveries, track failed deliveries, and fix issues before they affect app users.