Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

# Dashboard SDK

The [dashboard](fallback::https://support.wix.com/en/article/about-your-wix-dashboard) is the control center for Wix sites. It allows users to manage their sites' settings and business features. The dashboard also includes tools for such as analytics, eCommerce, and marketing. Third-party apps can create custom dashboard integrations, including pages and widgets, that are displayed in the dashboards of users who install those apps as iFrames embedded to the Dashboard.

The Dashboard SDK is a tool that allows the code in custom dashboard extensions to interact with other parts of the Wix dashboard. Using the SDK, developers can navigate users to pages in the dashboard, display modals, and send users alerts and updates using toasts. The SDK makes it easy to create custom experiences for users in their sites' dashboards.

## Setup

In order to use the Dashboard SDK, install the `@wix/dashboard` package:

#### Install using npm

```sh
npm install @wix/dashboard
```

#### Install using yarn

```sh
yarn add @wix/dashboard
```

Next, create a client constant using the dashboard module:

```typescript
import { dashboard } from '@wix/dashboard';
import { createClient } from '@wix/sdk';

const client = createClient({
  host: dashboard.host(),
  auth: dashboard.auth(),
  modules: {
    dashboard,
  },
});
```

You may now use the `client` constant in order to interact with the dashboard. For example:

```typescript
client.dashboard.showToast({ message: 'Hello World' });
```

## Dashboard permissions

When you make API calls from your dashboard extension code, you need to keep in mind which permissions the SDK has available. Your code can access APIs with the permissions of the currently logged-in user, but only if the app your code is running on has also been granted those permissions.


![Dashboard Permissions](https://wixmp-833713b177cebf373f611808.wixmp.com/images/intro-md_js-sdk-docs_media_dashboard-permissions.png)

For example, if your app has permissions to add products to a store, but the current user does not, your app will not be able to use the [`stores` API](portalId::b85dea5b-341b-493b-b99e-4d4ca12baaa2resourceId::c25ced1f-7f72-4f8c-9698-f8ea09396cd0slug::introduction*fallback::https://dev.wix.com/docs/sdk/backend-modules/stores/products/introduction) to add products to the store. Conversely, if the current user has permissions to add products to a store, but your app does not, your app will not be able to add products to the store. The only way your app can add products to a store is if both your app and the current user have permissions to do so.

## Before you begin
Before you start writing your code, keep in mind that the SDK automatically adjusts the heights of any dashboard components rendered within iframes. Because of this, do not use relative CSS height units such as `vh` in your iframe component code.

## Contact us

If you are using one of the legacy Wix SDKs and require a method that is not available in the Dashboard SDK, or alternatively if you would like to suggest a use case that fits the Dashboard SDK, reach out to [Dashboard SDK Support](fallback::https://www.wix.com/support-chatbot?nodeId=25a57397-ccf7-4376-8b74-48d51edf7159&referral=devRels) for assistance.