How to Maintain a Zapier Integration
Things change. Over time, you’ll add new tools to your app, improve existing features, fix bugs, and continuously improve it. New features may grow it into a larger category, or make it more focused on a smaller niche. Its description will likely change, as may its logo or even name. The API may even change as your app matures.
Your Zapier integration needs to change, too. The best integrations are improved over time to improve their most popular use cases, remove bugs or confusing descriptions that tripped up users, and keep branding consistent with their core app.
Keep these guidelines in mind as you maintain your Zapier integration:
How to Update App Branding in Zapier
You can update your app’s name, description, logo, and category anytime in the Zapier Platform site. Select your app integration, click the gear icon near its name, then update the app details as needed.
If you built your app using Zapier Platform CLI, you can also update the app name and description from the integration bundle’s
package.json file. You will still need to use the Zapier Platform site to update your app icon and category.
If your app is public, you’ll then need to send us a request to publish those changes.
Please make sure to follow Zapier’s branding guidelines whenever updating app branding.
How to Monitor Feature Requests and Bugs
As people use your Zapier integration, they may encounter bugs and problems with your integration, or think of new ways they’d like to use your app with Zapier, and send them to the Zapier support team. We log those in Zapier’s issue tracker, which you can see from the Bug & Feature Requests page in the Manage section of your integration’s sidebar.
Problems and issues with your integration, authentication, API calls, and more will be logged as
bug, while new things users require from your integration will be logged as
Whenever a new issue is added or updated, Zapier will log it in the Issues tab of your app’s Zapier Developer Platform settings page. Zapier will also send an email notification about the issue to your integration’s original developer.
You can see additional details about the issue, along with the trigger or action it affects and how many users have encountered the issue, in Zapier’s issue tracker. You can reply to the Zapier team about the issue there, or can simply reply to the notification email to add a response to the issue.
If you want others on your team to receive the issue notifications, or would like to route them to your support or developer team inbox, you can add additional notification email addresses from the bottom of the Issues tab. You may also remove the original developer from the issue after you’ve added an additional contact.
How to Make a New Version of Your Integration
Sometimes you may want to add something new to your integration. You may need to fix bugs in your integration, or add additional details to resolve user issues. You might want to add additional triggers, actions, or searches to your integration as uses request them. Or, over time, you may need to change your app’s authentication and API calls.
The Zapier platform makes it easy to build new versions of your integration when needed. You can create new versions for minor or major changes as needed.
Versions that have been made public, or those with more than 5 users, cannot be edited. In that case, you will need to create a new version to make any changes. This is so that existing users are not surprised by changes to their running workflows.
It’s still best to include non-breaking changes in a new integration version, so you can test the changes and roll them out to a smaller subset of your Zapier integration users. Once you’ve made sure the new version works well, you can roll it out to all of your users.
Breaking or major changes, such as switching to a new API endpoint, changing authentication type, or rewriting an integration, require a new major version of your integration, and users will need to re-create their Zaps with the new version of your integration.
You can test the new version privately, as when you first built your Zapier integration. Once it’s ready for wider use, you can promote the new integration version, and deprecate the older version if you want to. Zapier will then mark the integration as having newer versions available, and will show the new version instead of the earlier version when users make new Zaps.
We’re here to help!
As always, please contact us if you have any questions!