embedScript( )

Inserts custom script tags into a site, with the specified values for any dynamic parameters. Call this method when your app is installed on a site.

Your app must have an existing embedded script component, with exactly matching parameter names.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Embedded Scripts
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
propertiesScriptPropertiesRequired

Details of the script to embed.

optionsEmbedScriptOptions
Returns
Return Type:Promise<EmbedScriptResponse>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?