Get Launch Context

webflow.getLaunchContext()

The getLaunchContext API helps you understand how your Designer Extension was launched and provides contextual information about the launching element.

Use this method on initial load to identify how the extension was launched and provide context about the launching element. The App can use this information to show a customized UI or behavior to manage the element from where it was launched.

Launch Types

Your extension can be launched in three ways:

  1. Apps Panel - Launched directly from the Webflow Designer’s Apps Panel
  2. App Connection - Launched through an existing App Connection
  3. App Intent - Launched with a specific intent (e.g., to create/manage a form or image)

Syntax

1 webflow.getLaunchContext(): Promise<LaunchContext | null>;

Returns

A Promise that resolves to a LaunchContext object or null.

LaunchContext

An object with the following properties:

  • type: 'AppConnection' | 'AppIntent' | 'AppsPanel'
    Indicates how the extension was launched.

  • value: null | string | Record<'form' | 'image', 'create' | 'manage'>
    Additional context about the launch:

    • null - For basic App Panel launches
    • string - For deep links or custom values
    • Object with form/image context - For specific creation or management intents

Example LaunchContext:

1{
2  type: 'AppIntent',
3  value: { form: 'create' }
4}

Example

1    async function getLaunchContext() {
2      const context = await webflow.getLaunchContext();
3      if (context) {
4        await webflow.notify({ type: "Success", message: `App was launched through ${context.type}` });
5      }
6    }

Designer Ability

Designer AbilityLocaleBranchWorkflowSitemode
canDEAccessCanvasAnyAnyAnyAny