onEventReminder( )

A backend event that fires when a Wix event's reminders are sent.

The onEventReminder() event handler runs when a Wix event is set to have a reminder and the time of the reminder arrives. The received EventReminder object contains information about the event.

Configure when the reminder is sent in the site dashboard.

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

Method Declaration
Copy
function onEventReminder(event: EventReminder): void;
Method Parameters
eventEventReminderRequired

Information about the event that the reminder was sent for.

A backend event that occurs when a Wix event's reminders are sent
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_onEventReminder(event) {
  let eventId = event.eventId;
  let title = event.title;
}

/*  Full event object:
 *  {
 *    "timestamp": "2020-04-26T13:57:50.699Z",
 *    "eventId": "46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b",
 *    "location": {
 *      "name": "Wix Playground",
 *      "coordinates": {
 *        "lat": 40.739254,
 *        "lng": -74.008925
 *      },
 *      "address": "100 Gansevoort St, New York, NY 10014, USA",
 *      "type": "VENUE"
 *    },
 *    "scheduleConfig": {
 *      "scheduleTbd": false,
 *      "scheduleTbdMessage": "",
 *      "startDate": "2020-05-10T16:00:00.000Z",
 *      "endDate": "2020-05-10T20:00:00.000Z",
 *      "timeZoneId": "EST"
 *    },
 *    "title": "My event",
 *    "userId": "01cb99e2-e969-421a-b65f-43bea2a66fa1",
 *    "startsIn": {
 *      "days": 3,
 *      "hours": 0,
 *      "minutes": 0
 *    }
 *  }
 */
Did this help?

onEventStarted( )

A backend event that fires when a Wix event starts.

The onEventStarted() event handler runs when a Wix event starts. The received StartedEvent object contains information about the started event.

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

Method Declaration
Copy
function onEventStarted(event: StartedEvent): void;
Method Parameters
eventStartedEventRequired

Information about the event that has started.

A backend event that occurs when a Wix event starts
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_onEventStarted(event) {
  let eventId = event.eventId;
  let title = event.title;
}

/*  Full event object:
 *  {
 *    "timestamp": "2020-04-26T13:57:50.699Z",
 *    "eventId": "46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b"
 *  }
 */
Did this help?

onEventUpdated( )

A backend event that fires when an existing Wix event is updated.

The onEventUpdated() event handler runs when an existing Wix event is updated. The received UpdatedEvent object contains information about the event that was updated.

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

Method Declaration
Copy
function onEventUpdated(event: UpdatedEvent): void;
Method Parameters
eventUpdatedEventRequired

Information about the event that was updated.

A backend event that occurs when an existing Wix event 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_onEventUpdated(event) {
  let eventId = event.eventId;
  let title = event.title;
}

/*  Full event object:
 *  {
 *    "timestamp": "2020-04-26T13:57:50.699Z",
 *    "eventId": "46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b",
 *    "location": {
 *      "name": "Wix Playground",
 *      "coordinates": {
 *        "lat": 40.739254,
 *        "lng": -74.008925
 *      },
 *      "address": "100 Gansevoort St, New York, NY 10014, USA",
 *      "type": "VENUE"
 *    },
 *    "scheduleConfig": {
 *      "scheduleTbd": false,
 *      "scheduleTbdMessage": "",
 *      "startDate": "2020-05-10T16:00:00.000Z",
 *      "endDate": "2020-05-10T20:00:00.000Z",
 *      "timeZoneId": "EST"
 *    },
 *    "title": "My event",
 *    "scheduleConfigUpdated": true
 *  }
 */
Did this help?

onOrderConfirmed( )

A backend event that fires when a ticket order is confirmed.

The onOrderConfirmed() event handler runs when a ticket order is confirmed. The received OrderConfirmedEvent object contains information about the confirmed ticket order.

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

Method Declaration
Copy
function onOrderConfirmed(event: OrderConfirmedEvent): void;
Method Parameters
eventOrderConfirmedEventRequired

Information about the ticket order that was confirmed.

A backend event that occurs when a ticket order is confirmed
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_onOrderConfirmed(event) {
  let eventId = event.eventId;
  let orderNumber = event.orderNumber;
  let status = event.status;

  let buyerFirstName = event.firstName;
  let buyerLastName = event.lastName;
  let buyerEmail = event.email;

  let invoice = event.invoice;
  let grandTotal = invoice.grandTotal;

  let tickets = event.tickets;
  let firstTicket = tickets[0];
  let secondTicket = tickets[1];
}

