Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

# About the Embedded Script API

Use this API to inject custom script tags to the head tag of your users' websites.

<blockquote class='important'>
 
 Important: 
 The keys in the custom parameters passed in this API must be identical to the keys defined in the app's embedded script component. Using any other keys results in a 400 error: "Parameters map sent to embedded script is not the same as discovered in the script code".
 
</blockquote>

For more information, see [About the Embedded Script API](https://devforum.wix.com/en/article/about-embedded-script-components).

componentId

instanceId

EmbedScriptByInstanceIdRequest

EmbedScriptRequest

EmbedScriptResponse

GetEmbeddedScriptByInstanceIdRequest

GetEmbeddedScriptRequest

GetEmbeddedScriptResponse

Whether script is disabled or not, defaults to false (not disabled)

disabled

parameters

ScriptProperties

value

StringValue

Retrieves this app's existing embedded script parameters
If the app does not have an embed on the site, this endpoint will return 404

Manage Embedded Scripts

GetEmbeddedScript

Inject a script in an app with an existing embedded script component, with the given parameters. Key names must match exactly to the key names used in the app's embedded script

EmbedScript

Script Properties

Embed Script

Permission Scopes