Framework versions

The Zendesk Apps framework uses versioning to ensure that changes to the framework don't break existing applications without notice. When we add new features or deprecate old features, we do so in the 'Future' version of the framework so that apps developed in the 'Current' version are unaffected. See Understanding framework versions below for more information.

You can import the latest version of the ZAF SDK from https://static.zdassets.com/zendesk_app_framework_sdk/2.0/zaf_sdk.min.js. Using the URL in your app ensures the SDK is automatically updated with the latest 2.0 patch releases, including any bug fixes.

From time to time, Zendesk may make a new minor 2.1 or 2.2 release available of the ZAF SDK that contains new features and may include breaking changes. To receive the latest minor release while in development, use https://static.zdassets.com/zendesk_app_framework_sdk/2/zaf_sdk.min.js instead of https://static.zdassets.com/zendesk_app_framework_sdk/2.0/zaf_sdk.min.js.

For versions before v2, see Framework Versions in the ZAF v1 docs.

Version history

Version Status
2.0 Current (as of June 30th 2016)

Version 1.x is deprecated.

Understanding framework versions

An app can target one of three possible versions of the framework: current, future, or deprecated.

Any version below deprecated is considered obsolete. Apps targeting an obsolete version won't be listed or run in the Zendesk product. Apps targeting a deprecated version will still run but can't be created or updated. Refer to the version labels throughout the documentation to find out if a feature has been deprecated or if it's only part of a future release. Every feature that doesn't include a label should be considered current.

We recommend app developers always target the current version of the framework. If you'd like to try new features, you're welcome to target the future version. Just be aware that features marked as deprecated will be removed from future versions.

Specify the version to target with the frameworkVersion property in your app's manifest file.