About the Embedded Script API

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

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".

For more information, see About the Embedded Script API.

Was this helpful?
Yes
No

Script Properties Object

Attributes
parametersobjectformat map
Script parameters

disabledboolean
Whether script is disabled or not, defaults to false (not disabled)
Was this helpful?
Yes
No

GetGet Embedded Script

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Embedded Scripts
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/apps/v1/scripts

Was this helpful?
Yes
No

PostEmbed Script

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Embedded Scripts
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/apps/v1/scripts

Was this helpful?
Yes
No