The connectToForgeMigration module lets you communicate your migration plan and commitment status directly to your customers. When declared, it replaces the generic Connect End of Support (EOS) warning with your own app-specific messaging on the Connected Apps admin page.

This module accepts two pieces of information:

migrationGuideUrl — A link to your migration plan page, where you share your migration timeline, milestones, and progress.
willMigrateToForgeBeforeEOS — Your commitment status indicating whether you intend to migrate your app to Forge before Connect EOS in December 2026.

This module is available for apps that extend Jira and Confluence.

This is a Forge-only module. If your app has not yet adopted a Forge manifest, you cannot declare this module. Your app will show the generic Connect End of Support messaging to admins, with no app-specific migration guide link or commitment status.

To use this module, 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.

Why declare this module

Without a connectToForgeMigration declaration, admins see a generic warning that directs them to either the Marketplace listing (for public apps) or Atlassian's general guidance (for private apps). By declaring this module, you:

Control the messaging your customers see — linking to your own migration plan instead of a generic notice.
Signal your commitment — a YES status shows a blue information banner (reassuring), while UNDECIDED or NO shows a yellow warning banner.
Determine your rollout cohort — your declaration affects when messaging appears for your app. See customer messaging rollout plan for details.

How it affects what admins see

The value of willMigrateToForgeBeforeEOS changes the banner appearance on the Connected Apps page:

Value	Banner type	What admins see
`YES`	Blue (information)	A reassuring message linking to your migration plan.
`UNDECIDED`	Yellow (warning)	A cautionary message linking to your migration plan.
`NO`	Yellow (warning)	A cautionary message linking to your migration plan.

In all cases, the Learn more link points to the migrationGuideUrl you provide. The banner copy is the same — only the color and severity change based on your commitment status.

For the full set of messaging scenarios (including apps without this module), see What admins see for your Connect app.

Examples

Confirmed migration intent

The following example shows a fully configured module with a confirmed intent to migrate before Connect EOS.

1
2
modules:
  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:

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.

Undecided migration status

The following example shows a declaration for an app that has not yet decided whether it will migrate before Connect EOS.

1
2
modules:
  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:

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.

No migration intent

If you set willMigrateToForgeBeforeEOS to NO, admins also see a yellow warning section message. The banner copy and link behavior are the same as the undecided case.

1
2
modules:
  connectToForgeMigration:
    - key: my-migration-declaration
      migrationGuideUrl: https://example.com/my-app/forge-migration-plan
      willMigrateToForgeBeforeEOS: NO

Properties

Property Type Required Description

key string Yes A unique key that identifies the module. Must be unique within your app's manifest.

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, publicly accessible URL. You can host this page anywhere — for example, your app's documentation site or a Confluence page. To provide version-specific messaging to different cohorts, update this URL in each major version of your app.
`willMigrateToForgeBeforeEOS`	`'YES'` \| `'NO'` \| `'UNDECIDED'`	Yes	Your intent to migrate the app to Forge before Connect EOS. Accepted values: `YES` — You are committed to migrating before Connect EOS. Admins see a blue (information) banner. `NO` — You do not intend to migrate before Connect EOS. Admins see a yellow (warning) banner. `UNDECIDED` — You have not yet determined whether you will migrate, for example due to external factors or dependencies. Admins see a yellow (warning) banner.

migrationGuideUrl

string

Yes

A URL pointing to a page where you describe your migration plan, timeline, and milestones. Must be a valid, publicly accessible URL.

You can host this page anywhere — for example, your app's documentation site or a Confluence page. To provide version-specific messaging to different cohorts, update this URL in each major version of your app.

willMigrateToForgeBeforeEOS

'YES' | 'NO' | 'UNDECIDED'

Yes

Your intent to migrate the app to Forge before Connect EOS. Accepted values:

YES — You are committed to migrating before Connect EOS. Admins see a blue (information) banner.
NO — You do not intend to migrate before Connect EOS. Admins see a yellow (warning) banner.
UNDECIDED — You have not yet determined whether you will migrate, for example due to external factors or dependencies. Admins see a yellow (warning) banner.

Validation

`migrationGuideUrl`

The value must be a valid URL. The following formats are accepted:

https://example.com/my-migration-plan
https://my-company.atlassian.net/wiki/spaces/APP/pages/123456

Invalid or non-URL values cause a manifest validation error.

`willMigrateToForgeBeforeEOS`

Only the exact string values YES, NO, and UNDECIDED are accepted. Any other value causes a manifest validation error.