Step By Step Guide
Before you begin: it’s important that you don’t make any edits to your integration during the conversion process. If you encounter errors during the process, email us at firstname.lastname@example.org and we’ll resolve the issue.
Also, before you get started it’s a really good idea to test each trigger and action of your existing public Web Builder integration. Your integration may have existing issues, and it’s going to be useful to isolate those from any problems caused by the conversion itself.
STEP 1: CONVERT YOUR INTEGRATION
To get started, create a copy of your integration on the new platform. This is a non-destructive operation. It doesn’t change your existing integration or impact your existing users’ Zaps.
Navigate to your integration built on the legacy web builder. At the top of the integration page, you’ll see a banner message with details about the platform update. Click “Get Started” to begin the conversion process.
The tool will identify older copies of your integration to include in the conversion. Copies of your integration will be available as versions of your new integration on the new platform. If any of the copies identified by the tool are separate products, clear the checkbox for those copies.
Select Get Started
Confirm Copies of Your Integration
Done. Ready to Navigate to the New Tool.
STEP 2: TEST YOUR NEW INTEGRATION
Now you’ve created a copy of your integration on the new developer platform. The next step is to test your triggers and actions in the Zap editor to make sure everything is working as expected. We’ve provided a checklist to track each trigger and action to test.
Within the Zap editor, check the task history to confirm there aren’t any errors. If you encounter any issues, email us at email@example.com. Our team will investigate and correct whatever went wrong with your integration conversion. It’s very important you don’t make changes to the new copy of your integration.
After testing is complete, you’re ready to update your existing users’ Zaps to use the new integration.
Ensure that you’re using the new integration to test your triggers and actions. This version is not yet available within Zapier’s public app directory.
The new platform’s web-based development tool has a feature to create test Zaps. Your new integration’s triggers and actions will be listed on the left sidebar navigation. Select one and you’ll see an option to create a Zap with this trigger or action.
Click “Create a Zap” to create a new Zap with this trigger or action in the Zap editor. In this example, we’ll test a trigger from the Bitbucket integration. Add a simple action to verify that data is being passed properly, such as Slack’s send message action. Map your fields to make sure some data is present in your results.
When you’re done configuring your Zap, click “Turn on Zap” to test it.
Next, force your trigger to execute. In the Bitbucket example, I created a new issue.
You should see your action run. To check the details in your task history, click the clock icon in the right sidebar menu to verify that your trigger/action/search is returning the correct data.
If your integration has hidden triggers or actions
You should be able to create test Zaps for hidden triggers & actions using the “Create a Zap” link provided in the conversion/migration utility on the right hand section of the new UI tool, next to the check boxes for each trigger and action. This is the recommended approach, but if you need to create them directly in the Zap editor, follow the directions below.
It’s important that you don’t make edits to the new copy of your project during the conversion process. To test hidden triggers and actions in new Zaps, you’ll need to change the visibility of the trigger/action/search. To do this, create a copy of your integration and make the visibility changes to that version only to access those triggers/actions/searches to test them in the Zap editor. When your test is complete, you can delete this copy of your integration.
To create a temporary test copy of your integration:
In the left sidebar menu, click “Versions.” Next to your new integration, click the gear icon and select “Clone.” In the dialog box that appears, click the “Clone to version” dropdown menu and select “patch.” It doesn’t matter which option you select here, since this version will be deleted after your testing is complete. Then click “Clone.” Click “Close” to exit the dialog box.
Change the visibility of a trigger/action/search so you can make a new test Zap:
To select the test version of your integration, click the “Version” dropdown menu in the upper left, or from the versions section. Then select the new version you just created for this test.
In the left sidebar menu, select the hidden trigger or action in your integration. At the bottom of the Settings page click the “Visibility Options” dropdown menu and select “Important (Displayed above the fold in the Zap Editor).” Then click “Save.”
When you’re done testing
If everything works as expected, you’re ready to check this trigger/action/search off the list and repeat this process for the next one. If you see any unexpected results, contact us at firstname.lastname@example.org.
Check off Triggers & Actions after you’ve verified them
After you’ve tested all your triggers and actions, you’re ready to update your users’ Zaps with the new integration.
STEP 3: Update your Users’ Zaps
After you’ve completed testing, update your users’ Zaps to use the integration you’ve created on the new platform. We’ll provide the status of the operation, letting you know when it’s complete. If you have a lot of users this may take several hours to complete.
After this process is complete, all your users’ Zaps will be using the new version of your integration, and all references to your integration will have been updated across Zapier.
Select ‘Update Zaps’ to start migrating users to the new platform
View progress of your migration