/*  Full event object:
 *  {
 *    "timestamp": "2020-04-28T12:23:57.154Z",
 *    "eventId": "566e7be9-1410-4095-ae7a-349a4ac95c6b",
 *    "orderNumber": "FMXC-BZG3-OT",
 *    "contactId": "eea3ac0f-f9e6-4ed3-a135-99743c8e90b8",
 *    "memberId": "b272b0bb-d013-415a-8461-e8a175fe8dc6",
 *    "created": "2020-04-28T12:23:51.523Z",
 *    "firstName": "John",
 *    "lastName": "Doe",
 *    "email": "john.doe@somedomain.com",
 *    "status": "PAID",
 *    "method": "payPal",
 *    "checkoutForm": {
 *      "inputValues": [
 *        {
 *          "inputName": "firstName",
 *          "value": "John",
 *          "values": []
 *        },
 *        {
 *          "inputName": "lastName",
 *          "value": "Doe",
 *          "values": []
 *        },
 *        {
 *          "inputName": "email",
 *          "value": "john.doe@somedomain.com",
 *          "values": []
 *        }
 *      ]
 *    },
 *    "tickets": [
 *      {
 *        "ticketNumber": "FMXC-BZG3-OT021",
 *        "ticketDefinitionId": "d72874cb-012a-4ad2-afbb-57fe8cf1e308",
 *        "price": {
 *          "amount": "123.00",
 *          "currency": "USD"
 *        },
 *        "firstName": "John",
 *        "lastName": "Doe",
 *        "email": "john.doe@somedomain.com",
 *        "contactId": "eea3ac0f-f9e6-4ed3-a135-99743c8e90b8",
 *        "memberId": "b272b0bb-d013-415a-8461-e8a175fe8dc6",
 *        "confirmed": true,
 *        "form": {
 *          "inputValues": [
 *            {
 *              "inputName": "custom",
 *              "value": "Another comment",
 *              "values": []
 *            },
 *            {
 *              "inputName": "email",
 *              "value": "john.doe@somedomain.com",
 *              "values": []
 *            },
 *            {
 *              "inputName": "lastName",
 *              "value": "Doe",
 *              "values": []
 *            },
 *            {
 *              "inputName": "firstName",
 *              "value": "John",
 *              "values": []
 *            },
 *            {
 *              "inputName": "date",
 *              "value": "2020-04-28",
 *              "values": []
 *            },
 *            {
 *              "inputName": "comment",
 *              "value": "Comment",
 *              "values": []
 *            },
 *            {
 *              "inputName": "address",
 *              "value": "",
 *              "values": [
 *                "Wix Playground, 100 Gansevoort St",
 *                "New York City",
 *                "New York",
 *                "USA",
 *                "NY 10014"
 *              ]
 *            },
 *            {
 *              "inputName": "phone",
 *              "value": "(555) 555-1234",
 *              "values": []
 *            }
 *          ]
 *        }
 *      },
 *      {
 *        "ticketNumber": "FMXC-BZG3-OT041",
 *        "ticketDefinitionId": "9c3dc432-f1a6-408f-82d8-4f64c7ff581b",
 *        "price": {
 *          "amount": "0.00",
 *          "currency": "USD"
 *        },
 *        "firstName": "Jane",
 *        "lastName": "Doe",
 *        "email": "jane.doe@somedomain.com",
 *        "contactId": "e11af3d4-c205-4d3a-b687-58d4dda78a6c",
 *        "memberId": "62bc4004-548c-46ad-a699-55ef307273e3",
 *        "confirmed": true,
 *        "form": {
 *          "inputValues": [
 *            {
 *              "inputName": "custom",
 *              "value": "Another comment",
 *              "values": []
 *            },
 *            {
 *              "inputName": "email",
 *              "value": "jane.doe@somedomain.com",
 *              "values": []
 *            },
 *            {
 *              "inputName": "lastName",
 *              "value": "Doe",
 *              "values": []
 *            },
 *            {
 *              "inputName": "firstName",
 *              "value": "Jane",
 *              "values": []
 *            },
 *            {
 *              "inputName": "date",
 *              "value": "2020-04-28",
 *              "values": []
 *            },
 *            {
 *              "inputName": "comment",
 *              "value": "Comment",
 *              "values": []
 *            },
 *            {
 *              "inputName": "address",
 *              "value": "",
 *              "values": [
 *                "Wix Playground, 100 Gansevoort St",
 *                "New York City",
 *                "New York",
 *                "USA",
 *                "NY 10014"
 *              ]
 *            },
 *            {
 *              "inputName": "phone",
 *              "value": "(555) 555-1234",
 *              "values": []
 *            }
 *          ]
 *        }
 *      }
 *    ],
 *    "invoice": {
 *      "items": [
 *        {
 *          "id": "d72874cb-012a-4ad2-afbb-57fe8cf1e308",
 *          "quantity": 1,
 *          "name": "VIP",
 *          "price": {
 *            "amount": "123.00",
 *            "currency": "USD"
 *          },
 *          "total": {
 *            "amount": "123.00",
 *            "currency": "USD"
 *          },
 *          "fees": [
 *            {
 *              "type": "FEE_INCLUDED",
 *              "rate": "2.5",
 *              "amount": {
 *                "amount": "3.08",
 *                "currency": "USD"
 *              }
 *            }
 *          ]
 *        },
 *        {
 *          "id": "9c3dc432-f1a6-408f-82d8-4f64c7ff581b",
 *          "quantity": 1,
 *          "name": "Free",
 *          "price": {
 *            "amount": "0.00",
 *            "currency": "USD"
 *          },
 *          "total": {
 *            "amount": "0.00",
 *            "currency": "USD"
 *          },
 *          "fees": [
 *            {
 *              "rate": "2.5",
 *              "amount": {
 *                "amount": "0.00",
 *                "currency": "USD"
 *              }
 *            }
 *          ]
 *        }
 *      ],
 *      "fees": [
 *        {
 *          "rate": "2.5",
 *          "amount": {
 *            "amount": "0.00",
 *            "currency": "USD"
 *          }
 *        },
 *        {
 *          "type": "FEE_INCLUDED",
 *          "rate": "2.5",
 *          "amount": {
 *            "amount": "3.08",
 *            "currency": "USD"
 *          }
 *        }
 *      ],
 *      "subTotal": {
 *        "amount": "123.00",
 *        "currency": "USD"
 *      },
 *      "grandTotal": {
 *        "amount": "123.00",
 *        "currency": "USD"
 *      },
 *      "revenue": {
 *        "amount": "119.92",
 *        "currency": "USD"
 *      }
 *    }
 *  }
 */
