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.

Version history

Version Status
0.4 Deprecated
0.5 Deprecated (as of September 30th 2014)
1.0 Sunsetting (as of August 1st 2017)
2.0 Current (as of June 30th 2016)

Detailed version history

August 1, 2017: ZAF v2 is now our preferred framework version for building Zendesk apps so we are no longer accepting new public or private apps built using v1 of the framework. We will continue to accept ZAF v1 updates until March 1, 2018. ZAF v1 apps will continue to work as normal. No new feature development will take place and only critical bug fixes will be addressed in this version of the framework. For more information, see this knowledge base article.

June 30, 2016: We released v2.0 of the App Framework. App developers are encouraged to use v2.0 for any new apps and we strongly recommend migrating any existing apps to v2.0 using the new app scaffold. You don't have to migrate to v2.0 if you don't want to. v1.0 will continue to be supported. If the decision is made one day to deprecate it, we'll give you plenty of advance notice. See How much notice will Zendesk give for deprecations?

September 30, 2014: We transitioned from v0.5 to v1.0 as the supported Zendesk Apps framework version. v0.5 became deprecated. Apps that use v0.5 will continue to function until the next time the Zendesk Apps framework is updated. App developers are strongly encouraged to upgrade from v0.5 to v1.0 now.

  • Introduces a new way of building Zendesk apps using iframes.
  • Improves security by taking advantage of browsers' own cross-domain security features.
  • Makes it easy to use whatever technologies you're familiar with, including server-side technologies
  • Allows you to add third party libraries in your JavaScript code
  • Provides consistent APIs across all supported Zendesk products
  • Added support for Secure Requests
  • Removed 'proxy_v2' parameter for AJAX requests. Because all requests now route through the v2 proxy, you no longer need to specify proxy_v2: true in your manifest. See our Requests documentation for more on using our proxy.
  • Removed support for 'app.launch' callback. If you use app.launch in your app, you'll need to switch to the 'app.created' event instead.
  • Deprecated 'app.launch' callback, which was an early equivalent to 'app.activated' with 'firstLoad: true'
  • Deprecated 'app.activated' with 'firstLoad: true' (should use 'app.created' instead)
  • Deprecated events with state flags. e.g. 'app.activated %loading'
  • Deprecated switchTo event handlers. e.g. '%templateName'

Migrating v1.0 apps to v2.0

You can migrate existing Zendesk apps to ZAF v2 using the App Scaffold. See the migration guide for more information.

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 Zendesk Support. 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.

You define what version to target in your app's manifest file.