Dashboard API

The dashboard is the control center for Wix sites. It allows Wix users to manage their sites' settings and business features. The dashboard also includes tools for analytics, eCommerce, and marketing. You can create custom dashboard integrations, including pages and widgets, that are displayed in the dashboards of Wix users.

The Dashboard API allows you to write code in custom dashboard extensions to interact with other parts of the Wix dashboard. Using the API, you can navigate Wix users to pages in the dashboard, display modals, and send alerts and updates using toasts.

Setup

To use the Dashboard API, install the @wix/dashboard package:

Install the package

To install the package, follow the instructions below based on your development environment.

Wix sites and Blocks apps

When developing with:

• Editor or Wix IDE: Use the package manager.
• Local IDE: Use the Wix CLI. Run the following command:

Wix apps and Headless

When developing CLI or self-hosted Wix apps, as well as headless apps or sites, run the following command:

or

Usage

To use the package, follow the instructions below based on your development environment.

Wix sites and Wix-hosted apps

To use the Dashboard API when developing sites or in Wix-hosted apps, import the dashboard module in your code and call it's methods directly.

Self-hosted apps

To use the Dashboard API in self-hosted apps, first create a client using the dashboard module:

Then, use the client to call dashboard module's methods.

For example:

Dashboard permissions

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

For example, if your app has permissions to add products to a store, but the current Wix user does not, your app will not be able to use the stores API to add products to the store. Conversely, if the current Wix 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 Wix user have permissions to do so.

Before you begin

Before you start writing your code, keep in mind that the heights of any dashboard components rendered within iframes are automatically adjusted. 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 APIs and require a method that is not available in the Dashboard API, or alternatively if you would like to suggest a use case that fits the Dashboard API, reach out to Dashboard API Support for assistance.