Effects of Different Changes (Versioning Matrix)
The matrix below illustrates the impact of different changes on your users. For public integrations, this will affect promotion and whether migration is possible. Refer to our best practices to facilitate the upgrade process for yourself and your users. Columns:- Add: Adding a net new component
- Update: Making a change to an existing component
- Replace: Deleting/deprecating an existing component and adding a new one in its place
- Delete/Deprecate: Removing an existing component completely
- Breaking Change: A modification to the integration which renders existing Zaps incompatible with the new version
- Depends: A modification which may render existing Zaps incompatible with the new version, depending on the implementation
-
: A modification to the integration which renders existing Zaps compatible with the new version
- -: Not applicable
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 | - | - |
Need help? Tell us about your problem and we’ll connect you with the right resource or contact support.