JavaScript SDK

The Wix JavaScript SDK allows you access to Wix business solutions and site data from JavaScript code. For example, you can use the @wix/stores package to interact with the Wix Stores product catalog and handle site orders.

Where the JavaScript SDK can be used

• Wix sites: Add custom functionality to Wix sites.
• Wix apps: Develop apps that can be installed on Wix sites.
• Wix Headless: Take advantage of Wix functionality from any app or site you create, on any platform.

What is included in the JavaScript SDK

The JavaScript SDK includes:

APIs

Call Wix APIs to integrate custom functionality, including:

• Business solutions: Customize features from Wix services such as eCommerce, Bookings, and Events.
• Payments: Manage subscription-based payments with Pricing Plans.
• CRM and members: Manage site contacts and members.
• Data: Work with data stored in a Wix database.

Event handlers

To handle an event with the SDK, use the event's callback registration method. For example, to handle the creation of a new cart, call the onCartCreated() method.

How you call a callback registration method depends on the framework you're using:

• When using the CLI, call the method within an event extension.
• When handling events on your own server, create a client and then use it to call the method to register a callback function.

You can also use the SDK to process events sent by Wix on your server using webhooks. For more information, see Handle Events With Webhooks.

Service plugins

Service plugins allow your Wix app to extend the functionality of a Wix site by injecting custom logic into existing app flows or introducing entirely new flows. Learn how to add a Wix-hosted service plugin with the CLI or implement a self-hosted service plugin.

Learn how to build with the JavaScript SDK

Your feedback is important to us.

Tell us about your experience using the Wix JavaScript SDK

Request missing APIs