Migrate an Embedded Script Extension

This guide explains how to add an embedded script extension to your new Wix CLI project as part of migrating an app from the legacy Wix CLI.

Folder structure

LegacyNew
src/site/plugins/<name>/embedded.jsonsrc/extensions/site/plugins/embedded-script/<name>/<name>.extension.ts
src/site/plugins/<name>/embedded.htmlsrc/extensions/site/plugins/embedded-script/<name>/<name>.html

Step 1 | Move and rename files

To move existing files into the new project:

  1. In the new project, create the folder src/extensions/site/plugins/embedded-script/<name>/.
  2. Copy embedded.html from the legacy project's src/site/plugins/<name>/ folder into the new project's src/extensions/site/plugins/embedded-script/<name>/ folder, and rename it to <name>.html.

Don't copy the old embedded.json file. It is replaced by a new .extension.ts file.

Step 2 | Create the extension file

In src/extensions/site/plugins/embedded-script/<name>/, create <name>.extension.ts:

Copy
FieldSourceRequired
idid from embedded.jsonYes. Must match legacy value to preserve the extension.
namename from embedded.jsonYes
placementplacement from embedded.jsonYes
scriptTypescriptType from embedded.jsonYes
sourcePath to <name>.html, relative to src/Yes

Important: The id must match the value from the legacy embedded.json. Otherwise, the new entry is treated as a separate extension instead of a continuation of the legacy one.

Step 3 | Register the extension

In the new project, in src/extensions.ts, import the extension and add it with .use():

Copy

Step 4 | Return to the main migration guide

Return to the Test, build, and release step in the main migration guide.

Last updated: 29 June 2026

Did this help?