Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

GraphQL (Alpha)

properties

ScriptProperties

Inserts custom script tags into a site.


Your app must have an existing
[embedded script component](https://dev.wix.com/docs/build-apps/developer-tools/extensions/embedded-scripts),
with exactly matching parameter names.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { embeddedScripts } from '@wix/app-market';

const wixClient = createClient({
  modules: { embeddedScripts },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function embedScript(properties, options) {
  const response = await wixClient.embeddedScripts.embedScript(properties, options);
}

embedScript() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { embeddedScripts } from '@wix/app-market';

const wixClient = createClient({
  modules: { embeddedScripts },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function embedScript(properties, options) {
  const response = await wixClient.embeddedScripts.embedScript(properties, options);
}

embedScript() with Dashboard app access

embedScript

EmbedScriptResponse

Retrieves information about your app's existing embedded script.


The call fails with `404` error in case your app doesn't include an
embedded script on the site.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { embeddedScripts } from '@wix/app-market';

const wixClient = createClient({
  modules: { embeddedScripts },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function getEmbeddedScript(options) {
  const response = await wixClient.embeddedScripts.getEmbeddedScript(options);
}

getEmbeddedScript() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { embeddedScripts } from '@wix/app-market';

const wixClient = createClient({
  modules: { embeddedScripts },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function getEmbeddedScript(options) {
  const response = await wixClient.embeddedScripts.getEmbeddedScript(options);
}

getEmbeddedScript() with Dashboard app access

getEmbeddedScript

Details of the retrieved embedded script.

To use the EmbeddedScripts API, install the `@wix/app-market` package using npm or Yarn:
  ```console
npm install @wix/app-market
```

or

```console
yarn add @wix/app-market
```

Then import `{ embeddedScripts }` from `@wix/app-market`:

```js
import { embeddedScripts } from '@wix/app-market'
```
  

Setup

Permission Scopes

Permission Scopes