How to Manage a Legacy Web Builder Integration in Zapier Platform UI
Zapier’s new Platform UI is the best way to build Zapier integrations online—and the only way to build new Zapier integrations from your browser. It’s based on the same Zapier Platform as Zapier’s CLI, so integrations can use the same features and are equally easy to maintain.
If you have existing integrations built with Zapier’s legacy web builder, for now you can continue to maintain them using the same tools as before. Or, you can convert your integration to the new Zapier Platform UI to use our new input form editor and integration testing features to maintain your integration more efficiently.
How to Maintain Converted Integrations in Zapier Platform UI
Once your Zapier Legacy Web Builder integration is converted to Zapier Platform UI, it will look nearly the same as a new integration built in Zapier Platform UI’s visual builder. It will include every feature in new Zapier integrations, along with a few extra features to manage parts of your integration that were different in the Legacy Web Builder.
Here are some of the main things you’ll notice in Zapier Platform UI:
You can manage your app’s branding in Zapier Platform UI from the gear icon beside your app’s icon and name. There, you can add a new logo or Markdown-formatted description for your app, or change your app’s name and capitalization if needed. You can also add a category for your app.
Some of the details may have not been entered in your original Zapier integration. If you change anything in your app branding, you will also need to fill in any additional required fields before clicking Update to save the changes.
→ Learn more about Managing Your App Branding in Zapier Platform UI
Trigger and Action Details
The core details of your triggers and actions are easy to edit in an online form, much like a redesigned version of the editor you used in Zapier’s legacy Web Builder. You will manage the core details in the first tab, add input fields in the second tab, then manage the API call and test it in the final tab.
Searches are now combined in our Actions editor to simplify your Zapier integration, with Create and Search actions. You cannot change a create action to be a search action, or vise versa, but when you add a new action you can choose which type to add.
You can edit existing triggers and actions, or can add new ones to your integration as needed.
One of the best new features in Zapier Platform UI is the Input Designer. Here, you can design the input fields of your Zapier triggers and actions in an online form builder, and preview how they will look inside Zapier. Imported integrations work the same as new integrations in the Input Designer, so you can update existing input fields, reorder them, or add new fields to your triggers and actions any time.
→ Learn more about how to use the new Zapier Input Designer
Another Zapier Platform UI feature that will speed up your integration development is built-in testing. Inside the API Configuration settings of your authentication, triggers, and actions, you can add an app account and test each option, then view the data Zapier sent to your app and received in the API call response. If something’s wrong, you can then quickly make changes and re-test, all on the same page.
→ Learn more in our Testing docs
The new Platform UI also includes versioning to build and test new versions of your integration without breaking the integration for existing users. That’s a great way to rework older triggers and actions, or replace your authentication scheme if it changes. You can then slowly roll out the new version to test it with a subset of your users before making it the new default.
→ Learn more in our Versions docs
Legacy API Configuration Settings
In converted integrations, however, you will see static text fields for each API call URL. If you need to customize the API call or response bundle parsing, you will need to do so from the Legacy Scripting settings.
→ Check our Legacy Web Builder Documentation for details about the API configuration settings, which are carried over for imported integrations
Zapier Legacy Web Builder let you customize your integration’s authentication API calls, trigger and action setup, response data parsing, and more with our Scripting API. That tool is no longer available for new Zapier Platform UI integrations, replaced by Code Mode to customize each API call directly if needed. For imported integrations, though, you can continue to maintain your legacy code using the same Scripting API in Zapier Platform UI.
To edit code in an imported integration, open your integration’s Advanced settings, then click the Legacy Web Builder tab. There you can edit code as before, this time in a redesigned editor that does not take up your full screen. Be sure to click Save after editing your integration code, as Zapier does not auto-save changes.
→ Find detailed documentation on how to edit your integration’s code in Zapier’s Legacy Scripting docs
What is Not Included in Zapier Platform UI?
Zapier Platform UI includes most of the features you would expect from the Legacy Web Builder, along with new features to help better manage your integration. In converted integrations, you will see some additional features to manage existing authentication, triggers, and actions. If you add new triggers or actions to your integration, though, these features will not be available in the new items, including:
- Scripting: The Legacy Web Builder combined all code into one Scripting page that let you add custom code for authentication, triggers, actions, and response data parsing. You may continue to manage any existing code from your converted integration in the Advanced → Legacy Web Builder settings. If you add new triggers or actions to your integration, though, use Code Mode to customize your API call or response bundle parsing.
- Static Web Hooks: Zapier Platform UI supports only REST hooks and Polling for Triggers. If your converted integration includes static rest hooks in a trigger, you may continue to maintain them in the new Platform UI. If you add new triggers, though, you will not be able to add them with static web hooks.
- Custom Results Fields: The Legacy Web Builder included an option in triggers and actions to make an API call that would fetch custom result field names. Zapier Platform UI does not include this option for new triggers and actions, though it does let you continue to use this option in converted, existing triggers and actions. If you add new triggers or actions to your integration and need to fetch custom results fields, you will need to add that to the trigger or action’s API call in the code mode.
- OAuth v1: Zapier Platform UI does not support OAuth v1 for new integrations, and instead requires new integrations to use OAuth v2 authentication. You may continue to maintain existing OAuth v1 authentication in converted integrations, but if you make a new version of your integration or re-build it in Zapier Platform UI, you will need to use a newer authentication scheme.
- Advanced Editor: The Legacy Web Builder included an Advanced Editor option to edit your integration in JSON text instead of the web UI editor. That feature is no longer available in Zapier Platform UI, for new or converted integrations. If you would prefer to manage your integration in JSON text and code, the better option would be to convert your integration to Zapier Platform CLI to manage it from your local development environment. Once your app has been converted to the Platform UI, you will have the option of exporting your app to the CLI.
How to Maintain Integrations in Zapier Legacy Web Builder
If you’d prefer to use the Zapier tools you’re accustomed to, you may continue to use Zapier’s legacy web builder to maintain existing for the next few months. You can find your existing integrations on the lower part of the Zapier developer platform at zapier.com/app/developer under the Integrations Built with Legacy Web Builder header.
To clean up the legacy integrations list and remove incomplete integrations you no longer need, click the gear icon and select Delete beside any non-public integration.
Or, to edit integrations, click their entry in the list, then select the Development tab to see the Legacy Web Builder.
There you’ll see the same Web Builder you used to originally build your Zapier integration, with the same authentication, Triggers, Actions, Searches, and Scripting settings as before. Check our Legacy Web Builder Docs to learn more about how to update your integration, or our Legacy Web Builder Scripting guide to edit your integration’s custom code.
To update app branding, click the Edit Title, Image or Description button to change your app’s name, description, icon, or category.
By the end of 2019, Zapier will convert all existing integrations to the new Zapier Platform UI. For now, though, you can continue to use the legacy tools to maintain existing integrations and fix anything that needs changed before your team is ready to release a new integration version.
How to Convert a Legacy Web Builder Integration to Zapier Platform UI
Coming soon, Zapier will have a self-service tool to convert legacy Web Builder integrations to the new Zapier Platform UI, so you can upgrade your integrations when you want. For now, if you would like to try the new Zapier Platform UI, you can build a new integration at zapier.com/app/developer, or contact the Zapier team to have your existing integration upgraded to the new Platform UI.
How to Build a New Zapier Integration
Want to start over and build a new integration, or add another integration for a new app? That’s easier than ever with Zapier’s Platform UI and CLI.