Migrating your Zapier integration#

If you have an app/integration that's usable by other people (either as invite-only or public), there are limitations on the types of changes that you can make in your integration, in order to avoid breaking the Zaps that your users have created with your integration.

Sometimes, there are occasions when you need to make a "major change" to an integration - either switching things to use a newer version of the endpoints/API (and thus, changing the structure of the data that's used), changing the authentication type (like switching to OAuth v2 tokens), or rewriting a Web-Builder integration using our CLI Platform.

In these cases, there are two approaches:

Hide and Replace#

If the existing endpoints/API are still usable, then this is the easiest approach - your team can build a completely new version of the integration, test it, accumulate some trial users, and then submit the app/integration for review.

When the review process has completed, we'll "hide" the older version of your integration (but it will continue to work "as is" for the existing users' Zaps), and then we'll deploy the newer version of the integration, so that it becomes the default integration that's used for creating new Zaps.

At that point, we'll determine whether we can reuse/migrate the Zap Templates for your integration, or remove all the Zap Templates if the keys/fields in the data have changed significantly.

Migrate existing Zaps#

If the existing endpoints are going to be deprecated/terminated, or an older authentication type is no longer usable, then it becomes necessary to migrate all of the users' Zaps to a newer version of the integration. This is a far more complicated situation, and we're continually working on improving the process.

The first step is that your team will need to create an updated version of the integration, while preserving as much compatibility with the existing integration (the Triggers, Actions, fields, and data). If you're not sure which parts of the existing integration are "most important", please contact us at partners@zapier.com, and we'll help get you started in the right direction.

After your team has finished developing and testing the new version of the integration, invite some users, and have them test out the new integration with their Zaps.

After you have accumulated enough test users, submit your new app for activation/review, and we'll take a look through things.

When the review process has completed, we'll "hide" the older version of your integration (but it will continue to work "as is" for the existing users' Zaps), and then we'll deploy the newer version of the integration, so that it becomes the default integration that's used for creating new Zaps.

At that point, we'll determine whether we can reuse/migrate the Zap Templates for your integration, or remove all the Zap Templates if the keys/fields in the data have changed significantly.

After a few weeks, we'll watch the new integration, and ensure that things are running smoothly. Once we've ascertained that the new integration is working well, we'll work on a migration script that will convert/migrate the users' Zaps from the older integration, and switch them to the newer integration.

Once the migration script has been tested, we'll begin the process of slowly migrating the Zaps over, from the older version of the integration, to the newer one. This is to help ensure that any edge-cases won't result in a large eruption of data errors if/when a large quantity of Zaps are converted.

This process may take a few weeks, or a few months, depending on the quantity of Zaps that are present, and the number of issues that are encountered during the Zap migration.

Ask for assistance#

As always, please contact us at partners@zapier.com if you have any questions!

↑ Was this documentation useful? Yes No
Get Help