JavaScript SDK

The Wix JavaScript SDK gives you access to Wix data and functionality from JavaScript code, and lets you interact with Wix-native environments such as the site dashboard and Wix Studio. For example, you can use the essentials core module to work with Wix authentication, or the dashboard host module to open a modal in the site dashboard.

Share your feedback
Your feedback helps us improve the development experience! Join the Devs on Wix Discord community to discuss features, give feedback, and connect with our growing community of developers.

What's in this SDK reference

The SDK reference contains items that are specific to the JavaScript SDK and includes the following:

  • Core modules: Essential functionality for interacting with the Wix platform, such as authentication and client setup.
  • Host modules: APIs that allow you to interact with a Wix site when writing code for frontend environments such as the dashboard, editor, or site.
  • Frontend modules: Client-side APIs for interacting with Wix sites and their features from the browser, in site code on Wix Studio and Wix Editor sites.
  • Data Items SDK: Backend APIs for working with data items.
  • Site SDK: Frontend APIs for code that runs on Studio Two sites.

Throughout this reference, you'll find examples for calling each method depending on development path and project type.

Where the JavaScript SDK can be used

Extend Websites
Customize a Wix site's functionality by creating an interactive UI, working with data-driven content, and integrating with 3rd-party services.
Build Wix Apps
Develop an app for Wix's App Market, enabling users to extend their site's functionality.
Create Headless Experiences
Build your own frontend on Wix functionality using any tech stack.

SDK packages

The SDK includes a universal npm package @wix/sdk which manages authentication and communication with the Wix platform.

Each module also has its own npm package, such as @wix/essentials, @wix/dashboard, @wix/editor, @wix/site, @wix/web-methods, and @wix/data.

Self-managed apps and headless sites must initialize and use a Wix client to call SDK methods.

To work with a module in a self-managed app or headless site, you need both the universal SDK package and the package for the module you wish to work with. For example, to work with Data Items, you need both @wix/sdk and @wix/data.

These packages are fully typed, making the structure of parameters and fields predictable and easy to work with. Package versioning follows SemVer convention, for convenient dependency management.

Authentication and permissions

Depending on the context of your code, you may need to elevate the method you want to call.

If you're developing a Wix app, you need to add permissions for the APIs you're calling in the app dashboard. Read more about permissions.

Use these docs with AI tools

Wix developer documentation is available in machine-readable formats for use with AI coding assistants and LLMs:

  • llms.txt index: Browse a structured index of all documentation at dev.wix.com/docs/llms.txt.
  • Markdown format: Append .md to any documentation page URL to retrieve a Markdown version of that page.
  • Page menu: Use the "Ask Assistant" dropdown on any documentation page to copy the page as Markdown or get a direct link to the Markdown version.

Your feedback is important to us.

Contact support to tell us about your experience or request missing APIs. Open a ticket and we'll get back to you within 72 hours.

Last updated: 5 November 2026

Did this help?