Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SUPPORTESC-108] Update feature-requests-bugs.md #161

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 13 additions & 15 deletions docs/_partners/feature-requests-bugs.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,35 +58,33 @@ Breaking changes require a new major version of your integration. That requires

_→ Find how to manage versions in [Zapier Platform UI](https://platform.zapier.com/docs/versions) and [CLI](https://zapier.github.io/zapier-platform-cli/#deploying-an-app-version)_

## How to Replace Your Zapier Integration
## How to Upgrade Your Zapier Integration

If you have an integration that's usable by other people (either as invite only or public), you will additionally need to follow our our 4-step approach to replacing your integration with a new one:
If you have an 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 on it.
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](https://zapier.github.io/zapier-platform/cli) .

In these cases, here’s our 4-step approach to upgrading your integration to the V3 UI verson:

### 1. Reach out to our Partnerships Team

Contact us at [[email protected]](mailto:[email protected]) with your intentions **before you start building** the updated integration and we'll help get you started in the right direction. Giving us a heads up will expedite the review process of and help set proper expectations for the replacement integration. We also recommend reading our [blog post](https://zapier.com/engineering/api-auth-migration/) on auth migration best practices and pitfalls, with real-world examples.

### 2. Build the Replacement Integration for a "Hide and Replace"

Your team will build a completely new version of the integration with the same triggers, actions, and searches as your original integration if at all possible. You will need to have 10 test users for the new version of your integration with at least 1 live Zap for each trigger, action, and search, just as with a new integration. Then, you will need to re-submit your integration for approval as with a new integration.

> **Note:** You will need to accumulate enough test users on your new integration before you can request for review. Please expect some time between when you submit for review and when the new integration is made “Public”, as the speed of the review depends on how closely your integration matches our style guide and the responsiveness of your team to our feedback.
### 2. Get Your App Converted

When the review process is complete, we'll "hide" the older version of your integration, and deploy the newer version, so it becomes the default version that's used for creating new Zaps.
Once all checks are passed, our team will run your app through the conversion process from a Web Builder integration to the upgraded v3 Visual Builder UI counterpart. The latest version of the developer platform offers all new platform tools, overall greater control over your app lifecycle with versioning and deprecation facilities and much more.

If the existing API endpoints in the old integration are **still working and available**, they are set as “Pending.” Existing users’ Zaps will continue to work "as is", but no users will be able to create new Zaps with the old version. Any Zaps using the old integration will show a “Legacy” label to prompt users to update their Zaps to use the new one.

If the existing API endpoints will be **deprecated/terminated**, or an **older authentication type is no longer usable**, after we deploy the new version of the integration, existing users’ Zaps will only continue to work as long as the original endpoints are available.
### 3. Testing Phase

### 3. Migrate Users and Zaps to the new integration
From here, we’ll ask you to run some thorough tests on the new integration **without** altering any code. These tests will involve making Zaps for each Trigger and Action and confirming they work correctly. The goal here is to weed out any possible issues that may have risen from the conversion process and get them addressed sooner rather than later. Errors we would be looking out for here would be issues with converted app functionality (Auths no longer working, Triggers returning different data, etc).

At this time, the users and Zaps on the old integration should be migrated over to the new version. This is **not** done automatically during the "Hide and Replace" step of the replacement.
If after testing there are still errors or other unintended behaviour found, we’ll fix these issues and ask you to retest again.
Once no errors are found in testing, and the v3 app works as expected, you let us know and we begin migrating.

The Zapier team will **not** assist you with migrating users and Zaps to the new version. You will need to send out communication to notify your users to update their Zaps on their own.

### 4. Migrate existing Zap Templates
### 4. Migration

We'll also determine whether we can reuse/migrate the [Zap Templates](https://zapier.com/developer/documentation/v2/zap-templates/) for your integration, or need to remove all the Zap Templates if the keys/fields in the data have changed significantly. Templates may not be migrated right away when the ‘Hide and Replace’ occurs, but will be placed in a queue to be migrated in priority order.
Once no errors are found in testing, and the v3 app works as expected, you let us know and we will begin migrating all your users and their Zaps to the new app version. This is purely a backend process with zero impact to your users, they won’t have to worry about this.

### We're here to help!

Expand Down