Did this help?

onOrderDeleted( )

A backend event that fires when a ticket order is deleted.

The onOrderDeleted() event handler runs when a ticket order is deleted. The received OrderDeletedEvent object contains information about the deleted order.

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

Method Declaration
Copy
function onOrderDeleted(event: OrderDeletedEvent): void;
Method Parameters
eventOrderDeletedEventRequired

Information about the ticket order that was deleted.

A backend event that occurs when a ticket order 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_onOrderDeleted(event) {
  let eventId = event.eventId;
  let orderNumber = event.orderNumber;
}

/*  Full event object:
 *  {
 *    "timestamp": "2020-04-28T12:24:29.768Z",
 *    "eventId": "566e7be9-1410-4095-ae7a-349a4ac95c6b",
 *    "orderNumber": "FMXC-BZG3-OT",
 *    "contactId": "eea3ac0f-f9e6-4ed3-a135-99743c8e90b8",
 *    "memberId": "b272b0bb-d013-415a-8461-e8a175fe8dc6",
 *    "anonymized": true,
 *    "orderType": "ASSIGNED_TICKETS"
 *  }
 */
Did this help?

onOrderInitiated( )

A backend event that fires when a ticket order is initiated.

The onOrderInitiated() event handler runs when a ticket order is initiated. The received OrderInitiatedEvent object contains information about the initiated ticket order.

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

Method Declaration
Copy
function onOrderInitiated(event: OrderInitiatedEvent): void;
Method Parameters
eventOrderInitiatedEventRequired

Information about the ticket order that was initiated.

A backend event that occurs when a ticket order is initiated
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_onOrderInitiated(event) {
  let eventId = event.eventId;
  let orderNumber = event.orderNumber;
  let status = event.status;

  let buyerFirstName = event.firstName;
  let buyerLastName = event.lastName;
  let buyerEmail = event.email;

  let invoice = event.invoice;
  let grandTotal = invoice.grandTotal;
}

/*  Full event object:
 *  {
 *    "timestamp": "2020-04-28T12:23:51.523Z",
 *    "eventId": "566e7be9-1410-4095-ae7a-349a4ac95c6b",
 *    "orderNumber": "FMXC-BZG3-OT",
 *    "firstName": "John",
 *    "lastName": "Doe",
 *    "email": "john.doe@somedomain.com",
 *    "status": "INITIATED",
 *    "checkoutForm": {
 *      "inputValues": [
 *        {
 *          "inputName": "firstName",
 *          "value": "John",
 *          "values": []
 *        },
 *        {
 *          "inputName": "lastName",
 *          "value": "Doe",
 *          "values": []
 *        },
 *        {
 *          "inputName": "email",
 *          "value": "john.doe@somedomain.com",
 *          "values": []
 *        }
 *      ]
 *    },
 *    "invoice": {
 *      "items": [
 *        {
 *          "id": "d72874cb-012a-4ad2-afbb-57fe8cf1e308",
 *          "quantity": 1,
 *          "name": "VIP",
 *          "price": {
 *            "amount": "123.00",
 *            "currency": "USD"
 *          },
 *          "total": {
 *            "amount": "123.00",
 *            "currency": "USD"
 *          },
 *          "fees": [
 *            {
 *              "type": "FEE_INCLUDED",
 *              "rate": "2.5",
 *              "amount": {
 *                "amount": "3.08",
 *                "currency": "USD"
 *              }
 *            }
 *          ]
 *        },
 *        {
 *          "id": "9c3dc432-f1a6-408f-82d8-4f64c7ff581b",
 *          "quantity": 1,
 *          "name": "Free",
 *          "price": {
 *            "amount": "0.00",
 *            "currency": "USD"
 *          },
 *          "total": {
 *            "amount": "0.00",
 *            "currency": "USD"
 *          },
 *          "fees": [
 *            {
 *              "rate": "2.5",
 *              "amount": {
 *                "amount": "0.00",
 *                "currency": "USD"
 *              }
 *            }
 *          ]
 *        }
 *      ],
 *      "fees": [
 *        {
 *          "rate": "2.5",
 *          "amount": {
 *            "amount": "0.00",
 *            "currency": "USD"
 *          }
 *        },
 *        {
 *          "type": "FEE_INCLUDED",
 *          "rate": "2.5",
 *          "amount": {
 *            "amount": "3.08",
 *            "currency": "USD"
 *          }
 *        }
 *      ],
 *      "subTotal": {
 *        "amount": "123.00",
 *        "currency": "USD"
 *      },
 *      "grandTotal": {
 *        "amount": "123.00",
 *        "currency": "USD"
 *      },
 *      "revenue": {
 *        "amount": "119.92",
 *        "currency": "USD"
 *      }
 *    }
 *  }
 */
Did this help?

onOrderUpdated( )

A backend event that fires when a ticket order is updated.

The onOrderUpdated() event handler runs when a ticket order is updated. The received OrderUpdatedEvent object contains information about the updated ticket order.

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

Method Declaration
Copy
function onOrderUpdated(event: OrderUpdatedEvent): void;
Method Parameters
eventOrderUpdatedEventRequired

Information about the ticket order that was 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_onOrderUpdated(event) {
  let eventId = event.eventId;
  let orderNumber = event.orderNumber;
  let status = event.status;

  let buyerFirstName = event.firstName;
  let buyerLastName = event.lastName;
  let buyerEmail = event.email;

  let invoice = event.invoice;
  let grandTotal = invoice.grandTotal;

  let tickets = event.tickets;
  let firstTicket = tickets[0];
  let secondTicket = tickets[1];
}

/*  Full event object:
 *  {
 *    "timestamp": "2020-04-28T12:24:29.768Z",
 *    "eventId": "566e7be9-1410-4095-ae7a-349a4ac95c6b",
 *    "orderNumber": "FMXC-BZG3-OT",
 *    "contactId": "eea3ac0f-f9e6-4ed3-a135-99743c8e90b8",
 *    "memberId": "b272b0bb-d013-415a-8461-e8a175fe8dc6",
 *    "created": "2020-04-28T12:23:51.523Z",
 *    "firstName": "John",
 *    "lastName": "Doe",
 *    "email": "john.doe@somedomain.com",
 *    "confirmed": true,
 *    "status": "PAID",
 *    "method": "payPal",
 *    "archived": false,
 *    "checkoutForm": {
 *      "inputValues": [
 *        {
 *          "inputName": "firstName",
 *          "value": "John",
 *          "values": []
 *        },
 *        {
 *          "inputName": "lastName",
 *          "value": "Doe",
 *          "values": []
 *        },
 *        {
 *          "inputName": "email",
 *          "value": "john.doe@somedomain.com",
 *          "values": []
 *        }
 *      ]
 *    },
 *    "tickets": [
 *      {
 *        "ticketNumber": "FMXC-BZG3-OT021",
 *        "ticketDefinitionId": "d72874cb-012a-4ad2-afbb-57fe8cf1e308",
 *        "checkIn": {
 *          "created": "2020-04-28T12:24:20.102Z"
 *        },
 *        "price": {
 *          "amount": "123.00",
 *          "currency": "USD"
 *        },
 *        "archived": false,
 *        "firstName": "John",
 *        "lastName": "Doe",
 *        "email": "john.doe@somedomain.com",
 *        "contactId": "eea3ac0f-f9e6-4ed3-a135-99743c8e90b8",
 *        "memberId": "b272b0bb-d013-415a-8461-e8a175fe8dc6",
 *        "confirmed": true,
 *        "form": {
 *          "inputValues": [
 *            {
 *              "inputName": "custom",
 *              "value": "Another comment",
 *              "values": []
 *            },
 *            {
 *              "inputName": "email",
 *              "value": "john.doe@somedomain.com",
 *              "values": []
 *            },
 *            {
 *              "inputName": "lastName",
 *              "value": "Doe",
 *              "values": []
 *            },
 *            {
 *              "inputName": "firstName",
 *              "value": "John",
 *              "values": []
 *            },
 *            {
 *              "inputName": "date",
 *              "value": "2020-04-28",
 *              "values": []
 *            },
 *            {
 *              "inputName": "comment",
 *              "value": "Comment",
 *              "values": []
 *            },
 *            {
 *              "inputName": "address",
 *              "value": "",
 *              "values": [
 *                "Wix Playground, 100 Gansevoort St",
 *                "New York City",
 *                "New York",
 *                "USA",
 *                "NY 10014"
 *              ]
 *            },
 *            {
 *              "inputName": "phone",
 *              "value": "(555) 555-1234",
 *              "values": []
 *            }
 *          ]
 *        }
 *      },
 *      {
 *        "ticketNumber": "FMXC-BZG3-OT041",
 *        "ticketDefinitionId": "9c3dc432-f1a6-408f-82d8-4f64c7ff581b",
 *        "price": {
 *          "amount": "0.00",
 *          "currency": "USD"
 *        },
 *        "archived": false,
 *        "firstName": "Jane",
 *        "lastName": "Doe",
 *        "email": "jane.doe@somedomain.com",
 *        "contactId": "e11af3d4-c205-4d3a-b687-58d4dda78a6c",
 *        "memberId": "62bc4004-548c-46ad-a699-55ef307273e3",
 *        "confirmed": true,
 *        "form": {
 *          "inputValues": [
 *            {
 *              "inputName": "custom",
 *              "value": "Another comment",
 *              "values": []
 *            },
 *            {
 *              "inputName": "email",
 *              "value": "jane.doe@somedomain.com",
 *              "values": []
 *            },
 *            {
 *              "inputName": "lastName",
 *              "value": "Doe",
 *              "values": []
 *            },
 *            {
 *              "inputName": "firstName",
 *              "value": "Jane",
 *              "values": []
 *            },
 *            {
 *              "inputName": "date",
 *              "value": "2020-04-28",
 *              "values": []
 *            },
 *            {
 *              "inputName": "comment",
 *              "value": "Comment",
 *              "values": []
 *            },
 *            {
 *              "inputName": "address",
 *              "value": "",
 *              "values": [
 *                "Wix Playground, 100 Gansevoort St",
 *                "New York City",
 *                "New York",
 *                "USA",
 *                "NY 10014"
 *              ]
 *            },
 *            {
 *              "inputName": "phone",
 *              "value": "(555) 555-1234",
 *              "values": []
 *            }
 *          ]
 *        }
 *      }
 *    ]
 *  }
 */
Did this help?

onReservationCreated( )

A backend event that fires when a ticket reservation is created.

The onReservationCreated() event handler runs when a ticket reservation is created. The received ReservationCreatedEvent object contains information about the created reservation.

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

Method Declaration
Copy
function onReservationCreated(event: ReservationCreatedEvent): void;
Method Parameters
eventReservationCreatedEventRequired

Information about the ticket reservation that was created.

A backend event that occurs when tickets are reserved
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_onReservationCreated(event) {
  let eventId = event.eventId;
  let reservationId = event.reservationId;
}

/*  Full event object:
 *  {
 *    "timestamp": "2020-04-26T13:00:00.000Z",
 *    "eventId": "46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b",
 *    "reservationId": "d72874cb-012a-4ad2-afbb-57fe8cf1e308",
 *    "expires": "2020-04-26T13:20:00.000Z",
 *    "status": "RESERVATION_PENDING"
 *  }
 */
Did this help?