Mintlify Sandbox

Coding Examples

Overview

Sled Tests

Go Headless

Studio Two

Dashboard Extensions

Backend Extensions

Site Extensions

Extend Websites with SDK

Wix APIs and References

Build Apps

Frontend Modules

Client (Deprecated)

API Preview

Wix CLI

Contexts

Ricos

Extend Websites with Velo

API Reference

Velo

Picasso

# External URL Extension Files and Code

An [external URL extension](fallback::https://dev.wix.com/docs/overview/extensions-framework/dashboard-extensions/external-url-extensions) is available in Wix CLI apps.

> **Note:** A Studio Two site doesn't use this extension. Headless projects don't support it. See [About External URL Extensions](fallback::https://dev.wix.com/docs/dashboard-extensions/external-urls/about-external-url-extensions).

When you add the extension, the generated file lands under `src/extensions/dashboard/external-page/<extension-folder>/` and the extension is registered in your project's `extensions.ts`.

```text
src/
└── extensions/
    └── dashboard/
        └── external-page/
            └── <extension-folder>/
                └── <extension-folder>.extension.ts
```

| File | What it's for |
|------|---------------|
| `<extension-folder>.extension.ts` | The [configuration file](fallback::#configuration-file) for the extension ID and the destination URL. |

The extension has no component file. When a Wix user opens the link, the destination URL loads in a new browser tab.

## Configuration file

The `<extension-folder>.extension.ts` file declares the extension with `extensions.dashboardExternalPage()`.

```ts
import { extensions } from '@wix/astro/builders';
```

```ts
export default extensions.dashboardExternalPage({
  id: string,
  url: string,
});
```

Example:

```ts
export default extensions.dashboardExternalPage({
  id: 'b2f3c4d5-e6f7-4a8b-9c0d-1e2f3a4b5c6d',
  url: 'https://example.com',
});
```

### Configuration fields

| Field | Type | Description |
|--|--|--|
| `id` | string | Extension ID as a GUID. It must be unique across all extensions in the project. |
| `url` | string | Address of the external destination. When a Wix user opens the app from the Manage Apps page, this address opens in a new browser tab. The address must use `https`. Wix appends the [app instance](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/access/app-instances/about-app-instances) as an `instance` query parameter so the destination can identify the site. |

## See also

- [About External URL Extensions](fallback::https://dev.wix.com/docs/dashboard-extensions/external-urls/about-external-url-extensions)
- [External URL Extensions](fallback::https://dev.wix.com/docs/overview/extensions-framework/dashboard-extensions/external-url-extensions)
- [Add External URL Extensions with the Wix CLI](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/develop-an-app-with-the-cli/supported-extensions/dashboard/external-links/add-external-url-extensions-with-the-wix-cli)
- [About App Instances](portalId::63e3acd8-2a9c-421d-8f92-d02930eeb59eresourceId::5b8da559-d0ad-4902-befb-7069b57df1ec*fallback::https://dev.wix.com/docs/build-apps/develop-your-app/access/app-instances/about-app-instances)