On September 25th, 2024, we released v2 of the Apps SDK. To learn what’s new and how to upgrade, see Migration FAQ and Migration guide.

Migration FAQ

Some important things to know about upgrading to Apps SDK v2.

On September 25th, 2024, we launched v2 of the Apps SDK. This version of the SDK includes major, breaking changes that will require all developers to upgrade their apps.

This page answers the most important questions about the new version.

What's changing?

A lot of things!

Some APIs are being deprecated. Some APIs are being introduced.

For the complete list of changes, see the Migration guide.

Do I have to upgrade my app?

Yes. All developers must upgrade their app(s) to v2.

How long do I have to upgrade?

You have 12 months, starting from September 25th, 2024. To avoid downtime, the upgraded app should be released by September 25th, 2025.

How do I upgrade my app?

See the Migration guide.

How long does it take to upgrade?

This depends on the complexity of the app and the APIs that it uses. That said, we've been careful to minimize the number of required changes. For some developers, it'll only take a matter of minutes to upgrade.

What happens if I don't upgrade?

Your app(s) will be disabled and removed from the Apps Marketplace(opens in a new tab or window) after September 25th, 2025.

Can I still create v1 apps?

No. All new apps created via the Developer Portal must use v2.

Can I launch my existing v1 app?

Yes, but only until the end of 2024. If the app is not released before the end of 2024, it must be upgraded to v2 before it can be launched.

Can I use a combination of v1 and v2 APIs?

No. The APIs are not interoperable.

Where is the documentation for v2?

All of the existing documentation has been updated to reflect the changes in v2. You can, however, still access the API reference documentation for v1.