This is a Forge-only module. If your app has not yet migrated to Forge, you cannot declare it — your app will always show the generic Connect End of Support messaging to admins, with no app-specific migration guide link or commitment status.
To use this module, you will need to adopt a Forge manifest. You do not need to have fully migrated your app — declaring this module in a Forge manifest is enough to control the messaging your users see.
You can now communicate your migration plan and commitment status to your users using the connectToForgeMigration manifest module. This lets you share a valid URL to your migration timeline and indicate whether you intend to migrate before Connect End of Support (EOS).
Availability: This feature is currently live in Production but only applies to private Connect apps. For public Marketplace apps, you can test app-specific messaging for tenants enrolled in the Developer Canary Program. To have your migrationGuideUrl navigated to via the notification banner, you will need to make a change to each major version of your app. This allows you to provide version-specific messaging to different cohorts of your app.
The connectToForgeMigration module allows Connect app developers to communicate their migration plan and status to Atlassian. It accepts two pieces of information:
During the canary phase, this module is only respected for private Connect apps installed on eligible canary sites. Public Marketplace apps are not affected by this feature, and end users of those apps won't see any migration messaging from this module.
This module is available for apps that extend Jira and Confluence.
The following example shows a fully configured module with a valid migrationGuideUrl and a confirmed intent to migrate before Connect EOS.
1 2modules: connectToForgeMigration: - key: my-migration-declaration migrationGuideUrl: https://example.com/my-app/forge-migration-plan willMigrateToForgeBeforeEOS: YES
With this configuration, admins see a blue information section message under the app name in Connected apps, similar to:
This app is running on a platform that will be unsupported after December 2026. Learn more about the vendor's plans to migrate app users (including you).
For more details about this change, read Connect End of Support: What it means for private/custom apps.
The Learn more link points to the migrationGuideUrl you provided.
The following example shows how to declare a migration status when you are not yet sure whether you will migrate before Connect EOS.
1 2modules: connectToForgeMigration: - key: my-migration-declaration migrationGuideUrl: https://example.com/my-app/forge-migration-plan willMigrateToForgeBeforeEOS: UNDECIDED
With this configuration, admins see a yellow warning section message under the app name in Connected apps, similar to:
This app is running on a platform that will be unsupported after December 2026. Learn more about the vendor's plans to migrate app users (including you).
For more details about this change, read Connect End of Support: What it means for private/custom apps.
The copy is identical to the confirmed-intent variant — only the appearance changes from blue/information to yellow/warning to signal the unresolved migration status. The Learn more link points to the migrationGuideUrl you provided.
| Property | Type | Required | Description |
|---|---|---|---|
key | string | Yes | A unique key that identifies the module. Must be unique within your app's manifest. |
migrationGuideUrl | string | Yes |
A URL pointing to a page where you describe your migration plan, timeline, and milestones. Must be a valid URL. Use this page to communicate your migration strategy to Atlassian and your users. You can host this page anywhere publicly accessible (for example, your app's documentation site or a Confluence page). |
willMigrateToForgeBeforeEOS | 'YES' | 'NO' | 'UNDECIDED' | Yes |
Declares your intent to migrate the app to Forge before Connect End of Support (EOS). Accepted values are:
|
migrationGuideUrlThe value of migrationGuideUrl must be a valid URL. The following formats are accepted:
https://example.com/my-migration-planhttps://my-company.atlassian.net/wiki/spaces/APP/pages/123456Invalid or non-URL values will cause a manifest validation error.
willMigrateToForgeBeforeEOSOnly the exact string values YES, NO, and UNDECIDED are accepted. Any other value will cause a manifest validation error.
When this module is active, a warning banner will appear under the app name title in the connected apps menu for org and site admins. The banner displays the following message:
This app is running on a platform that will be unsupported after December 2026. Learn more about the vendor's plans to migrate app users (including you).
For more details about this change, read Connect End of Support: What it means for private/custom apps.
Rate this page: