Introduction

 

Developer Preview
APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.

 

Wix Business Tools events are fired in your site's backend when certain events occur in your site's Business Tools application. You can write event handlers that react to these events. Event handler functions receive data that correspond to the event that has occurred. Use event handlers to create custom responses to events.

To add an event handler, add an events.js file to the Backend section of your site if one does not already exist. All event handler functions for your site are defined in this file.

Event handler functions are defined using the following pattern:

Copy

For example, an event handler that handles a location update looks like this:

Copy

Note: Backend events don't work when previewing your site.

Did this help?

onLocationArchiveStatus( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a location is archived.

Method Declaration
Copy
Method Parameters
eventLocationArchiveStatus

Contains information about the archived location and metadata for the event.

An event that triggers when a location is archived
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

onLocationCreated( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a location is created.

Method Declaration
Copy
Method Parameters
eventLocationCreated

Contains information about the created location and metadata for the event.

An event that triggers when a location is created
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

onLocationSetDefaultLocation( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a location is set as default.

Method Declaration
Copy
function wixLocations_onLocationSetDefaultLocation(
  event: LocationSetDefaultLocation,
): void;
Method Parameters
eventLocationSetDefaultLocation

Contains information about the new default location and metadata for the event.

An event that triggers when a location is set to be the default location
JavaScript
// Place this code in the events.js file
// of your site's Backend section.
// Add the file if it doesn't exist.

export function wixLocations_onLocationSetDefaultLocation(event) {
  const changeOfDefaultTime = event.metadata.eventTime;
  const oldDefault = event.data.prevDefaultLocationId;
  const newDefault = event.data.currDefaultLocationId;

  console.log(
    `Default location has been changed from location with id ${oldDefault} to location with id ${newDefault}. The change took place at ${changeOfDefaultTime}. Event details:`,
    event,
  );
}

/* Full event object:
 * {
 *   "metadata": {
 *     "entityId":"a636dae4-fdc9-4da8-9eef-7b0d23b34f22",
 *     "eventTime":"2023-11-13T09:01:28.564399Z",
 *     "id": "4d896c67-74f0-4103-86bd-db7b0cbded81",
 *     "triggeredByAnonymizeRequest":false
 *   },
 *   "data": {
 *     "currDefaultLocationId":"a636dae4-fdc9-4da8-9eef-7b0d23b34f22",
 *     "prevDefaultLocationId":"6a7a7356-a122-4de6-943c-3ea9e66f0d0a"
 *   }
 * }
 */
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?