Release Notes

We're always adding and updating the Velo APIs, and we want you to have one place to find all of our latest changes and cool additions.

We love hearing your feedback! You can help us improve the docs by reporting any issues that you notice. You can report bugs and other feedback through the following link found at the bottom of each section.

Updated API: Reservations API

wix-table-reservations.v2

The Reservations API now includes a new function:

(Sep 4, 2024)

New APIs: Wix Restaurants

wix-restaurants.v2

The new Restaurants API provides all the functionality required to create and manage restaurant operations, service fees, fulfillment methods, and menus.

It contains the following APIs:

Operations

The Operations API allows you to create, retrieve, and manage operations for restaurants. An operation refers to different services a restaurant may offer. For example, a restaurant may offer a takeaway operation and a catering operation, where each one would work with different time frames, availabilities, and fees.

With the Operations API, you can:

Service Fees

The Service Fees API allows you to create, retrieve, and manage service fee rules for restaurants and apply them to orders. A service fee is an additional fee that's applied to an order when specified conditions are met.

With the Service Fees API, you can:

Fulfillment Methods

The Fulfillment Methods API allows you to create, retrieve, and manage fulfillment methods for restaurants. A fulfillment method is a method by which a restaurant can provide its customers their orders.

With the Fulfillment Methods API, you can:

Menus

The Menus API allows you to manage and customize restaurant menus with the following APIs:

(August 27, 2024)

New API: Analytics Data API

wix-analytics-data.v2

The new Analytics Data API enables you to access a site's analytics data, specifically site visits, sales, orders, and contact requests.

(August 26, 2024)

New API: Marketing Consent API

The new Marketing Consent API allows you to manage a site's marketing consents, which are the agreements that visitors consent to when signing up for non-transactional content, such as a newsletter.

(August 25, 2024)

New API: Analytics Sessions API

wix-analytics-session.v2

The new Analytics Sessions API allows you to access session IDs collected from Wix sites, and mark sessions as recorded.

(August 25, 2024)

New API: wix-ecom-frontend

The new eCommerce Frontend API allows you to interact with the native cart and checkout components on your site. As part of this release, wix-stores-frontend functions will be deprecated and replaced by the new wix-ecom-frontend module.

With the eCommerce Frontend API you can:

(July 29, 2024)

Temporarily Removed: Web Method Cache

We've temporarily removed the documentation for web method caching and plan to re-release the feature in the future. This isn't a breaking change. If you already have caching set up, your code will continue to work as expected, but the caching functionality will be disabled.

(July 11, 2024)

New API: Tags

Tags are labels attached to entities that allow for data categorization and management. For example, an eCommerce order can have associated tags.

With the tags API you can:

(July 3, 2024)

Updated API: Wix Dashboard

wix-dashboard

The wix-dashboard API has 2 new methods:

  • setPageTitle(), that sets the dashboard page title in your browser tab.
  • addSitePlugin(), that adds a site plugin to a slot within an app created by Wix.

(June 27, 2024)

New API: Dashboard Favorite List API

The Dashboard Favorite List API provides functionality to create and manage a list of favorite dashboard pages. It allows you to streamline Wix users to dashboard navigation experience and make important pages quickly accessible.

With the Dashboard Favorite List API, users can:

  • Create, retrieve, update, and delete their list of dashboard favorites.
  • Add and delete individual dashboard favorites to and from their list.
  • Create nested views of collections, developer tools, or other dashboard pages for quick access.
  • Assign custom titles to favorite pages for easier navigation.

(June 18, 2024)

New API: Cache

wix-caching-backend

The Cache API allows you to invalidate your function's return value caches that were previously cached with the webMethod() function of the wix-web-module.

