Understanding app versions
App versions are automatically created by Kit when certain changes to your app’s authentication or scope requirements occur. These versions help manage the authentication lifecycle and ensure creators maintain proper access to your app’s functionality. Kit automatically creates new app versions in the following scenarios:- Initial publication (v1)
- Authentication changes
Initial publication
The first version is created when your app is initially published to the Kit App Store. This establishes the baseline authentication and scope requirements for your app going forwards.Authentication changes
A new version is triggered when your app authentication requirements change after it is released. This ensures that creators are prompted to reauthenticate to gain access to any new features and functionality reliant on the new authentication method or scopes attached. The specific scenarios are:- Access types change - When you modify which Kit resources your app can access (API access, plugin access, or both) in your app’s Authentication settings tab
- Authorization strategy changes - When your plugin provider’s authentication method changes (for example, switching from “No authorization” to “OAuth) in your app’s Authentication settings tab
- Plugin scopes change - When the cumulative scope requirements across all your plugins are modified - more details on this can be found below.
Understanding scope changes
Scopes define the specific permissions your plugins require to access data from your service. Kit tracks scopes cumulatively across all plugins in your app, and version changes occur when:- A new plugin is created with a scope that none of your other plugins currently use
- A scope is added to an existing plugin that wasn’t previously required by any plugin
- A scope is removed from a plugin and is not used by any other plugins in your app
For example, if you have two plugins:
- Plugin A uses scopes:
read:products,read:inventory - Plugin B uses scopes:
read:products,read:customers
read:products, read:inventory, read:customersAdding write:orders to either plugin would trigger a new version, while adding read:products to a third plugin would not (since it’s already in the cumulative scope set).Adding scopes to a plugin
Scopes can be added to plugins using the Scopes field found when editing a plugin. A plugin can have any number of scopes attached, with previously used scopes available for selection automatically from the field. When creating a new scope, press return upon completion of typing for it to be added to the plugin. Click save to publish this change and prompt upgrade for creators with the app installed.
Using spaces in scope names can cause serialization issues when processed as arrays or comma-separated strings. We recommend using a combination of
action:resource, such as read:data (opposed to read data) and hyphens/underscores/snake-case/camel-case for multi-word scopes, such as read:customer_data.Impact on creators
When a new app version is created, the experience varies depending on the type of change:Re-authentication requirements
Creators will be prompted to re-authenticate your app when:- New access types are added - For example, if your app previously only used plugins but now also requires API access
- Authorization strategy changes to OAuth - When moving from no authentication to OAuth authentication
- New scopes are added - When your plugins require additional permissions not previously granted
- An icon on the Manage tab of the Kit App Store:
- All Install buttons will change to Update for all app cards across the Kit App Store, as well as an update icon in the top right corner:
- A separate section for apps requiring updates at the top of Manage tab of the Kit App Store:
When the update is tied to authentication strategy changes, an additional banner will be shown on the Authentication settings page for your app to help you know when an update will be required from creators.
Seamless updates
Some version changes don’t require creator action:- Scope removals - When permissions are removed, creators maintain their existing authentication
- Access type removals - When reducing the app’s access requirements
Impact on developers
As a developer, understanding app versioning helps you plan updates strategically and minimize disruption for your users. It allows you to gate plugins, to only be accessible when a certain version of your authentication strategy is installed, as well as build your apps iteratively - perhaps launching with API access only, before adding plugins at a later date. Below are a few best practices & common scenarios to ensure you are making the most out of app versioning, to make future app updates as seamless as possible.Best practices
- Testing plugins with new scopes before launch - When plugins are inactive but require new scopes, ensure you re-authenticate the app in the Build tab of the Kit App Store_ to test the new functionality before launch. This allows you to verify the authentication flow works as expected before affecting production users. Other creators won’t see these changes until you publish the plugin.
- Plan your scopes carefully - Define comprehensive scopes during initial development to minimize future version changes.
- Group related functionality - Consider future features when establishing initial scope requirements
- Avoid problematic scope formats - Never use spaces in scope names and use consistent naming conventions for ease of management (recommended:
action:resourceformat) - Test thoroughly before publishing - Use test mode to verify all scope changes work correctly. Ensure your OAuth server properly handles the new scope requests and validate that the re-authentication flow provides clear information to creators
- Managing version transitions - When planning changes that will trigger a new version:
- Communicate with your users - If possible, notify creators about upcoming changes through your app’s channels
- Bundle related changes - Group authentication changes together to minimize the number of versions
- Maintain backwards compatibility - Ensure your endpoints can handle both old and new authentication tokens during transition periods
- Update your documentation - Keep your app’s description and support resources current with the new requirements
- Track your app’s version history - While Kit manages version creation automatically, we recommend maintaining your own changelog documenting what changed in each version. This should include the date and reason for authentication changes & which features correspond to which version requirements
Common scenarios and solutions
Scenario: Adding a new feature If you’re adding a new plugin that requires additional scopes:- Consider whether the feature could work with existing scopes
- If new scopes are necessary, plan the rollout carefully
- Test thoroughly in development mode first
- Communicate the value of the new feature to encourage re-authentication
- Implement your OAuth server following Kit’s requirements
- Test the complete flow in development
- Prepare clear documentation for creators about why authentication is now required
- Consider providing a grace period where both methods work if technically feasible
- This won’t require creator re-authentication
- Update your code to work with reduced permissions
- Remove unnecessary scope requests from your OAuth flow
- This is generally seamless for users but improves security and trust
Technical considerations
OAuth server requirements
When implementing scope changes, ensure your OAuth server:- Properly validates and returns the requested scopes
- Handles incremental authorization if scopes are added over time
- Provides clear scope descriptions in the consent screen
- Maintains tokens that accurately reflect granted scopes
Error handling
Implement robust error handling for version-related scenarios:- Detect when a creator hasn’t granted new required scopes
- Provide clear messages about what permissions are needed and why
- Guide users to re-authenticate when necessary
- Gracefully degrade functionality if optional scopes aren’t granted