Velo API Overview

Visit the Velo by Wix website to onboard and continue learning.

$w

This API contains everything you need in order to work with your site's components. It allows you to select elements on your site’s pages and interact with them. Each element type exposes properties and functions that you use to enhance the functionality of your site. The $w API can be used in your site’s front-end code. 

wix-animations-frontend

This API is used for working with animations. Animation sequences are composed using a timeline. A timeline defines what animations are played on which page elements and when those animations are played. You can synchronize multiple animations on matched elements, control them as a whole, and precisely manage their timing.

wix-billing-backend

This API is used for working with billing features, such as price quotes and invoices.

wix-blog-backend

This API is used for working with your site's blog. It provides the functionality for getting and querying posts, categories, and tags from a blog. The wix-blog-backend API can be used in your site's backend code.

wix-bookings-frontend

This API is used for working with services your site visitors can book. You can get information about available services and book services. The wix-bookings-frontend API can be used in your site's frontend code and in conjunction with the wix-bookings-backend API.

wix-bookings-backend

This API  is used to allow you to manage bookings, resources, sessions, and calendar functionality on your site. The wix-bookings-backend API can be used in your site's backend code and in conjunction with the wix-bookings-frontend API.

wix-captcha-backend

This API is used for working with the reCAPTCHA element from backend code. The reCAPTCHA element allows you to present a challenge-response test to site visitors to determine whether they are human or a bot. Use the reCAPTCHA element to verify that site visitors are human before allowing them to perform restricted operations.

wix-chat-backend

