Before making updates to your integration, it’s important to consider the potential impact on user migration and existing Zaps. Ensuring your API and Zapier integration remains backwards compatible is crucial to avoid disruption to users. However, we acknowledge certain changes are sometimes necessary and unavoidable. In such cases, consider the best practice for implementation.
: A modification to the integration which renders existing Zaps compatible with the new version
Integration Change | Add | Update | Replace | Delete/Deprecate | Validated by platform? |
---|---|---|---|---|---|
AUTHENTICATION CHANGES | |||||
Authentication schemes | BREAKING CHANGE | - | BREAKING CHANGE | - | |
Authentication fields - required | BREAKING CHANGE | Depends | - | - | |
Authentication fields - optional | - | - | |||
Authentication field key(s) | - | BREAKING CHANGE | - | - | - |
Authentication - token request | - | - | - | - | |
Authentication - test function | - | - | - | ||
TRIGGER/ACTION CHANGES | |||||
Trigger/Action - meta info (e.g.: label, description) | - | - | - | ||
Trigger/Action - key | - | BREAKING CHANGE | BREAKING CHANGE | - | |
Trigger/Action - input field(s) - required | Depends | Depends | Depends | - | |
Trigger/Action - input field(s) - optional | - | ||||
Trigger/Action - input field(s) - key | - | BREAKING CHANGE | BREAKING CHANGE | - | - |
Trigger/Action - input field(s) - field type | - | Depends | Depends | - | - |
Trigger/Action - output data - key(s) | BREAKING CHANGE | BREAKING CHANGE | BREAKING CHANGE | - | |
Trigger/Action - output data - response structure | - | BREAKING CHANGE | BREAKING CHANGE | - | - |
Trigger/Action - perform function | - | Depends | Depends | - | - |
Trigger type - polling to hook type | - | BREAKING CHANGE | - | - | |
Trigger (polling) - perform function | - | Depends | Depends | - | - |
Trigger (hook) - perform list | - | Depends | Depends | - | - |
Trigger (hook) - performSubscribe | - | - | - | ||
Trigger (hook) - performUnsubscribe | - | - | - | ||
OTHER CHANGES | |||||
Middleware | Depends | Depends | Depends | Depends | - |
Partner’s API (overall) | - | Depends | Depends | Depends | - |
Product feature | - | - | - | - | |
Rebrand - (e.g. logo, app name) | - | - | - | - | |
Export UI to CLI | - | Depends | - | - | |
Export CLI to UI | - | Depends | - | - | - |
Edit Legacy Web Builder integration | - | Depends | Depends | - | - |