Use the invalidateCache()](https://dev.wix.com/docs/velo/api-reference/wix-site-backend/invalidate-cache) to specify which cached values to invalidate.

Learn more about invalidating your function caches.

(June 16, 2024)

Updated API: Web Modules

wix-web-module

The webMethod() function has a new cache object in the options parameter that allows you to cache the return values of the functions in your backend code. Define the duration for which you want the return value to be cached with the ttl field. Use the tags field to assign identifiers to the cache.

Learn more about function caching in the backend.

(June 16, 2024)

New APIs: Gallery

Wix Editor Elements ($w)

We added the following Gallery APIs:

(June 10, 2024)

New Functions: Loyalty Accounts API

wix-loyalty.v2

The Accounts API now includes two new functions:

(June 5, 2024)

New Functions: Loyalty Program API

wix-loyalty.v2

The Program API now includes three new functions:

(June 5, 2024)

New Functions: Loyalty Tiers API

wix-loyalty.v2

The Tiers API now includes two new functions:

(June 5, 2024)

New Functions: Loyalty Rewards API

wix-loyalty.v2

The Rewards API now includes two new functions:

(June 5, 2024)

New Release: Loyalty Transactions API

wix-loyalty.v2

The Loyalty Transactions API allows you to query transactions related to account activity. The new API includes:

(June 5, 2024)

Fully Released: Wix Loyalty APIs

wix-loyalty.v2 The following Wix APIs are no longer in Developer Preview. This means that the APIs are not subject to breaking changes and can be used in production.

Loyalty Accounts APIs

Loyalty Programs APIs

Loyalty Tiers APIs

Loyalty Rewards APIs

(June 5, 2024)

New API: Ticket Definitions v2

wix-events.v2

With the Ticket Definitions API, you can create definitions for tickets. A definition includes various ticket settings, such as fee type, pricing, availability, sale period.

(May 30, 2024)

New API: WixComments Element

Wix Editor Elements ($w)

The new WixComments element is a comment widget available in the Wix App Market to manage comment threads on your Wix site.

The WixComments API allows you to control the comment widget's functionality using code. You can lock the widget, create new comment threads, open and close the comment text input area, and set event handlers for viewing new comments and tracking the total comment count.

(May 20, 2024)

New API: Dashboard onBeforeUnload

wix-dashboard

We added a new function to wix-dashboard called onBeforeUnload(). Use this function on dashboard pages to prompt site builders before leaving a page with unsaved data.

(May 16, 2024)

Updated API: PanelButton Element

Wix Editor Elements ($w)

We added following properties to the PanelButton element:

  • link: Sets or gets the element's link to an external site.
  • target: Sets or gets the target of the element's link.

(May 15, 2024)

New APIs: Forum Categories

wix-forum.v2

The Forum categories API has two new functions:

(April 22, 2024)

Updated API: MenuContainer Element

Wix Editor Elements ($w)

In the MenuContainer element, we removed the onItemMouseIn(), onItemMouseOut(), onItemClick(), and onItemDblClick() event handlers and the menuItems property from its documentation. These methods and properties were never supported by MenuContainer.

(April 17, 2024)

Updated API: Wix Billing Backend

wix-billing-backend

We made the following changes to the Invoices API:

  • createInvoice(): Added an optional locale object to the invoiceFields parameter. This parameter sets the locale of the customer invoice.

  • getInvoice(): Adjusted the list of supported IETF language subtags in the locale.language property. The previous 4-letter language codes listed in the documentation were never returned in the Invoice response object. The listed codes have been corrected to display 2-letter language subtags.

(April 16, 2024)

Updated API: Container Element

Wix Editor Elements ($w)

The Container element now contains a new onKeyPress() method. This method adds an event handler that's triggered when a key is pressed while the container or one of its child elements is focused.

(April 16, 2024)

New API: Open Media Manager

wix-dashboard

The openMediaManager() API allows you to open a Wix Media Manager modal on a dashboard page. Site builders can select one or more the site's media files using the manager. The API returns a list of the selected files when the modal is closed.

(April 15, 2024)

New APIs: Open and Close Modal

wix-dashboard

Use the openModal() API to open a dashboard modal extension on a dashboard page. Use the closeModal() API to close a currently open modal.

(April 14, 2024)

New Developer Preview APIs: Wix URLs APIs

wix-urls.v2

Wix URLs introduces new APIs that provide developers with access to a site's URLs:

  • Wix Editor: Access the site's editor URL and site preview URL.
  • Wix Site: Access the site's published site URLs, included translated pages.

(April 14, 2024)

New release: More Wix Events APIs

wix-events.v2

Wix Events introduces new APIs that provide developers with a growing set of services for customizing Events functionality on Wix sites:

  • Categories: Create and assign various categories to their events.
  • Forms: Customize a registration form for site visitors to fill out with their contact details and other relevant information.
  • Orders: The Checkout module is now merged with Orders.
  • RSVP: Access the information on guests who have RSVP'ed to an event.
  • Schedule: Share the lineup of an event’s activities, presentations, performances, or sessions.
  • Schedule Bookmarks: Allow members to mark their favorite schedule items to curate their own personalized agenda for your event.
  • Wix Events v2: The updated Wix Events API where you can create and manage events on your site.

(April 4, 2024)

New Developer Preview APIs: Mobile Elements

Wix Editor Elements ($w)

Important:

  • These APIs are only relevant for custom widgets in Branded Apps.
  • Custom widgets are not yet available to all users.
  • These APIs are in Developer Preview and are subject to change.

We added the following mobile APIs:

  • MobileButton: A button element on a mobile app.
  • MobileContainer: A container element for repeater items on a mobile app.
  • MobileElement: Provides basic functionality for mobile elements.
  • MobileImage: An image element on a mobile app.
  • MobilePicker: A picker for selecting items on a mobile app.
  • MobileRepeater: A repeater mobile element used for creating repeating layouts on a mobile app widget.
  • MobileSwitch: A switch used for a single binary choice on a mobile app.
  • MobileText: A text element on a mobile app.
  • MobileTextInput: A text input element for capturing small amounts of text on a mobile app.

(April 3, 2024)

New Developer Preview API: Wix Mobile

wix-mobile

Important:

  • This API is only relevant for custom widgets in Branded Apps.
  • Custom widgets are not yet available to all users.
  • This API is in Developer Preview and is subject to change.

The Wix Mobile API provides the functionality required to work with your mobile app.

It contains the showAlert() API that creates and opens an alert modal on your mobile app.

(April 3, 2024)

New Developer Preview API: Wix Navigate Mobile

wix-navigate-mobile

Important:

  • This API is only relevant for custom widgets in Branded Apps.
  • Custom widgets are not yet available to all users.
  • This API is in Developer Preview and is subject to change.

The Wix Navigate Mobile API provides the functionality required to navigate through your mobile app.

It contains the openUrl() API that directs your mobile app to open the specified URL in the device's browser.

(April 3, 2024)

Updated API: Wix Window Frontend

wix-window-frontend

We've added a new mode, "Editor", to the viewMode property of the wix-window-frontend module.

The viewMode property retrieves the "Editor" value when viewing a Wix Blocks built widget in the editor.

(March 18, 2024)

New: Wix Blocks Panel Builder Elements

The following elements can be added to Wix Blocks Custom Panels and managed in the Wix Blocks Panel Code:

  • PanelColorPicker The panel color picker is used in the Wix Blocks panel builder for picking colors from a color palette.
  • PanelFontAndColorPicker The panel font and color picker is used in the Wix Blocks panel builder for picking fonts from a dropdown and colors from a color palette.

(March 5, 2024)

New SPI: Velo Action

The new Velo Action SPI lets you create your own custom action to use in your site's automations. You can create and test code directly in your site dashboard when creating or editing an automation.

(February 14, 2024)

Updated API: Tasks V2

wix-crm-v2

We've updated the Tasks API, which allows you to create and manage tasks on your site. Functionality includes:

(February 13, 2024)

New APIs: Dashboard

The Dashboard API has two new functions:

  • observeState() allows you to react to changes in a dashboard page's environment.
  • getPageUrl() allows you to retrieve the full URL for any dashboard page.

(February 12, 2024)

New API: WixFormsV2 Element

Wix Editor Elements ($w)

The new WixFormsV2 Element displays customizable forms, collects all the info that a site visitor entered into the form fields, and lets you track all form submissions in the dashboard.

(February 7, 2024)

Deprecated: Workflows API

wix-crm-backend

The Workflows API will be discontinued in the upcoming months. Our team is working to provide alternatives, and we'll provide timely updates before implementing any changes. We understand that this transition might present challenges, and we appreciate your patience and understanding.

(February 6, 2024)

Updated API: Pricing Plans v2

wix-pricing-plans.v2

We've updated the wix-pricing-plans.v2 module, which is currently released as a developer preview. Note that the changes break existing code that uses the following functions, which requires updates to your code:

  • Orders:

    • createOfflineOrder(): memberId has been taken out of the options parameter, and is now the second required parameter after planId.
    • getOfflineOrderPreview(): memberId has been taken out of the options parameter, and is now the second required parameter after planId.

    (February 6, 2024)

New Release: More eCommerce APIs

wix-ecom-backend

Wix eCommerce introduces new functionality to the Orders, Order Transactions, and Order Invoices APIs that provide developers with a growing set of services for customizing eCommerce functionality on Wix sites. The APIs include the following endpoints and webhooks:

As part of this release, several wix-stores-backend functions and events have been deprecated and will be removed on June 30, 2024.

Note: This module is in Developer Preview.

(February 4, 2024)

New API: Checkout Templates

wix-ecom-backend

The new Checkout Templates API allows you to manage templates to share pre-populated checkouts with customers. When customers then create checkouts from these templates, the new checkouts already include information such as predefined line items, coupons, or other customizations. Functionality includes:

Note: This module is in Developer Preview.

(January 31, 2024)

New APIs: Wix Bookings V2 Services Functions and Events

wix-bookings.v2

We added new APIs in the Wix Bookings Services V2 module that:

(January 29, 2024)

New API: Rich Content Viewer Element

Wix Editor Elements ($w)

We added the new Rich Content Viewer Editor Element that allows you to display rich content created using the Rich Content Editor in the CMS (Content Management System). The content property is an object used to set and get the content of the Rich Content Viewer element.

(January 11, 2024)

New Developer Preview API: Wix Blog Draft Posts

wix-blog-backend

The new Draft Posts API allows you to manage unpublished blog posts. Functionality includes:

  • Create, update, or delete draft posts.
  • Get, list, or query draft posts.
  • Get or list deleted draft posts.
  • Restore or remove draft posts from the trash bin.

Note: This module is in Developer Preview.

(December 31, 2023)

Temporarily Removed: Tasks API

wix-crm.v2

The Tasks API is being temporarily removed in preparation for replacement by a new version.

(December 25, 2023)

Removed: Workflows API

wix-workflows.v2

The Workflows v2 API is being discontinued and will no longer be supported moving forward. Please remove any code that uses workflows.v2.

(December 19, 2023)

New APIs: Hamburger Menu Element

Wix Editor Elements ($w)

We added the following new APIs that allow you to customize the [hamburger menu] element:

  • HamburgerOpenButton: The icon button that opens the hamburger menu.
  • **HamburgerCloseButton: The icon button that closes the hamburger menu.
  • HamburgerMenuContainer: The hamburger menu container, which holds the items of an expanded hamburger menu.
  • HamburgerOverlay: The fullscreen overlay that appears when the hamburger menu is open.

(December 18, 2023)

New Function: Media API

wix-media.v2

The Media Manager Files API now includes a new function:

  • bulkImportFile() imports a bulk of files to the Media Manager using external URLs. This replaces bulkImportFiles() which has been deprecated and will be removed on March 31, 2024.

(December 14, 2023)

Updated APIs: Pricing Plans Frontend and Pricing Plans Backend

wix-pricing-plans-frontend, wix-pricing-plans-backend

We've updated the wix-pricing-plans-frontend and wix-pricing-plans-backend modules to reflect the actual function syntaxes.

wix-pricing-plans-frontend:

  • Checkout:
    • createOnlineOrder(): couponCode has been removed and startDate has been taken out of the options parameter.
    • startOnlinePurchase(): couponCode has been removed and startDate has been taken out of the options parameter.

wix-pricing-plans-backend:

  • Checkout:
    • createOnlineOrder(): couponCode and startDate have been taken out of the options parameter.

New Developer Preview API: Table Reservations

The Table Reservations API provides all the functionality required to create and manage restaurant table reservations.

It contains the following APIs:

  • Reservations: Creates and manages restaurant table reservations.
  • Reservation Locations: Provides location information and configures reservation settings for individual restaurants.
  • Time Slots: Retrieves availability information for time slots at a reservation location.

(December 11, 2023)

Updated API: Wix Inbox v2

wix-inbox.v2

We've updated the wix-inbox.v2 module, which is currently released as a developer preview. Note that the changes break existing code that uses the following functions, which requires updates to your code:

  • Conversations:
    • getOrCreateConversation(): participantId has been removed from the options parameter, and is now the first required parameter.
  • Messages:
    • listMessages(): visibility has been removed from the options parameter and is now the required second parameter after conversationId.
    • sendMessage(): message has been removed from the options parameter and is now the required second parameter after conversationId.

(November 29, 2023)

New Developer Preview API: Reviews

wix-reviews.v2

The new Reviews API allows you to manage reviews for a site's services, content, or products. Functionality includes:

  • Create, delete, get, or update a review.
  • Query reviews.

Note: This module is in Developer Preview.

(November 28, 2023)

New API: TextMask

Wix Editor Elements ($w)

The new TextMask API allows you to mask images and videos in the background of your text. Use the text property to set or get the TextMask's plain-text content. Use the background.src property to set or get the source of the TextMask's background.

(November 27, 2023)

New API: Slideshow Button

Wix Editor Elements ($w)

The new SlideshowButton API allows you to customize the navigation buttons on your slideshow. Similar to the Button element, you can manage the labels, styles, icons, and visibility settings of a slideshow button. Note that you can't set a link to a slideshow button.

(October 17, 2023)

Migration of legacy APIs, batch 3

In the past few weeks, we've re-released some more legacy APIs. This follows the May, June, July, and August 2023 re-releases of legacy APIs.

You don't need to take any action at this time. As always, we'll continue to support the legacy APIs, so your existing code will continue to work as it does today.

Behind the scenes, this is part of a large, cross-Wix effort to move all of our APIs to a new infrastructure. This migration will allow us to release APIs more quickly after they're developed, and to align with established design patterns across all of Wix's APIs. This means you can get your hands on better, more consistent APIs, faster than before.

What's in this release

All the new modules are released as a developer preview and, unless otherwise mentioned, are universal modules.

Most of the APIs contain the same functionality as the previous version. In some rare cases, a regression was unavoidable. This list outlines the modules (and their respective namespaces) that were released, as well as any new or removed functionality as compared to the previous release:

wix-business-tools.v2:

  • All functions are now in the SiteProperties namespace inside the module.
  • Site Properties:
    • New: getSiteProperties() This function replaces all functions in the GeneralInfo namespace inside the wix-site-backendmodule.
    • New: updateBusinessContact()
    • New: updateBusinessProfile()
    • New: updateBusinessSchedule()
    • New: updateConsentPolicy()

wix-members.v2:

  • Functions from the previous CurrentMember namespace are now in the Members namespace.
  • Members:
    • createMember()
    • listMembers()
    • queryMembers()
    • getCurrentMember() replaces getMember() from CurrentMember.
    • joinCommunity() replaces makeProfilePublic() from CurrentMember.
    • leaveCommunity() replaces makeProfilePrivate() from CurrentMember.
    • updateCurrentMemberSlug() replaces updateSlug() from CurrentMember.
  • getRoles() from CurrentMember is not available.

(October 15, 2023)

New $w Product Page APIs

We added the following new $w Product Page APIs:

  • getCustomText(): Gets the values of a product's custom text fields.
  • getQuantity(): Gets the quantity of a product in the Product Page.
  • getSelectedChoices(): Gets the selected product option choices of a product in the Product Page.
  • getSelectedVariantId(): Gets the variant ID of the selected product variant.
  • onAddToCart(): Adds an event handler that runs when the Add To Cart button in the Product Page is clicked.
  • onBuyNow(): Adds an event handler that runs when the Buy Now button in the Product Page is clicked.
  • onChoiceSelected(): Adds an event handler that runs when a product option choice is selected.
  • onQuantityChanged(): Adds an event handler that runs when a product's quantity is changed.
  • setAddToCartLabel(): Sets the Add To Cart button's label.
  • setBuyNowLabel(): Sets the Buy Now button's label.
  • setQuantity(): Sets the quantity of a product in the Product Page.

We also added a tutorial that uses some of the new $w Product Page APIs: Tutorial: Adding a Request A Quote Option to a Wix Store Product Page.

(October 10, 2023)

New Developer Preview API: Recommendations

The new Recommendations API allows you to promote and recommend items to your customers using recommendation algorithms. It includes the following endpoints:

  • List available recommendation algorithms.
  • Get a list of item recommendations from an algorithm.

Note: This module is in Developer Preview.

(September 21, 2023)

New Developer Preview API: Back In Stock Notifications

The new Back In Stock Notifications API allows you to manage customer requests to receive back in stock notifications when out-of-stock items become available.

Functionality includes:

  • Settings that allow you to start and stop collecting requests.
  • Creating or deleting a back in stock notification request.
  • Getting or querying back in stock notification requests.
  • Manually reporting an item as back in stock, which triggers the requested notification to send.
  • Events when a back in stock notification request is created, updated, or deleted.

Note: This module is in Developer Preview.

(September 4, 2023)

Migration of Booking Resources API

We've re-released another legacy API. This follows the May, June, and July 2023 re-releases of legacy APIs.

This API is released as a developer preview and is a universal module.

You don't need to take any action at this time. As always, we'll continue to support the legacy APIs, so your existing code will continue to work as it does today.

wix-bookings.v1:

  • Resources:
    • updateSchedules() replaces updateResourceSchedule().
    • queryResourceCatalog() is not available.

(August 31, 2023)

Update: New fields in Pricing Plans

wix-pricing-plans.v2

The Plans object has a new formId field, which is the ID of the order form associated with a plan at checkout.

The Orders object has a new formData object, which contains the following fields:

  • formId: the ID of the order form associated with a plan at checkout.
  • submissionId: the ID of the plan's order form submitted at checkout.
  • submissionData: the data submitted to the plan's order form at checkout.

(August 31, 2023)

New API: Web Modules

This API is only available for Wix Studio sites. Wix Studio is currently in beta and is not yet available to all users.

wix-web-module

The Web Modules API allows you to define functions in your backend code that can be called from your site's frontend code. Use the webMethod() function to define a backend function and the permissions needed to call it.

(August 23, 2023)

New API: Forms Submissions

The new Form Submissions API allows you to manage form submissions from your site visitors.

Functionality includes:

  • Creating, updating, or deleting a submission.
  • Getting a submission or querying submissions by namespace.
  • Counting the number of submissions for a specific form.
  • Marking submissions as seen.
  • Confirming a submission has been recorded.
  • Geting a media upload URL to use when creating a submission with a field for uploading files.

(August 21, 2023)

New: Dashboard Builder Elements

Wix Editor Elements ($w)

You can now add these elements to dashboard pages in your Wix site or in Wix Blocks:

  • DashboardButton
  • DashboardHeading
  • DashboardIconButton
  • DashboardInfoIcon
  • DashboardInput
  • DashboardNumberInput
  • DashboardText
  • DashboardTextButton
  • DashboardToggleSwitch

(August 13, 2023)

New API: Accordion

Wix Editor Elements ($w)

Note: This feature is currently only available in Wix Studio and Editor X.

The new Accordion API allows you to display multiple, collapsible item elements in a vertical stack, each with different content.

(August 9, 2023)

New Developer Preview API: Wix Comments v2

The new Comments API allows you to manage a customized commenting program.

Functionality includes:

  • Creating, updating, or deleting a comment.
  • Getting or querying comments.
  • Marking and unmarking a comment.
  • Counting comments.
  • Events when a comment is created, updated, deleted, marked, or unmarked.

Note: This module is in Developer Preview.

(August 9, 2023)

New SPI: eCommerce Validations

The new eCommerce Validations SPI is a custom extension that allows you to validate a site visitor's cart and checkout.

The GetValidationViolations() function validates a site visitor's cart or checkout and returns any validation violations. Site visitors can see the validation violations in their cart and checkout pages.

(July 30, 2023)

Migration of Notifications API

We've re-released another legacy API. This follows the May and June 2023 re-releases of legacy APIs.

This API is released as a developer preview and is a universal module.

You don't need to take any action at this time. As always, we'll continue to support the legacy APIs, so your existing code will continue to work as it does today.

wix-notifications.v2:

  • notify() has moved to the Notifications namespace within the module.

(July 24, 2023)

New API: Effects

Wix Editor Elements ($w)

The new Effects API allows you to programmatically change the way supported elements are displayed on your site.

(July 19, 2023)

CSS Styling and Custom Class List

Wix Editor Elements ($w)

Note: This feature is currently in Beta and open to a limited number of users. You can now add CSS styling to customize the appearance of your website, from colors and fonts to the sizes and positions of different elements. Apply CSS to available global classes or create your own with the Custom Class List element.

(July 19, 2023)

New Module for Wix Blocks: Wix Application

Note: Wix Blocks is currently in Beta and open to a limited number of users.

This module includes functions to manage and get information about Blocks applications that are installed on a site.

It includes:

  • getDecodedAppInstance(): Gets an installed Blocks app's instance, including its current pricing plan.
  • getAppPageUrl(): Gets the page URL of a Blocks app that was installed as a new page.
  • openAppLightbox(): Opens the lightbox of a Blocks app that was installed as a lightbox.

(July 18, 2023)

Migration of frontend-only APIs

We've migrated the frontend modules of legacy APIs so they now end with -frontend (for example, wix-bookings-frontend replaces wix-bookings). Other than the name, these modules are identical to the modules they replace.

You don't need to take any action at this time. As always, we'll continue to support the legacy APIs so your existing code will continue to work as it does today. The legacy APIs will be hidden in the docs, so please refer to the new modules for reference.

What's in the release:

  • wix-animations-frontend replaces wix-animations.
  • wix-bookings-frontend replaces wix-bookings.
  • wix-crm-frontend replaces wix-crm.
  • wix-events-frontend replaces wix-events.
  • wix-location-frontend replaces wix-location.
  • wix-members-frontend replaces wix-members.
  • wix-pay-frontend replaces wix-pay.
  • wix-pricing-plans-frontend replaces wix-pricing-plans.
  • wix-realtime-frontend replaces wix-frontend.
  • wix-seo-frontend replaces wix-seo.
  • wix-site-frontend replaces wix-site.
  • wix-storage-frontend replaces wix-storage.
  • wix-stores-frontend replaces wix-stores.
  • wix-window-frontend replaces wix-window.

(June 21, 2023)

Migration of legacy APIs, batch 2

In the past few weeks, we've re-released some more legacy APIs. This follows the May 2023 re-release of the first batch of APIs.

You don't need to take any action at this time. As always, we'll continue to support the legacy APIs, so your existing code will continue to work as it does today.

Behind the scenes, this is part of a large, cross-Wix effort to move all of our APIs to a new infrastructure. This migration will allow us to release APIs more quickly after they're developed, and to align with established design patterns across all of Wix's APIs. This means you can get your hands on better, more consistent APIs, faster than before.

What's in this release

All the new modules are released as a developer preview and, unless otherwise mentioned, are universal modules.

Most of the APIs contain the same functionality as the previous version. In some rare cases, a regression was unavoidable. This list outlines the modules (and their respective namespaces) that were released, as well as any new or removed functionality as compared to the previous release:

wix-secrets.v2:

  • All functions are now in the Secrets namespace inside the module.

wix-workflows.v2:

  • The Workflows namespace has been split into Workflows, Tasks, and Cards. Functions are now located in their respective namespaces.
  • Workflows:
    • updateWorkflow() replaces updateWorkflowFields().
    • listWorkflows() replaces listWorkflowsInfo().
    • getWorkflow() replaces getWorkflowInfo().
  • Phases:
    • updatePhase() replaces updatePhaseFields().
    • listPhases() replaces listPhasesInfo().
    • getPhase() replaces getPhaseInfo().
  • Cards:
    • updateCard() replaces updateCardFields().

wix-groups.v2:

  • CreateRequests:
    • approveGroupRequests() replaces approveCreateRequests().
    • listGroupRequests() replaces listCreateRequests().
    • queryGroupRequests() replaces queryCreateRequests().
    • rejectGroupRequests() replaces rejectCreateRequests().

wix-crm.v2:

  • The previous Contacts namespace is split into Contacts, Labels, and ExtendedFields.
  • Tasks:
    • updateTaskStatus() replaces completeTask() and resetTask().

wix-captcha.v2:

  • authorize() has moved to the Captcha namespace within the module.

(June 20, 2023)

New API: Wix Dashboard

wix-dashboard

The new Wix Dashboard API allows you to interact with your site's dashboard pages using Velo. You can use the API to navigate users to dashboard pages, and display toast messages.

(June 13, 2023)

New Developer Preview API: Guests

wix-events.v2

The new Guests API provides the ability to retrieve information about guests attending an event by using the queryGuests method.

Note: This module is in Developer Preview.

(June 8, 2023)

New Developer Preview API: Wix Bookings Attendance

wix-bookings.v2

The new Wix Bookings Attendance APIs provide the following functionality:

  • Set the attendance for a booked session, such as whether the session was attended and by how many participants.
  • Get the attendance information for a booked session.
  • Query the attendance information for a booked sessions by booking or by session.

Note: This module is in Developer Preview.

(June 8, 2023)

New Developer Preview API: Wix Loyalty Tiers, Rewards, and Coupons

wix-loyalty.v2

The new Wix Loyalty APIs provide the following functionality:

  • Manage a loyalty tiers program, including creating new tiers and updating settings that apply to all of the tiers in the program.
  • Manage the loyalty rewards and loyalty coupons that loyalty points can be redeemed for.

Note: This module is in Developer Preview.

(May 31, 2023)

New Events for Wix Bookings v2

wix-bookings.v2

You can now handle events for when bookings are created, rescheduled, confirmed, declined, canceled, and for when the number of participants has been updated.

(May 30, 2023)

New Developer Preview API: Wix Bookings v2 Service Options and Variants

wix-bookings.v2

The new Wix Bookings v2 Service Options and Variants APIs provide functionality for retrieving and managing booking service options and variants. Functionality includes:

  • Getting service options and variants by ID and by service ID.
  • Querying service options and variants.
  • Creating and cloning service options and variants.
  • Updating and deleting service options and variants.
  • Backend events for create, update, and delete (CUD) operations.

Note: This module is in Developer Preview.

(May 22, 2023)

New Developer Preview API: Wix Data v2

wix-data.v2

The new Wix Data API, combined with the existing wix-data, provides a complete solution for accessing, organizing, configuring, and managing data stored in a Wix site's database. It includes the following submodules:

  • Data Collections: Create data collections and manage existing collections' structure.
  • Indexes: Create indexes for data collections, to make querying data faster.
  • External Database Connections: Connect an external database and manage it with Wix Data APIs.

Note: This module is in Developer Preview. To access and manage items in a Wix site's data collections, please use the existing wix-data.

(May 17, 2023)

New Feature: fields() function in Wix Data query

wix-data

A new feature in WixDataQuery provides more control over query results. Previously queries returned all fields of the selected result. Now, you can choose which fields your query returns using the new fields() function.

(May 17, 2023)

New Feature: Delete/Restore elements from the DOM

Wix Editor Elements ($w)

You can now delete and restore elements from the DOM.

A new deleted property has been added.
2 new functions have been added:

  • delete()
  • restore()

(May 17, 2023)

Migration of legacy APIs

In the past week, we've re-released a large number of legacy APIs. Behind the scenes, this is part of a large, cross-Wix effort to move all of our APIs to a new infrastructure.

This migration will allow us to release APIs more quickly after they're developed, and to align with established design patterns across all of Wix's APIs. This means you can get your hands on better, more consistent APIs, faster than before.

As always, we'll continue to support the legacy APIs, so your existing code will continue to work as it does today.

What's in this release

All the new modules are released as a developer preview and, unless otherwise mentioned, are universal modules.

Most of the APIs contain the same functionality as the previous version. In some rare cases, a regression was unavoidable. This list outlines the modules (and their respective namespaces) that were released, as well as any new or removed functionality as compared to the previous release:

wix-groups.v2:

  • JoinGroupRequests replaces JoinRequests.
  • Members:
    • members.queryMemberships() uses a different query syntax.
  • Roles is not available.
  • CreateRequests is not available.
  • Events: All events are new.

wix-stores.v2:

  • Inventory:
    • New: getInventoryVariants()
    • New: queryInventory() This function uses a different query syntax.
  • AbandonedCarts:
    • New: queryAbandonedCarts() This function uses a different query syntax.

wix.members.v2:

  • Badges:
    • New: getBadge()
    • New: getMemberCountsPerBadge()
    • New: listBadges()
    • New: updateBadgesDisplayOrder()
  • Events: All events are new.

wix.ecom.v2:

  • Currencies moved to wix-ecom.v2 from wix-pay.
    • listCurrencies() replaces getAllCurrencies().

wix-marketing.v2:

  • Coupons:
    • New: bulkCreateCoupons()
    • New: bulkDeleteCoupons()
    • New: getCoupon()
    • New: queryCoupons() This function uses a different query syntax.

wix-pricing-plans.v2

  • Plans:
    • All plan functions moved to wix-pricing-plans.v2 Plans from wix-pricing-plans-backend.
  • Orders:

    • managementGetOrder() replaces getOrder().

    • managementListOrders() replaces listOrders().

    • memberGetOrder() replaces getCurrentMemberOrder().

    • memberListOrders() replaces listCurrentMemberOrders().

    • requestCancellation() replaces requestCurrentMemberOrderCancellation()

    • createOfflineOrder() moved to Orders from Checkout.

    • getOfflineOrderPreview() moved to Orders and replaces previewOfflineOrder() from Checkout.

    • getPricePreview() moved to Orders and replaces previewPrice() from Checkout.

  • Checkout is not available.
  • Events:
    • onPlanPurchased() is not available.
    • onPlanUpdated() is not available.

(May 15, 2023)

New Bookings Custom Pricing Extension

SPI: wix-bookings

The new Wix Bookings Custom Pricing extension gives you the ability to customize pricing for bookings. Use the calculatePrice() SPI function to integrate your own custom pricing logic, such as varied pricing for weekend rates or use of special equipment, and so on. Learn more with this tutorial.

(May 17, 2023)

New Developer Preview API: Wix Currencies v2

wix-ecom.v2

The new Wix Currencies API provides functionality for getting exchange rates and converting between currencies.

This API is a newer version of Wix Pay's Currencies API.

Functionalities include:

  • Listing currencies supported on your site.
  • Getting the exchange rate between 2 currencies.
  • Converting amounts from 1 currency to another.

Note: This module is in Developer Preview.

(May 5, 2023)

New Article: Shareable Booking Form Links

wix-bookings

The Shareable Booking Form Links article explains how to use query parameters to create a custom shareable link to a Wix site's booking form page. This enables you to create a link to a Wix site's booking form page with preset values determined by you. (April 30, 2023)

New Modules for Wix Blocks Panels

Note: Wix Blocks is currently a Beta version, open to a limited number of users.

The wix-widget and wix-editor modules provide functionality for working with Blocks widgets from the Blocks Panel code.

  • Use wix-widget to control a widget's properties, Design Presets, and more.
  • Use wix-editor to remove or restore widget elements, open Dashboard panels, and more.

(April 24, 2023)

New: The $widget Namespace for Wix Blocks Widgets

Note: Wix Blocks is currently a Beta version, open to a limited number of users.

The $widget namespace contains functionality for working with your Blocks widget's API from within the widget code.

(April 24, 2023)

New: Blocks Panel Builder Elements

Note: Wix Blocks is currently a Beta version, open to a limited number of users.

The following elements can be added to Blocks Custom Panels and managed in the Blocks Panel Code:

  • PanelButton**
  • PanelCheckboxGroup**
  • PanelDropDown**
  • PanelRadioButtonGroup**
  • PanelRichText**
  • PanelSectionDivider**
  • PanelSlider**
  • PanelTextInput**
  • PanelThumbnails**
  • PanelToggleSwitch**

(April 24, 2023)

New Developer Preview API: Query Wix Extended Bookings

wix-bookings.v2

The new Wix Extended Bookings API provides functionality for querying bookings including additional details, such as attendance.

Note: This module is in Developer Preview.

(April 4, 2023)

New Developer Preview API: Wix Media v2

wix-media.v2

The new Wix Media API introduces functionality for managing files and folders in your site's Media Manager.

Functionality includes:

  • Importing, updating, and deleting media files
  • Getting and searching files
  • Generating file upload and download URLs
  • Creating, updating, and deleting folders in the Media Manager
  • Getting and searching folders

Note: This module is in Developer Preview.

(April 3, 2023)

New Developer Preview API: Wix Bookings Pricing

wix-bookings.v2

The new Wix Bookings Pricing API provides functionality for previewing and calculating pricing for bookings.

Functionality includes:

  • Previewing how much a booking will cost based on its line items.
  • Calculating how much a booking will cost based on either:
    • Standard pricing logic supplied with Wix Bookings.
    • Custom pricing logic you implement with the Pricing Integration REST Service Plugin.

Note: These modules are in Developer Preview.

(April 2, 2023)

End of Life: Wix Paid Plans and Wix Paid Plans Backend

wix-paid-plans, wix-paid-plans-backend

The deprecated wix-paid-plans and wix-paid-plans-backend APIs have been removed from the documentation. Their functionality is available in the wix-pricing-plans and wix-pricing-plans-backend APIs. Existing code containing these deprecated APIs will continue to work.

(March 27, 2023)

End of Life: Wix Users and Wix Users Backend

wix-users, wix-users-backend

The deprecated wix-users and wix-users-backend APIs have been removed from the documentation. Their functionality is available as noted below. Additionally, getPricingPlans() has moved to the Orders API as listCurrentMemberOrders(). Existing code containing these deprecated APIs will continue to work.

(March 27, 2023)

New Article: Shareable Booking Calendar Links

wix-bookings

The Shareable Booking Calendar Links article explains how to use query parameters to create a custom shareable link to a Wix site's booking calendar page. This enables you to create a link to a Wix site's booking calendar page with preset values you choose, or to create a link for rescheduling an existing booking. (Feb 12, 2023)

New Developer Preview API: Wix Email Marketing v2

wix-email-marketing.v2

The new Wix Email Marketing API provides functionality for managing your email marketing campaigns.

Functionalities include:

  • Getting your email marketing account details.
  • Getting a list of your email campaigns.
  • Pausing a scheduled campaign.
  • Sending a test email for preview purposes.
  • Getting a list of statistics for up to 100 selected campaigns.

Note: This module is in Developer Preview.

(February 5, 2023)

New APIs: Wix eCommerce Checkout

wix-ecom-backend

There are new APIs in the Wix eCommerce module.

The new APIs provide the following functionality:

  • Adding items to a checkout.
  • Marking a checkout as completed.
  • Removing the coupon from a checkout.
  • Removing the gift card from a checkout.
  • Removing line items from a checkout.

(January 26, 2022)

Platform update: Versions and universal modules

We've made 2 big changes to the Velo platform:

Versions:
Versions are now available for Velo modules. Modules from v2 and up include a version number in their names. Older versions of the modules are still available.

Universal modules:
New universal modules can be imported directly into any code file on your site. This means that you can import modules into public and page code without using web modules.

Learn more about versions and universal modules.

(January 19, 2023)

Platform update: Developer Preview APIs

Today we can announce that we've started releasing APIs with the new Developer Preview status!

Developer Preview APIs are available for testing, but they're under active development and may change at any time. For this reason, don't use Developer Preview APIs in production.

We want your feedback on the APIs in Developer Preview. Let us know about:

  • What you're using the API for.
  • Anything blocking you from using the API.
  • Additions and features you would find useful.
  • Bugs you've found in the API.

Please email us with your feedback.

For more information, see Developer Preview.

(January 19, 2023)

New Developer Preview API: Wix Sender Details v2

wix-sender-details.v2

The new Wix Sender Details API provides functionality for the information that's displayed as the sender's name and email address when sending an email from your Wix site.

Functionalities include:

  • Getting and updating your email sender details.
  • Verifying your sender email address.

Note: This module is in Developer Preview.

(January 25, 2023)

New Developer Preview API: Wix Loyalty v2

wix-loyalty.v2

The new Loyalty API provides functionality for:

  • Activating and managing a site’s loyalty program.
  • Creating new loyalty accounts.
  • Adjusting points in a loyalty account.

Note: This module is in Developer Preview.

(January 25, 2023)

New Developer Preview API: Wix Events v2

wix-events.v2

The new Wix Events v2 API provides functionality for:

  • Creating and managing events.
  • Creating the types of tickets available for an event using ticket definitions.
  • Creating ticket reservations using checkout.
  • Selling tickets.
  • Tracking orders.
  • Creating and managing policies.

Note: This module is in Developer Preview.

(January 25, 2023)

New Developer Preview API: Wix Bookings v2

wix-bookings.v2

The new Wix Bookings API provides functionality for:

  • Managing bookings, such as confirming, canceling, and rescheduling bookings.
  • Retrieving the availability of a calendar's slots for appointments and classes with the queryAvailability() function.

Note: This module is in Developer Preview.

(January 23, 2023)

New Developer Preview API: Wix Marketing Tags v2

wix-marketing-tags.v2

The new Wix Marketing Tags V2 API provides functionality for:

  • List marketing tags.
  • Create and update marketing tags.
  • Delete marketing tags.

Note: This module is in Developer Preview.

(January 23, 2023)

New Developer Preview API: Wix Activity Counters v2

wix-activity-counters.v2

The new Wix Activity Counters V2 API provides functionality for managing activity counters for site members.

Note: This module is in Developer Preview.

(January 23, 2023)

New Developer Preview API: Wix Inbox v2

wix-inbox.v2

The new Wix Inbox API introduces functionality for managing conversations and messages between you and your visitors, contacts, and members.

Note: This module is in Developer Preview.

(January 23, 2023)

New Developer Preview API: Wix Forum v2

wix-forum.v2

Use the new Forum API to get and query the following from your forum:

  • Posts
  • Categories

Note: This module is in Developer Preview.

(January 22, 2023)

New Developer Preview API: Wix Business Tools v2

wix-business-tools.v2

The new Wix Business Tools API provides functionality for managing a site’s business information. Currently it contains the Locations submodule, for managing a site’s business locations.

Note: This module is in Developer Preview.

(January 19, 2023)

New API: Wix Auth

wix-auth

The new Wix Auth API provides functionality for working with permissions. The elevate() function enables any site visitor to call a function without the required permissions. Note: This function replaces the suppressAuth option used in some functions. Check a function's reference documentation to see if elevate() is supported.

(January 16, 2023)

New API: Wix Pro Gallery Backend

wix-pro-gallery-backend

Use the new Pro Gallery Backend API to create and manage pro galleries on your site's backend. You can also create and manage media items in the pro galleries.

(January 11, 2023)

New API: Dataset onReadyAsync()

wix-dataset

You can now use the new promise-based onReadyAsync() function to load a dataset.

(January 10, 2023)

New API: Wix Blog

wix-blog-backend

Use the new Blog API to get, list, and query the following from your blog:

  • Posts
  • Categories
  • Tags

(December 22, 2022)

Update: Apply a coupon to specific billing cycles

wix-marketing-backend

The new discountCycleCount parameter allows you to apply the discount of a coupon, created with the createCoupon() function, to a specified amount of billing cycles.

(November 7, 2022)

New APIs: Menu and MenuContainer

Wix Editor Elements ($w)

The new Menu API and MenuContainer API allow you to customize your menu items by changing their labels, links, where the item opens, and if an item displays as selected. This includes using Velo to modify site menus in real time during the visitor's stay on your site.

Use the Menu API for the menu on your regular site and use the MenuContainer API for your mobile menu.

(October 19, 2022)

Update: Wix Data consistentRead property

wix-data

The new consistentRead property in the options parameter allows data retrieval functions to read from the primary database instance. This decreases performance but ensures data retrieved is up to date even immediately after the database is updated. See Wix Data and Eventual Consistency for more information.

(October 2, 2022)

New API: Section

Wix Editor Elements ($w)

The new Section API allows you to divide your page into meaningful segments. (September 28, 2022)

New API: Wix Events

Wix Editor Elements ($w)

The Wix Events element allows you to display your site's events. The element can be set to display a specific set of events or all the events in an event category. Use the categoryId property to dynamically change which event category to display. (September 20, 2022)

New API: Apply a coupon to a pricing plan order

wix-pricing-plans-backend

The new applyCoupon() function applies a coupon code to a draft order before it is purchased. (September 20, 2022)

New API: Tabs

Wix Editor Elements ($w)

The new Tabs Component allows users to display different content within one page without changing the URL and without the need to use code. With the Tabs API, you can reorder tabs or navigate between them using code. You can also define event handlers that run when tabs are navigated between or tab menu items are clicked. (September 20, 2022)

Updated: Members custom field structure

wix-members, wix-members-backend

The wix-members and wix-members-backend documentation has been updated to reflect that the member contactDetails.customField object contains key:object pairs, not key:value pairs as was previously written.

We also wrote additional guidance on working with custom fields.

(September 19, 2022)

New API: Pricing Plan Orders

wix-pricing-plans, wix-pricing-plans-backend

There are new APIs for managing pricing plan orders. The additions include order management functions both on the frontend and the backend, and more backend events.

The newly supported activities include:

  • Creating and updating both online and offline orders.
  • Purchasing orders.
  • Canceling orders.
  • Getting and listing orders.
  • Postponing, pausing, and resuming orders.
  • Marking offline orders as paid.

Please note the deprecation and migration instructions we added to the Paid Plans documentation. (August 28, 2022)

New Article: Wix Data Error Codes

wix-data

The Wix Data Error Codes article lists all the error codes you might encounter while using the Wix Data API. The article explains what causes the errors and what you can do to resolve them. (July 27, 2022)

New API: Lottie

Wix Editor Elements ($w)

With the new Lottie API, you can now add a Lottie element to your site and customize it. You can play(), pause(), and stop() your animation. You can also set the speed of your Lottie animation and whether it plays in a loop. (June 22, 2022)

New API: Check whether a member is logged in

wix-members

You can now check whether the current site visitor is a logged-in member by calling the new wix-members loggedIn() function. This allows you to quickly confirm a member is logged in before calling another function that requires a logged-in member. (June 21, 2022)

New API: Refine search fields

wix-search

You can now use the searchFields() function to refine a WixSearchBuilder to search only in specified collection fields. (May 30, 2022)

New API: Retrieve package configuration data

wix-configs-backend

When building a Velo package in Wix Blocks, you can use the getPackageConfig() function in your backend code to retrieve data from the package's config.json file. (April 14, 2022)

New API: Date Picker onViewChange()

Wix Editor Elements ($w)

You can now use the onViewChange() function to add an event handler that triggers when the date picker's view changes. (April 10, 2022)

New API: sendSetPasswordEmail() from the frontend

wix-members

You can now use the sendSetPasswordEmail() function from the frontend code to send a site member an email with a link to set, or reset, their password. (April 1, 2022)

New API: Button Icon

Wix Editor Elements ($w)

You can now set/get, expand, and collapse a button's icon in your code. The iconCollapsed property allows you to check if an icon is currently collapsed. (March 29, 2022)

New Feature: Show/Hide number spinner on textInput elements

Wix Editor Elements ($w)

You can now show and hide the number spinner on a textInput element when the element is for numeric input.

A new numberSpinnerHidden property has been added.
2 new functions have been added:

  • hideNumberSpinner()
  • showNumberSpinner()

(March 23, 2022)

New Event: Contact Merged

wix-crm-backend

You can now handle events when one or more source contacts are merged into a target contact.

A new originatedFrom property has also been introduced to the existing onContactUpdated() and onContactDeleted() events. When an update or delete event is triggered by a merge, metadata.originatedFrom is sent as "merge", allowing you to ignore redundant events.

(February 3, 2022)

New API: Delete files and folder from Media Manager

wix-media-backend

You can now use the Media Manager API to move files and folders to the Media Manager's trash bin.

(January 12, 2022)

New API: Date Picker API improvements

Wix Editor Elements ($w)

You can now use the Date Picker API to set date ranges. Use the enabledDateRanges property to set which dates a user can select. Use the disabledDateRanges property to set which dates users can't select.

(January 12, 2022)

New API: Set enabledTimes for Time Picker

Wix Editor Elements ($w)

You can now set the enabled times for a time slot using the enabledTimes property of the Time Picker API.

(December 29, 2021)

Update: Using forEachItem() with repeater data from a dataset