Introduction

Wix Events events are fired on your site's backend when certain actions occur to Wix Events. You can write event handlers that react to these events. Event handler functions receive data that corresponds to the event that fired. Use event handlers to create custom responses to Wix Events events.

To add an activity counters 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 the event cancellation looks like this:

Copy

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

Did this help?

onGuestCreated( )

A backend event that fires when a Guest is created.

The onGuestCreated() event handler runs when a Guest is created on your site. The received GuestCreated object contains information about the new guest.

Note: Backend events are not fired when previewing your site.

Method Declaration
Copy
function wixEventsGuests_onGuestCreated(event: GuestCreated): void;
Method Parameters
eventGuestCreated

Information about the created guest and onGuestCreated event.

A backend event that occurs when a guest is created
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 wixEventsGuests_onGuestCreated(event) {
  const eventId = event.metadata.id;
  const entityId = event.entity._id;
}

/* Full guest object:
{
 "metadata": {
   "id": "02459af3-da70-4173-a607-65678e99ef30",
   "entityId": "afda7995-72d0-4d58-9ba4-3f6c5213c35c",
   "eventTime": "2023-04-19T12:39:05.690213Z",
   "triggeredByAnonymizeRequest": false
 },
 "entity": {
   "_id": "afda7995-72d0-4d58-9ba4-3f6c5213c35c",
   "eventId": "3d3d5c04-ece0-45a8-85f0-11a58edaa192",
   "orderNumber": "2TFG-RXPW-00Z",
   "tickets": [
     {
       "number": "2TFG-RXPW-00Z1P",
       "definitionId": "9b5b5cc0-b017-49d1-a59c-81c7cff580a6",
       "name": "Participant Ticket"
     }
   ],
   "contactId": "023b6403-17e6-42dc-b475-a5ae6c2b8df4",
   "guestDetails": {
     "email": "john.doe@mail.com",
     "firstName": "John",
     "lastName": "Doe",
     "formResponse": {
       "inputValues": [
         {
           "inputName": "firstName",
           "value": "John",
           "values": []
         },
         {
           "inputName": "lastName",
           "value": "Doe",
           "values": []
         },
         {
           "inputName": "email",
           "value": "john.doe@mail.com",
           "values": []
         }
       ]
     },
     "checkedIn": false
   },
   "attendanceStatus": "ATTENDING",
   "_createdDate": "2023-04-19T12:39:05.561Z",
   "_updatedDate": "2023-04-19T12:39:05.602Z",
   "attendanceStatusUpdatedDate": "2023-04-19T12:39:05.424Z",
   "guestType": "BUYER"
 }
}
*/
Errors

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

Did this help?

onGuestDeleted( )

A backend event that fires when a Guest is deleted.

The onGuestDeleted() event handler runs when a Guest is deleted from your site. The received GuestDeleted object contains information about the deleted guest.

Note: Backend events are not fired when previewing your site.

Method Declaration
Copy
function wixEventsGuests_onGuestDeleted(event: GuestDeleted): void;
Method Parameters
eventGuestDeleted

Information about the onGuestDeleted event.

A backend event that occurs when a guest is deleted
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 wixEventsGuests_onGuestDeleted(event) {
  const eventId = event.metadata.id;
  const entityId = event.entity._id;
}

/* Full guest object:
{
 "metadata": {
   "id": "f9325e7a-1875-424f-8fdb-83edb03a4f7a",
   "entityId": "984476a1-8a92-455a-863c-bf1efc816f7e",
   "eventTime": "2023-04-19T13:23:04.892039Z",
   "triggeredByAnonymizeRequest": false
 }
}
*/
Errors

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

Did this help?

onGuestUpdated( )

A backend event that fires when a Guest is updated.

The onGuestUpdated() event handler runs when a Guest is updated from your site. The received GuestUpdated object contains information about the updated guest.

Note: Backend events are not fired when previewing your site.

Method Declaration
Copy
function wixEventsGuests_onGuestUpdated(event: GuestUpdated): void;
Method Parameters
eventGuestUpdated

Information about the updated guest and onGuestUpdated event.

A backend event that occurs when a guest is updated
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 wixEventsGuests_onGuestUpdated(event) {
  const eventId = event.metadata.id;
  const entityId = event.entity._id;
}

/* Full guest object
{
 "metadata": {
   "id": "2224535e-a4dd-476e-ac0e-4adb11cae9c7",
   "entityId": "afda7995-72d0-4d58-9ba4-3f6c5213c35c",
   "eventTime": "2023-04-19T12:39:05.640423Z",
   "triggeredByAnonymizeRequest": false
 },
 "entity": {
   "_id": "afda7995-72d0-4d58-9ba4-3f6c5213c35c",
   "eventId": "3d3d5c04-ece0-45a8-85f0-11a58edaa192",
   "orderNumber": "2TFG-RXPW-00Z",
   "tickets": [
     {
       "number": "2TFG-RXPW-00Z1P",
       "definitionId": "9b5b5cc0-b017-49d1-a59c-81c7cff580a6",
       "name": "Participant Ticket"
     }
   ],
   "contactId": "023b6403-17e6-42dc-b475-a5ae6c2b8df4",
   "guestDetails": {
     "email": "john.doe@mail.com",
     "firstName": "John",
     "lastName": "Doe",
     "formResponse": {
       "inputValues": [
         {
           "inputName": "firstName",
           "value": "John",
           "values": []
         },
         {
           "inputName": "lastName",
           "value": "Doe",
           "values": []
         },
         {
           "inputName": "email",
           "value": "john.doe@mail.com",
           "values": []
         }
       ]
     },
     "checkedIn": false
   },
   "attendanceStatus": "ATTENDING",
   "_createdDate": "2023-04-19T12:39:05.561Z",
   "_updatedDate": "2023-04-19T12:39:05.602Z",
   "attendanceStatusUpdatedDate": "2023-04-19T12:39:05.424Z",
   "guestType": "BUYER"
 }
}
*/
Errors

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

Did this help?

onPolicyCreated( )

A backend event that fires when a Policy is created.

The onPolicyCreated() event handler runs when a Policy is created in your site. The received PolicyCreated object contains information about the new policy.

Note: Backend events are not fired when previewing your site.

Method Declaration
Copy
function wixEvents_onPolicyCreated(event: PolicyCreated): void;
Method Parameters
eventPolicyCreated

Information about the created policy and onPolicyCreated event.

A backend event that occurs when a policy is created
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 wixEvents_onPolicyCreated(event) {
  const eventId = event.metadata.id;
  const entityId = event.entity._id;
}

/* Full policy object:
{
 "metadata": {
   "id": "f3d62dd6-db0c-445a-9bd5-aa0e0e06cd44",
   "entityId": "370ee789-5a2d-4e48-b2cf-adaf8a54c52e",
   "eventTime": "2023-03-08T11:04:53.171829Z",
   "triggeredByAnonymizeRequest": false
 },
 "entity": {
   "_id": "370ee789-5a2d-4e48-b2cf-adaf8a54c52e",
   "revision": "1",
   "_createdDate": "2023-03-08T11:04:53.166Z",
   "_updatedDate": "2023-03-08T11:04:53.166Z",
   "name": "Terms and Conditions Event 1",
   "body": "Tickets to this Event are issued on behalf of the Organiser and are subject to the following terms and conditions.",
   "eventId": "9d720f99-1b5a-4141-9877-d32985391e18"
 }
}
*/
Errors

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

Did this help?

onPolicyDeleted( )

A backend event that fires when a Policy is deleted.

The onPolicyDeleted() event handler runs when a Policy is deleted in your site. The received PolicyDeleted object contains information about the deleted policy.

Note: Backend events are not fired when previewing your site.

Method Declaration
Copy
function wixEvents_onPolicyDeleted(event: PolicyDeleted): void;
Method Parameters
eventPolicyDeleted

Information about the onPolicyDeleted event.

A backend event that occurs when a policy is deleted
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 wixEvents_onPolicyDeleted(event) {
  const eventId = event.metadata.id;
  const entityId = event.entity._id;
}

/* Full policy object:
{
 "metadata": {
   "id": "4ef5a02f-5263-48d9-9ed6-01e90c2ebeb0",
   "entityId": "c416e5a2-4518-4765-9cf0-b0d980f45a16",
   "eventTime": "2023-03-08T11:51:58.371593Z",
   "triggeredByAnonymizeRequest": false
 }
}
*/
Errors

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

Did this help?

onPolicyUpdated( )

A backend event that fires when a Policy is updated.

The onPolicyUpdated() event handler runs when a Policy is updated in your site. The received PolicyUpdated object contains information about the updated policy.

Note: Backend events are not fired when previewing your site.

Method Declaration
Copy
function wixEvents_onPolicyUpdated(event: PolicyUpdated): void;
Method Parameters
eventPolicyUpdated
A backend event that occurs when a policy is updated
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 wixEvents_onPolicyUpdated(event) {
  const eventId = event.metadata.id;
  const entityId = event.entity._id;
}

/* Full policy object:
{
 "metadata": {
   "id": "76d05dfc-15bd-4203-b9b4-64d82edc833c",
   "entityId": "52f15c5c-ea06-44f4-866a-b1cfa6f4f790",
   "eventTime": "2023-03-08T11:31:57.454388Z",
   "triggeredByAnonymizeRequest": false
 },
 "entity": {
   "_id": "52f15c5c-ea06-44f4-866a-b1cfa6f4f790",
   "revision": "4",
   "_createdDate": "2023-03-07T14:15:44.312Z",
   "_updatedDate": "2023-03-08T11:31:57.443Z",
   "name": "Terms and Conditions Event 1",
   "body": "If the Event is rescheduled, changed, moved or cancelled the Organiser cannot be held responsible for any resulting costs you may incur for travel, accommodation and other related goods, services or compensation.",
   "eventId": "3d3d5c04-ece0-45a8-85f0-11a58edaa192"
 }
}
*/
Errors

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

Did this help?

onEventCanceled( )

Developer Preview

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

Method Declaration
Copy
function wixEventsV3_onEventCanceled(event: EventCanceled): void;
Method Parameters
eventEventCanceled
onEventCanceled example
JavaScript
export function wixEventsV3_onEventCanceled(event) {
  const eventId = event.metadata.id;
  const entityId = event.data.event._id;
}
Errors

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

Did this help?