This API is used for working with the Wix Chat application from backend code. Using the backend Chat API, site owners and contributors (referred to as the site's "business") can exchange chat messages with site members, contacts, and visitors (referred to as "visitors").

The backend Chat API is not applicable to social chat. For social chat between site members, use the client-side Chat API.

wix-configs-backend

This API is used for working with user-configured data in Velo package code.  The wix-configs-backend API is intended for use when building Velo packages in Wix Blocks. The wix-configs-backend API can be used in your site's backend code.

wix-crm-frontend

This API is used for working with your site’s contacts. You can create a new contact and email a newly created contact. The wix-crm-frontend API can be used in your site's frontend code.

wix-crm-backend

This API is used for working with your site’s contacts. You can create a new contact and email a newly created contact. You can also manage tasks, workflows, and notifications. The wix-crm-backend API can be used in your site's backend code.

wix-data

This API is used for working with your site’s database collections. It gives you direct access to your collections, allowing you to perform any data operations for querying and editing collection content. You can also add hooks that run code before or after certain interactions with your site’s collections, whether or not those interactions were initiated by the wix-data API. The wix-data API can be used in your site’s frontend or backend code.

wix-dataset

This API is used for working with your site’s database collections through a dataset. A dataset is an invisible page element that serves as an intermediary between a page’s elements and the data in a collection. The wix-dataset API can be used in your site’s frontend code.

wix-ecom-backend

This API allows you to create, manage, and retrieve three elements of the eCommerce purchase flow: cart, checkout, and order. The wix-ecom-backend API can be used in your site's backend code.

wix-events-frontend

This API is used for working with Wix Events from frontend code. You can use the wix-events-frontend API to create a custom RSVP form and to offer tickets for your events. The wix-events-frontend API can be used in your site's frontend code and in conjunction with the wix-events-backend API.

wix-events-backend

This API provides functionality for creating, updating, and managing your site's Wix events. The wix-events-backend API can be used in your site's backend code and in conjunction with the wix-events-frontend API.

wix-fetch

This API is an implementation of the standard JavaScript Fetch API, which is used for fetching resources from 3rd party services using HTTPS. The wix-fetch API can be used in your site’s frontend or backend code.

wix-forum-backend

This API contains functionality for working with your site’s forum.  The wix-forum-backend API allows you to write event handlers that react to events fired in the backend when certain changes occur in your forum.

wix-groups-backend

This API is used for managing groups on your site. The wix-groups-backend API manages groups from your site’s backend code. This includes adding, removing, and listing group members and assigning roles to members of a group. 

wix-http-functions

This API is used to create an API for your site that exposes its functionality as a service. That means other people can use the functionality of your site by writing code that calls your site's API. The wix-http-functions API can be used in your site’s backend code in the http-functions.js file.

wix-location-frontend

This API is used for getting information about the URL of the current page and for navigating to other pages. The wix-location-frontend API can be used in your site’s front-end code.

wix-marketing-backend

This API is used for working with your site's marketing tools from backend code.

wix-media-backend

This API is used for working with media from backend code. You can use the wix-media-backend API to upload and download files and folders, to delete files and folders, and more.

wix-members-frontend

This API is used to allow you to manage member access to your site as well as view and manage the currently logged-in member. You can get information about the current member, prompt a member to log in, and log out the current member. The wix-members-frontend API can be used in your site’s frontend code.

wix-members-backend

This API is used to allow you to manage member access to your site as well as view and manage site members.  The wix-members-backend API can be used in your site's backend code. 

wix-pay-frontend

This API is used for processing payments. The wix-pay-frontend API can be used in your site’s frontend code. It is used in conjunction with the wix-pay-backend API.

wix-pay-backend

This API is used for processing payments. The wix-pay-backend API can be used in your site’s backend code. It is used in conjunction with the wix-pay-frontend API.

wix-pricing-plans-frontend

This API is used to build a customized membership plan experience. You can use it to:

  • Get information about pricing plans.
  • Let site members order a plan directly, as if they were using the Pricing Plans app.
  • Let site members order a plan using your own customized process.
  • Let site members cancel orders that they have purchased.

The wix-pricing-plans-frontend API can be used in your site’s frontend code. It is used in conjunction with the wix-pricing-plans-backend API.

wix-pricing-plans-backend

This API is used for creating and managing pricing plans in the backend. Using the pricing plans APIs you can create, update, list, query, and archive pricing plans. You can also set which plans are public, set the primary plan, get statistics about plans, and rearrange the order of how plans display in the Dashboard. The wix-pricing-plans-backend API can be used in your site’s backend code. It is used in conjunction with the wix-pricing-plans-frontend API.

wix-realtime-frontend

This API is used for publishing messages on channels that site visitors can subscribe to. Using the Realtime API you can create channels and channel resources where messages can be published. Site visitors who subscribe to a channel receive the messages published to that channel. When a message is received you can handle the message any way you choose, such as displaying the contents of the message or changing the state of page elements depending on the contents of the message. You can also manage the permissions of who can read from specific channels. The wix-realtime-frontend API can be used in your site’s frontend code. It is used in conjunction with the wix-realtime-backend API.

wix-realtime-backend

This API is used for publishing messages on channels that site visitors can subscribe to and for managing channel permissions. Using the Realtime API you can create channels and channel resources where messages can be published. Site visitors who subscribe to a channel receive the published messages published to that channel. You can also manage the permissions of who can read from specific channels. The wix-realtime-backend API can be used in your site’s backend code. It is used in conjunction with the wix-realtime-frontend API.

wix-router

This API is used for creating routers and adding hooks to data binding routers. A router allows you to take complete control of handling incoming requests to your site that have a specific prefix in their URLs. You create a router in the editor and use the functions and objects of this API to define its behavior. You can also add hooks to intercept the process of the data getting bound to your dynamic pages and insert additional logic. The wix-router API can be used in your site’s backend code in the routers.js file.

This API is used for searching a site. The wix-search API allows you to create a custom site search experience for your site visitors. For example, you can use a text input element to get a search phrase from site visitors, and use a repeater to display the results of a search.

wix-secrets-backend

This API is used for retrieving secrets you safely store in your site's Secrets Manager. The Secrets Manager allows you to store and encrypt API keys and other secrets on your site. With the Secrets API, you can safely work with secrets in your backend code.

wix-seo-frontend

This API is used for working with your site's SEO from frontend code. 

wix-site-frontend

This API is used for getting information about your site’s structure. The wix-site-frontend API can be used in your site’s frontend code. It is used in conjunction with the wix-site-backend API.

wix-site-backend

This API is used for getting information about your site. The wix-site-backend API can be used in your site’s backend code. It is used in conjunction with the wix-site-frontend API.

wix-storage-frontend

This API is used for the persistent storage of key/value data in the site visitor's browser. You can store local data that never expires or session data that is available while the visitor’s web session is still active. The wix-storage-frontend API can be used in your site’s frontend code.

wix-stores-frontend

This API is used for getting information from your site's store. The wix-stores-frontend API can be used in your site’s frontend code. It is used in conjunction with the wix-stores-backend API.

wix-stores-backend

This API is used for getting information from your site's store. The wix-stores-backend API can be used in your site’s backend code. It is used in conjunction with the wix-stores-frontend API.

wix-window-frontend

This API is used for working with the current visitor’s browser window. You can get information such as whether the visitor is on a mobile browser, the size of the browser window, and the locale of the visitor’s environment. You can also perform actions like opening lightboxes and scrolling the page. The wix-window-frontend API can be used in your site’s frontend code.

Was this helpful?
Yes
No