Skip to main content
All CollectionsGetting started with Checkify
Prepare your Checkify app to Shopify API update
Prepare your Checkify app to Shopify API update

Shopify requests manual updates of the API version for сustom app users from time to time. Here's how to do it.

Updated over a week ago

Shopify updates its APIs to ensure the best possible experience and operations for merchants. Every three months, on average, they deprecate one version and add newer versions.

If you received an email from Shopify Support / Apps Team or see a notification in your store admin interface with the below-given text, you must adjust your Checkify custom app to ensure proper operation.


Subject: [Action required] A developer needs to update your custom apps and/or admin webhooks

The interface of admin.checkify will also start displaying a similar message:

All you need to do is simply change some settings in your setup done for Checkify. Please follow the instruction below:

  1. In your Shopify store admin open Settings > Apps and sales channels and choose Develop apps.

  2. Click on your custom checkout app, usually called "Checkify", or any other name you previously assigned.

3. In your custom app, select Configuration tab and click Edit button in the Admin API integration section. If you used a Private app to install Checkify then skip this item and go to Step 4.

4. Scroll down and find Webhook subscriptions block. Then select API Version higher than your current version, but not the "Release candidate" or "Deprecated".

If you see that you already have an optimal version selected (not too old, not too new), then do not change anything. In such case you can simply close this guide.

5. Click Save to confirm the action.

Press "Republish script" button. The action will initiate removal of old webhooks and automated creation of new and actual ones.

That's it: you did everything to ensure smooth and secure operation of the custom checkout app :) Once the update described above is complete, the banner with the warning in admin.checkify will disappear after the first launch (initiation) of the checkout in this new configuration.

In future you may still receive a warning from Shopify with subject [Action required] Update your Shopify apps before (date). The example of such email is given below:

As oftentimes, such emails may be sent by mistake. Nothing can stop working all of a sudden, and such a letter can be safely ignored.

P.S.: A Useful Hint

If you are experiencing problems at any of the steps described above, you can simply create a new custom app for Checkify's operation. This process will be similar to what you have already done successfully during the initial installation. It is described here.

Get the new set of credentials (API keys), copy and paste them to the appropriate fields in Admin > Settings > Store. Press "Reconnect store" button.

Delete the old custom app after that. It is not advisable to do it earlier in order to ensure the checkout's uptime.

The advantage of such an approach is that all the recent API updates by Shopify are applied automatically, webhooks renewed / re-written.

Did this answer your question?