Preview features are deemed stable; however, they remain under active development and may be subject to shorter deprecation windows. Preview features are suitable for early adopters in production environments.

We release preview features so partners and developers can study, test, and integrate them prior to General Availability (GA). For more information, see Forge release phases: EAP, Preview, and GA.

Dynamic modules registered during EAP must be re-registered for Preview.

In addition to declaring modules in your app manifest, Forge apps can register some modules dynamically at runtime. This capability provides you with the flexibility to define an app's behaviour, and is useful for adding app features that are more responsive to arbitrary user needs.

Dynamic modules are registered in the context of an app installation, which means that an app can register different modules for each app installation.

Limitations

This capability has the following limitations:

Each app installation can register a maximum of 100 dynamic modules. Attempts to exceed this limit will result in a 422 Unprocessable error response.
Remote backends can only use asApp calls for dynamic module operations; asUser calls are not allowed. This means your remote backend will only be able to call the Dynamic Modules API as a generic bot user.

Available modules

The following modules can be declared as a dynamic module:

Jira

Confluence

Jira Service Management

We plan to add more in the future.

Managing dynamic modules

Use the Dynamic Modules API to register, list, update, or delete dynamic modules. Dynamic modules are registered on a per-installation context. Any functions or APIs that use the dynamic module only become enabled once the module is registered.

Migration from Connect

We have no plans to support a migration path for existing dynamic modules from Connect. This means that any dynamic modules registered in Connect app installations will not be automatically migrated to Forge (even if a Forge version of that dynamic module becomes available). Forge apps can only use dynamic modules registered through the Dynamic Modules API.

If you are incrementally migrating a Connect app that used Dynamic Modules, your app should also remove any registered Connect dynamic modules. Then, those modules will need to be either declared as static modules in the Forge manifest or as Forge dynamic modules.

To remove any registered Connect dynamic modules from an installation, your app should use the Connect API to: