The Wix Dashboard API allows the code for dashboard pages created in the Wix Editor or with Wix Blocks to interact with the Wix dashboard environment.

Using the module you can:

  • Navigate users to other pages in the dashboard.
  • Display toast notifications at the top of the dashboard. Toast notification
  • Retrieve data about changes to the dashboard's state and use it to update your page in real time.
  • Request user confirmation before they leave the page.

To use the Wix Dashboard API, import the applicable function from wix-dashboard:

import { <function> } from 'wix-dashboard';
js | Copy Code

Before you begin

It's important to note that the Wix Dashboard API can only be used in code running on dashboard pages. The functions in this API don't work in backend code or on any other pages on your site.

Was this helpful?

In This Article
  1. Before you begin