{"id":"0e65dc61-0158-4a33-8503-2e6b154ee2a4","createdDate":"2024-08-20T14:19:46.148Z","updatedDate":"2024-08-20T14:19:46.148Z","resourceId":"dda9b9e7-2a7d-41de-b9bc-c38ca374c087","sdk":{"schema":{"name":"velo_wix-events-backend","fqn":"","slug":"velo-wix-events-backend","typesMap":{"WixEvents.WixEvents":{"name":"WixEvents","fqn":"WixEvents.WixEvents","slug":"wix-events","actions":[{"name":"cancelEvent","fqn":"WixEvents.WixEvents.cancelEvent","slug":"cancel-event","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["eventId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixEvent","referenceFqn":"WixEvents.WixEvent"},"description":"Fulfilled - The canceled Wix event.\r\nRejected - Error message."},"actionParams":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."}],"description":"Cancels a Wix event and closes its registration.\r\n\r\nThe `cancelEvent()` function returns a Promise that resolves to the newly-canceled Wix event after the specified Wix event is successfully canceled.\r\n\r\n This function does the following:\r\n + Changes the event status to `\"CANCELED\"`. You can also see this status change in the [Events collection](https://support.wix.com/en/article/velo-wix-events-events-collection-fields).\r\n + Sends cancellation emails and/or pushes notifications to registered guests, if Wix event [cancellation notifications are enabled](https://support.wix.com/en/article/wix-events-editing-default-emails).\r\n + Changes the registration status to `CLOSED`.\r\n\r\n Canceled Wix events cannot be \"un-canceled.\" You can only delete and copy them.\r\n\r\n > **Tip**: You can copy a canceled Wix event if you want to reinstate it. Copying an event resets the event's status and registration status.\r\n\r\n When using the API, you do not need to cancel a Wix event before deleting it. When using the Wix Events app in the Editor, you must cancel the Wix event first.\r\n\r\n Only those with \"Manage Events\" permissions can cancel Wix events.\r\n\r\n> **Note**: This function requires [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) to run.\r\n>\r\n> This function is not [universal](https://www.wix.com/velo/reference/api-overview/api-versions#api-overview_api-versions_universal-modules) and runs only on the backend."},{"name":"copyEvent","fqn":"WixEvents.WixEvents.copyEvent","slug":"copy-event","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["eventId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixEvent","referenceFqn":"WixEvents.WixEvent"},"description":"Fulfilled - The copied Wix event.\r\nRejected - Error message."},"actionParams":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."}],"description":"Copies a Wix event.\r\n\r\nThe `copyEvent()` function returns a Promise that resolves to the newly-copied Wix event after it has successfully been copied.\r\n\r\n This function copies a Wix event, including its registration form, notifications, and ticket settings. The newly-copied event is scheduled two weeks from the date of the original event.\r\n\r\n When copying Wix events:\r\n + If your site has multilingual enabled, and your event has additional, translated elements (such as registration messages), the translated elements are also copied to the new event.\r\n + When an event with same title already exists, the title of the newly-copied event has a numeric suffix in parentheses appended to it. For example: Copying an event titled \"My Event\" creates \"My Event (1)\".\r\n + Very long event titles are cropped: For example: \"Daily stand-up ev... (2)\". \r\n The maximum number of characters allowed is 120, which includes the suffix identifying the copy of the event.\r\n\r\n The [`onEventCreated( )`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/events/on-event-created) event handler runs when a Wix event is copied.\r\n The received `CreatedEvent` object contains information about the new Wix event that was copied.\r\n\r\n Only those with \"Manage Events\" permissions can copy Wix events.\r\n\r\n> **Note**: This function requires [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) to run.\r\n>\r\n> This function is not [universal](https://www.wix.com/velo/reference/api-overview/api-versions#api-overview_api-versions_universal-modules) and runs only on the backend."},{"name":"createEvent","fqn":"WixEvents.WixEvents.createEvent","slug":"create-event","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["eventInfo","options"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixEvent","referenceFqn":"WixEvents.WixEvent"},"description":"Fulfilled - The created Wix event.\r\nRejected - Error message."},"actionParams":[{"name":"eventInfo","slug":"event-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixEventInfo","referenceFqn":"WixEvents.WixEventInfo"},"description":"Info used to create the Wix event."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixEventInfoOptions","referenceFqn":"WixEvents.WixEventInfoOptions"},"description":"Options to use when creating the Wix event."}],"description":"Creates a Wix event.\r\n\r\nThe `createEvent()` function returns a Promise that resolves to the newly-created Wix event after it has successfully been created.\r\n\r\n When creating an event, you must define if the event is an RSVP event or a ticketed event. This is stored in the `registration.initialType` property.\r\n After the initial save, you can further define event registration details. If you change the event's registration to be external or unnecessary,\r\n this is reflected in the `registration.type` property. The `registration.initialType` property after initial creation is read-only.\r\n\r\n The new Wix event is created with a default [registration form](https://support.wix.com/en/article/wix-events-customizing-your-registration-form-page) in the site's default language, using the site's default regional settings.\r\n\r\n The default registration form includes input fields for first name, last name, and email. Keep in mind that the registration form\r\n for a ticketed event has different fields from the form for a non-ticketed event.\r\n\r\n By default, the event is automatically configured to send daily summary reports of new registrations to the site's business email.\r\n\r\n Only those with \"Manage Events\" permissions can create Wix events.\r\n\r\n> **Note**: This function requires [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) to run.\r\n>\r\n> This function is not [universal](https://www.wix.com/velo/reference/api-overview/api-versions#api-overview_api-versions_universal-modules) and runs only on the backend."},{"name":"deleteEvent","fqn":"WixEvents.WixEvents.deleteEvent","slug":"delete-event","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["eventId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the event is deleted.\r\nRejected - Error message."},"actionParams":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."}],"description":"Deletes a Wix event.\r\n\r\nThe `deleteEvent()` function returns a Promise that resolves when the specified Wix event is deleted.\r\n\r\n Any event can be deleted regardless of its status or if attendees are registered.\r\n\r\n Deleted events are not returned by the [`getEvent()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/get-event) or [`queryEvent()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/query-events) functions.\r\n\r\n Only those with \"Manage Events\" permissions can delete Wix events.\r\n\r\n> **Note**: This function requires [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) to run.\r\n>\r\n> This function is not [universal](https://www.wix.com/velo/reference/api-overview/api-versions#api-overview_api-versions_universal-modules) and runs only on the backend."},{"name":"getEvent","fqn":"WixEvents.WixEvents.getEvent","slug":"get-event","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["eventId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixEvent","referenceFqn":"WixEvents.WixEvent"},"description":"Fulfilled - The Wix event.\r\nRejected - Error message."},"actionParams":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."}],"description":"Retrieves a Wix event by ID.\r\n\r\nThe `getEvent()` function returns a Promise that resolves to a Wix event whose ID matches the given ID.\r\n\r\n Only those with \"Manage Events\" permissions can get Wix events.\r\n\r\n> **Note**: This function requires [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) to run.\r\n>\r\n> This function is not [universal](https://www.wix.com/velo/reference/api-overview/api-versions#api-overview_api-versions_universal-modules) and runs only on the backend."},{"name":"queryEvents","fqn":"WixEvents.WixEvents.queryEvents","slug":"query-events","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query.\r\nThe `EventsQueryBuilder` functions enable you to run, sort, filter, and control\r\nwhich results a query returns.\r\n\r\nTypically, you build a query using any of the event query functions,\r\nrefine the query by chaining `EventsQueryBuilder` functions, and then execute the\r\nquery by chaining the [`find()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/find) function.\r\n\r\nFor example, the following code returns the first 5 upcoming Wix events created by\r\na given event manager, including scheduled events and events that\r\nhave started. The events are listed in ascending\r\norder by the event's start date.\r\n\r\n```javascript\r\nimport { wixEvents } from 'wix-events-backend';\r\n\r\nwixEvents.queryEvents()\r\n .eq(\"createdBy\", \"4c47c608-cfa8-4037-93ac-738f09560ed3\")\r\n .hasSome(\"status\", [\"SCHEDULED\", \"STARTED\"])\r\n .ascending(\"scheduling.startDate\")\r\n .limit(5)\r\n .find()\r\n .then( (results) => {\r\n console.log(results.items);\r\n } );\r\n```"},"description":"Creates a query to retrieve a list of Wix events.\r\n\r\nThe `queryEvents()` function builds a query to retrieve a list of Wix events and returns\r\n a [EventsQueryBuilder](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/introduction) object.\r\n\r\n The returned object contains the query definition which is typically used to run the query\r\n using the [`find()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/find) function.\r\n\r\n You can refine the query by chaining `EventsQueryBuilder` functions onto the query. `EventsQueryBuilder`\r\n functions enable you to sort, filter, and control the results that `queryEvents.find()` returns.\r\n\r\n The query runs with the following `EventsQueryBuilder` defaults that you can override:\r\n\r\n + [`limit`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/limit): `50`\r\n + [`descending`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/descending): `_createdDate`\r\n\r\n The functions that are chained to `queryEvents()` are applied in the order they are called. For example,\r\n if you sort on the `_createdDate` property in ascending order and then on the `status` property in\r\n descending order, the results are sorted first by the created date of the items and then, if there are\r\n multiple results with the same date, the items are sorted by status in descending order, per created date value.\r\n\r\n\r\nThe following `EventsQueryBuilder` functions are supported for `queryEvents()`.\r\n\r\nFor a full description of the Wix Event object, see the object returned for the [`items`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/items)\r\nproperty in [`EventsQueryResult`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/introduction).\r\n\r\n| Property | Supported Filters & Sorting |\r\n| ---------------------------- | ------------------------------------------------------------------------------------------ |\r\n|`_id` |[`eq()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/eq), [`ne()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ne), [`hasSome()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/has-some) |\r\n|`title` |[`eq()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/eq), [`ne()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ne), [`lt()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/lt), [`le()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/le), [`gt()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/gt), [`ge()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ge), [`hasSome()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/has-some), [`contains()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/contains),[`ascending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ascending), [`descending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/descending) |\r\n|`status` |[`eq()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/eq), [`ne()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ne), [`hasSome()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/has-some), [`contains()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/contains) |\r\n|`createdBy` |[`eq()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/eq), [`ne()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ne), [`hasSome()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/has-some) |\r\n|`scheduling.startDate` |[`lt()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/lt), [`le()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/le), [`gt()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/gt), [`ge()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ge), [`ascending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ascending), [`descending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/descending) |\r\n|`scheduling.endDate` |[`lt()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/lt), [`le()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/le), [`gt()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/gt), [`ge()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ge), [`ascending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ascending), [`descending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/descending) |\r\n|`_createdDate` |[`ascending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ascending), [`descending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/descending) |\r\n|`_updatedDate` |[`ascending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ascending), [`descending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/descending) |\r\n|`slug` |[`eq()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/eq), [`ne()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ne), [`lt()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/lt), [`le()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/le), [`gt()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/gt), [`ge()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ge), [`hasSome()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/has-some), [`contains()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/contains), [`ascending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ascending), [`descending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/descending) |\r\n\r\n You can only use one filter function for each property. If a property is used in more than one filter,\r\n only the first filter will work.\r\n\r\n>**Notes:**\r\n> + A guest can only see their own Wix events unless `suppressAuth` is set to `true` in the queryOptions for the [`find()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/find) function.\r\n> + When using the `queryEvents()` function immediately following a change to your Wix events, the data retrieved may not contain your most recent changes. See [Wix-data and Eventual Consistency](reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency) for more information. To solve this problem, you can use the [`setTimeout()`](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Asynchronous/Timeouts_and_intervals#setTimeout) function to delay querying for a number of seconds, following any changes to your Wix events data.\r\n\r\n\r\n\r\nOnly those with \"Manage Events\" permissions can query Wix events. Only the events they are authorized to\r\nreceive are returned."},{"name":"updateEvent","fqn":"WixEvents.WixEvents.updateEvent","slug":"update-event","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["eventId","eventInfo","options"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixEvent","referenceFqn":"WixEvents.WixEvent"},"description":"Fulfilled - The updated Wix event.\r\nRejected - Error message."},"actionParams":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"eventInfo","slug":"event-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixEventUpdateInfo","referenceFqn":"WixEvents.WixEventUpdateInfo"},"description":"Info used to update the Wix event."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixEventInfoOptions","referenceFqn":"WixEvents.WixEventInfoOptions"},"description":"Options to use when updating the Wix event."}],"description":"Updates a Wix event.\r\n\r\nThe `updateEvent()` function returns a Promise that resolves to the newly-updated Wix event after the Wix event is successfully updated.\r\n\r\n Updating a Wix event does not impact existing guests or generated tickets, orders, and invoices.\r\n\r\n Updating the `title` of a Wix event automatically updates the event's `slug` and `eventUrl.path`.\r\n\r\n Only those with \"Manage Events\" permissions can update Wix events.\r\n\r\n> **Note**: This function requires [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) to run.\r\n>\r\n> This function is not [universal](https://www.wix.com/velo/reference/api-overview/api-versions#api-overview_api-versions_universal-modules) and runs only on the backend."}],"properties":[]},"WixEvents.WixEvent":{"name":"WixEvent","fqn":"WixEvents.WixEvent","slug":"wix-event","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date the Wix event was created."},{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Wix event ID."},{"name":"_updatedDate","slug":"updated-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date the Wix event was updated."},{"name":"about","slug":"about","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Rich-text (HTML) content for the \"About Event\" section."},{"name":"assignedContactsLabel","slug":"assigned-contacts-label","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The \"Filter by:\" drop-down option for filtering contacts by this event \r\n in the Dashboard's [Contact List page](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F8f93447d-7521-4aa1-8c64-4d5a4f025d3f%2Fcontacts%2F%3FreferralInfo%3Dsidebar). \r\n This read-only property is automatically populated to comprise a \"custom\" prefix, the title of the event, and other suffixes added for uniqueness. Note that even if \r\n the title of an event is updated, the `assignedContactsLabel` does not change."},{"name":"calendarLinks","slug":"calendar-links","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CalendarLinks","referenceFqn":"WixEvents.CalendarLinks"},"description":"\"Add to calendar\" URLs."},{"name":"createdBy","slug":"created-by","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the creator of the Wix event. If the creator is not logged in when creating the event, the `createdBy` property is empty."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Wix event description."},{"name":"eventUrl","slug":"event-url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SiteUrl","referenceFqn":"WixEvents.SiteUrl"},"description":"Event page URL components."},{"name":"form","slug":"form","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Form","referenceFqn":"WixEvents.Form"},"description":"Registration form for the site guest to fill out with their contact details, and other information, as relevant."},{"name":"guestList","slug":"guest-list","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GuestListSettings","referenceFqn":"WixEvents.GuestListSettings"},"description":"Guest list settings for the Wix event."},{"name":"language","slug":"language","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"[ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code of the Wix event. Use to translate content on forms, and so on."},{"name":"location","slug":"location","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Location","referenceFqn":"WixEvents.Location"},"description":"Wix event location details."},{"name":"mainImage","slug":"main-image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The location of an image that represents the Wix event. This image is printed on the ticket (PDF format). The image file must be an image file from the Media Manager. \r\n\r\n The URL format is:\r\n `wix:image://v1//#originWidth=&originHeight=[&watermark=]`"},{"name":"registration","slug":"registration","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Registration","referenceFqn":"WixEvents.Registration"},"description":"Registration details for the Wix event."},{"name":"scheduling","slug":"scheduling","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Scheduling","referenceFqn":"WixEvents.Scheduling"},"description":"Wix event scheduling details."},{"name":"slug","slug":"slug","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"URL-friendly version of the Wix event title. Unique across all Wix events in the same site."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Wix event status. Defaults to `\"SCHEDULED\"`.\r\nOne of:\r\n + `\"SCHEDULED\"`. The upcoming Wix event is scheduled but has not yet started. \r\n + `\"STARTED\"`. The Wix event has started and is in progress. \r\n + `\"ENDED\"`. The Wix event has ended.\r\n + `\"CANCELED\"`. The Wix event has been canceled."},{"name":"summary","slug":"summary","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Summaries","referenceFqn":"WixEvents.Summaries"},"description":"Summaries of Wix event sales."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Wix event title."},{"name":"videoConferencing","slug":"video-conferencing","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnlineConferencing","referenceFqn":"WixEvents.OnlineConferencing"},"description":"Online conferencing details for the Wix event."}]},"WixEvents.CalendarLinks":{"name":"CalendarLinks","fqn":"WixEvents.CalendarLinks","slug":"calendar-links","actions":[],"properties":[{"name":"google","slug":"google","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"A URL that guests can use to add the Wix event to their Google calendars."},{"name":"ics","slug":"ics","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"A URL that guests can use to download ICS calendar files in order to add the Wix event to their calendars."}]},"WixEvents.SiteUrl":{"name":"SiteUrl","fqn":"WixEvents.SiteUrl","slug":"site-url","actions":[],"properties":[{"name":"baseUrl","slug":"base-url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Base URL. \r\n + Premium sites: The domain,for example, `https://domain.com`.\r\n + Free sites: The site URL, for example, `https://user_name.wixsite.com/mysite`.\r\n > **Note**: The above URL examples are for a published site. When previewing your site, you receive the Editor URL."},{"name":"path","slug":"path","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The path to Wix event page, for example, `/my-events/weekly-meetup-2` for both Premium and free sites."}]},"WixEvents.Form":{"name":"Form","fqn":"WixEvents.Form","slug":"form","actions":[],"properties":[{"name":"InputGroups","slug":"input-groups","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"InputGroup","referenceFqn":"WixEvents.InputGroup"}},"description":"A block of fields to group together on the form. For example, you might create a block for first name and last name. These blocks are also called input groups."},{"name":"messages","slug":"messages","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FormMessages","referenceFqn":"WixEvents.FormMessages"},"description":"Messages you can customize for the form."}]},"WixEvents.InputGroup":{"name":"InputGroup","fqn":"WixEvents.InputGroup","slug":"input-group","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique ID for the input group."},{"name":"inputs","slug":"inputs","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"InputField","referenceFqn":"WixEvents.InputField"}},"description":"Fields in the block. Also called child input fields."},{"name":"orderIndex","slug":"order-index","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Fields in the input group are sorted by this value in ascending order."},{"name":"system","slug":"system","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the fields in the input group are mandatory (such as name and email). When `true`, you can change only the label for the fields in the block."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The type of the block of fields. Every field in the block must be of the same type. \r\nOne of:\r\n + `\"INPUT\"`\r\n + `\"TEXTAREA\"`\r\n + `\"DROPDOWN\"`\r\n + `\"RADIO\"`\r\n + `\"CHECKBOX\"`\r\n + `\"NAME\"`\r\n + `\"GUEST_CONTROL\"`. This control corresponds to the `Additional Guests` option when customizing the registration form in the Dashboard. The fields for this block include specifying how many guests, adding text for a comment, and whether the guest name is required.\r\n + `\"ADDRESS_SHORT\"`. This control corresponds to the `Single Line` address option when customizing the registration form in the Dashboard, and the `Address.Location.Address.formatted` property in this API. \r\n + `\"ADDRESS_FULL\"`. This control corresponds to the `Full Address` address option when customizing the registration form in the Dashboard, and the set of individual address properties (excluding `Address.Location.Address.formatted`) in this API. \r\n + `\"DATE\"`"}]},"WixEvents.InputField":{"name":"InputField","fqn":"WixEvents.InputField","slug":"input-field","actions":[],"properties":[{"name":"additionalLabels","slug":"additional-labels","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"AdditionalLabel","referenceFqn":"WixEvents.AdditionalLabel"}},"description":"Additional labels for multi-valued fields, such as `ADDRESS` fields."},{"name":"label","slug":"label","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main field label."},{"name":"maxLength","slug":"max-length","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum number of characters allowed for the `TEXT` fields."},{"name":"maxSize","slug":"max-size","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The maximum number of values allowed for `TEXT_ARRAY` fields."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Field name."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Pre-defined text choices for fields, such as the options listed in a dropdown."},{"name":"required","slug":"required","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the field is mandatory."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Type of the field. The type determines the format of the field.\r\n This property is used to validate the values entered on the form when submitting. Defaults to `\"TEXT\"`.\r\nOne of:\r\n + `\"TEXT\"`\r\n + `\"NUMBER\"`\r\n + `\"TEXT_ARRAY\"`\r\n + `\"DATE_TIME\"`\r\n + `\"ADDRESS\"`"}]},"WixEvents.AdditionalLabel":{"name":"AdditionalLabel","fqn":"WixEvents.AdditionalLabel","slug":"additional-label","actions":[],"properties":[{"name":"label","slug":"label","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Field label."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Field name."}]},"WixEvents.FormMessages":{"name":"FormMessages","fqn":"WixEvents.FormMessages","slug":"form-messages","actions":[],"properties":[{"name":"checkout","slug":"checkout","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutFormMessages","referenceFqn":"WixEvents.CheckoutFormMessages"},"description":"Checkout form messages."},{"name":"registrationClosed","slug":"registration-closed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RegistrationClosedMessages","referenceFqn":"WixEvents.RegistrationClosedMessages"},"description":"Messages to display when event registration is closed."},{"name":"rsvp","slug":"rsvp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RsvpFormMessages","referenceFqn":"WixEvents.RsvpFormMessages"},"description":"RSVP form messages."}]},"WixEvents.CheckoutFormMessages":{"name":"CheckoutFormMessages","fqn":"WixEvents.CheckoutFormMessages","slug":"checkout-form-messages","actions":[],"properties":[{"name":"checkoutLabel","slug":"checkout-label","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Button label text that directs guests to check out the form when purchasing tickets."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Title for the form for purchasing tickets."}]},"WixEvents.RegistrationClosedMessages":{"name":"RegistrationClosedMessages","fqn":"WixEvents.RegistrationClosedMessages","slug":"registration-closed-messages","actions":[],"properties":[{"name":"exploreEventsLabel","slug":"explore-events-label","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Button label text that directs guests to take other actions, such as a clicking a link to see other Wix events that they can register for."},{"name":"message","slug":"message","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Message displayed when event registration is closed."}]},"WixEvents.RsvpFormMessages":{"name":"RsvpFormMessages","fqn":"WixEvents.RsvpFormMessages","slug":"rsvp-form-messages","actions":[],"properties":[{"name":"noMessages","slug":"no-messages","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RsvpFormNegative","referenceFqn":"WixEvents.RsvpFormNegative"},"description":"Messages to display when the RSVP is `NO`."},{"name":"rsvpNo","slug":"rsvp-no","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Button label text displayed next to where the guest RSVPs `NO`."},{"name":"rsvpYes","slug":"rsvp-yes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Button label text displayed next to where the guest RSVPs `YES`."},{"name":"submitRsvpLabel","slug":"submit-rsvp-label","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Button label text that directs guests to submit the RSVP form."},{"name":"waitingMessages","slug":"waiting-messages","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RsvpFormPositive","referenceFqn":"WixEvents.RsvpFormPositive"},"description":"Messages to display when the RSVP is `YES`, even if the guest is placed on the waitlist. Wait-listed guests receive the same messages as guests who are not on the waitlist."},{"name":"yesMessages","slug":"yes-messages","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RsvpFormPositive","referenceFqn":"WixEvents.RsvpFormPositive"},"description":"Messages to display when the RSVP is `YES`."}]},"WixEvents.RsvpFormNegative":{"name":"RsvpFormNegative","fqn":"WixEvents.RsvpFormNegative","slug":"rsvp-form-negative","actions":[],"properties":[{"name":"confirmationTitle","slug":"confirmation-title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Confirmation message title."},{"name":"shareLabel","slug":"share-label","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Button label text that suggests guests share the Wix event link with others who might want to attend."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Form title for negative RSVPs."}]},"WixEvents.RsvpFormPositive":{"name":"RsvpFormPositive","fqn":"WixEvents.RsvpFormPositive","slug":"rsvp-form-positive","actions":[],"properties":[{"name":"addToCalendarLabel","slug":"add-to-calendar-label","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Button label text that suggests guests add the Wix event to their calendar using the link."},{"name":"confirmationMessage","slug":"confirmation-message","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Confirmation message text."},{"name":"confirmationTitle","slug":"confirmation-title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Confirmation message title."},{"name":"shareLabel","slug":"share-label","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Button label text that suggests guests share the Wix event link with others who might want to attend."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Form title for positive RSVPs."}]},"WixEvents.GuestListSettings":{"name":"GuestListSettings","fqn":"WixEvents.GuestListSettings","slug":"guest-list-settings","actions":[],"properties":[{"name":"public","slug":"public","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether guests can see other guests attending the Wix event. Defaults to `true`."}]},"WixEvents.Location":{"name":"Location","fqn":"WixEvents.Location","slug":"location","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Address","referenceFqn":"WixEvents.Address"},"description":"Street address for the Wix event.\r\n \r\n The `address` property contains the full [address](https://www.wix.com/velo/reference/$w/addressinput/value) of the Wix event. The address is derived from the [`formatted`](#formatted) property.\r\n\r\n The `address` is required for non-TBD events. (TBD events are events whose time is yet \"to be determined.\")"},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Location name. `name` is required for TBD events (events whose time is yet \"to be determined\")."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Location type. Defaults to `\"VENUE\"`.\r\nOne of:\r\n + `\"VENUE\"`. The event is being held at a physical location.\r\n + `\"ONLINE\"`. The event is being held at a virtual online location, such as with online conferencing."}]},"WixEvents.Address":{"name":"Address","fqn":"WixEvents.Address","slug":"address","actions":[],"oneofProperties":{"addressStreet":[{"name":"addressLine1","slug":"address-line1","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main address line (usually street and number) as free text. For non-TBD events, either `addressLine1` or `streetAddress` must be entered. Optional for TBD events."},{"name":"streetAddress","slug":"street-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StreetAddress","referenceFqn":"WixEvents.StreetAddress"},"description":"Street address object, with number and name in separate fields. For non-TBD events, either `addressLine1` or `streetAddress` must be entered. Optional for TBD events."}]},"properties":[{"name":"addressLine2","slug":"address-line2","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Free text providing more detailed address information, such as apartment, suite, or floor."},{"name":"city","slug":"city","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"City name."},{"name":"country","slug":"country","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format."},{"name":"formatted","slug":"formatted","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Human-readable address string. If not provided, the value is generated from the available address data. If provided, the value is parsed and used to populate other address properties."},{"name":"location","slug":"location","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressLocation","referenceFqn":"WixEvents.AddressLocation"},"description":"Coordinates of the physical address."},{"name":"postalCode","slug":"postal-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Postal or zip code."},{"name":"subdivision","slug":"subdivision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Code for a subdivision (such as state, prefecture, or province) in an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format."}]},"WixEvents.AddressLocation":{"name":"AddressLocation","fqn":"WixEvents.AddressLocation","slug":"address-location","actions":[],"properties":[{"name":"latitude","slug":"latitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address's latitude."},{"name":"longitude","slug":"longitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address's longitude."}]},"WixEvents.StreetAddress":{"name":"StreetAddress","fqn":"WixEvents.StreetAddress","slug":"street-address","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street name."},{"name":"number","slug":"number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street number."}]},"WixEvents.Registration":{"name":"Registration","fqn":"WixEvents.Registration","slug":"registration","actions":[],"properties":[{"name":"externalRegistrationUrl","slug":"external-registration-url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Registration URL if registration for the Wix event managed externally. Guests go to this URL to register."},{"name":"initialType","slug":"initial-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Initial event type, set when creating the Wix event. \r\nOne of:\r\n + `\"RSVP\"`. The event is created as an RSVP-type event.\r\n + `\"TICKETS\"`. The event is created as a ticketed-type event."},{"name":"restrictedTo","slug":"restricted-to","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Who can register for the Wix event. Defaults to `\"MEMBER\"`.\r\nOne of:\r\n + `\"MEMBER\"`. Only logged-in guests can register. \r\n + `\"VISITOR_OR_MEMBER\"`. Everyone can register, whether they are logged-in to the site or not."},{"name":"rsvp","slug":"rsvp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Rsvp","referenceFqn":"WixEvents.Rsvp"},"description":"Registration details for an RSVP event."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Wix event registration status.\r\nOne of:\r\n + `\"CLOSED\"`. The event was closed (for example, if the maximum number of attendees was reached) or cancelled. Guests cannot register.\r\n + `\"CLOSED_MANUALLY\"`. Event registration was closed manually by the event manager. Guests cannot register.\r\n + `\"OPEN_RSVP\"`. Guests can register for the RSVP-type Wix event. \r\n + `\"OPEN_RSVP_WAITLIST\"`. Guests can register for the RSVP-type Wix event, but are waitlisted.\r\n + `\"OPEN_TICKETS\"`. Guests can register for the ticketed-type Wix event.\r\n + `\"OPEN_EXTERNAL\"`. Guests can register externally for the Wix event--not using Wix Events."},{"name":"tickets","slug":"tickets","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Tickets","referenceFqn":"WixEvents.Tickets"},"description":"Registration details for a ticketed event."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Read-only type of the Wix event. After initial event creation, the type can change, for example, if event registration is not necessary (`NO_REGISTRATION`) or if event registration is set to be managed externally (`EXTERNAL`).\r\n + `\"RSVP\"`. The event was initially created as an RSVP-type event.\r\n + `\"TICKETS\"`. The event was initially created as a ticketed-type event.\r\n + `\"EXTERNAL\"`. Registration is managed externally, on a different site. Setting the `externalRegistrationUrl` property updates the `type` to this status.\r\n + `\"NO_REGISTRATION\"`. There is no need to register for this site. Setting the `registrationDisabled` property updates the `type` to this status."}]},"WixEvents.Rsvp":{"name":"Rsvp","fqn":"WixEvents.Rsvp","slug":"rsvp","actions":[],"properties":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum number of guests allowed to register to the Wix event. If a guest adds additional guests to the same RSVP, the additional guests are also included when calculating the `limit`."},{"name":"rsvpStatusOptions","slug":"rsvp-status-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Whether the Wix event accepts `NO` RSVPs in addition to `YES` RSVPs. Defaults to `\"YES_ONLY\"`.\r\nOne of:\r\n + `\"YES_ONLY\"`\r\n + `\"YES_AND_NO\"`"},{"name":"waitlist","slug":"waitlist","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to open a waitlist when the guest `limit` for the Wix event is reached. Waitlisted guests are assigned a `WAITING` status."}]},"WixEvents.Tickets":{"name":"Tickets","fqn":"WixEvents.Tickets","slug":"tickets","actions":[],"properties":[{"name":"currency","slug":"currency","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Currency used for event ordering and transactions."},{"name":"formAssignedPerTicket","slug":"form-assigned-per-ticket","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When ordering, whether each ticket in the order needs its own order form or if one form covers multiple tickets."},{"name":"highestTicketPrice","slug":"highest-ticket-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Money","referenceFqn":"WixEvents.Money"},"description":"Price of the lowest-priced ticket."},{"name":"highestTicketPriceFormatted","slug":"highest-ticket-price-formatted","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Formatted price of the highest-priced ticket."},{"name":"lowestTicketPrice","slug":"lowest-ticket-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Money","referenceFqn":"WixEvents.Money"},"description":"Price of the lowest-priced ticket."},{"name":"lowestTicketPriceFormatted","slug":"lowest-ticket-price-formatted","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Formatted price of the lowest-priced ticket."},{"name":"tax","slug":"tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TaxSettings","referenceFqn":"WixEvents.TaxSettings"},"description":"Tax settings."}]},"WixEvents.Money":{"name":"Money","fqn":"WixEvents.Money","slug":"money","actions":[],"properties":[{"name":"currency","slug":"currency","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Currency code. Must be a valid [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code (for example, `USD`)."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Monetary amount represented as a decimal string with a period as the decimal separator (for example, 3.99)."}]},"WixEvents.TaxSettings":{"name":"TaxSettings","fqn":"WixEvents.TaxSettings","slug":"tax-settings","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tax name."},{"name":"rate","slug":"rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tax rate, such as `21.55`."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"When the tax is applied. Defaults to `\"INCLUDED\"`.\r\nOne of:\r\n + `\"INCLUDED\"`. Tax is built-in to the price. \r\n + `\"ADDED_AT_CHECKOUT\"`. Tax is added when the guest checks out."}]},"WixEvents.Scheduling":{"name":"Scheduling","fqn":"WixEvents.Scheduling","slug":"scheduling","actions":[],"properties":[{"name":"endDate","slug":"end-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"End date and time for the Wix event. Optional for TBD events."},{"name":"formatted","slug":"formatted","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Formatted schedule representation."},{"name":"hideEndDate","slug":"hide-end-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the end date is hidden in the formatted schedule."},{"name":"showTimeZone","slug":"show-time-zone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the time zone is displayed in the formatted schedule."},{"name":"startDate","slug":"start-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Start date and time for the Wix event. Optional for TBD events."},{"name":"startDateFormatted","slug":"start-date-formatted","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Formatted start date of the event (empty for TBD events)."},{"name":"startTimeFormatted","slug":"start-time-formatted","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Formatted start time of the event (empty for TBD events)."},{"name":"tbd","slug":"tbd","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event's time is to be determined later. If `true`, the Wix event's schedule is defined as TBD (\"to be determined\").\r\n Because the Wix event's start and end dates are not yet defined, a message, set in `tbdMessage`, is displayed instead.\r\n `startDate`, `endDate`, and `timeZoneId` are optional for TBD events."},{"name":"tbdMessage","slug":"tbd-message","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"A message to display for events whose `tbd` property is `true`."},{"name":"timeZoneId","slug":"time-zone-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the time zone for the Wix event in [tz database](https://en.wikipedia.org/wiki/Tz_database) format, such as `EST`, or `America/Los_Angeles`. Optional for TBD events."}]},"WixEvents.Summaries":{"name":"Summaries","fqn":"WixEvents.Summaries","slug":"summaries","actions":[],"properties":[{"name":"rsvp","slug":"rsvp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RsvpSummary","referenceFqn":"WixEvents.RsvpSummary"},"description":"Summary data for RSVP sales."},{"name":"tickets","slug":"tickets","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TicketsSummary","referenceFqn":"WixEvents.TicketsSummary"},"description":"Summary data for revenue and tickets sold."}]},"WixEvents.RsvpSummary":{"name":"RsvpSummary","fqn":"WixEvents.RsvpSummary","slug":"rsvp-summary","actions":[],"properties":[{"name":"noCount","slug":"no-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of rejected RSVPs."},{"name":"totalRsvps","slug":"total-rsvps","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total number of RSVPs received."},{"name":"waitlistCount","slug":"waitlist-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of RSVPs in the waitlist."},{"name":"yesCount","slug":"yes-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of accepted RSVPs."}]},"WixEvents.TicketsSummary":{"name":"TicketsSummary","fqn":"WixEvents.TicketsSummary","slug":"tickets-summary","actions":[],"properties":[{"name":"currencyLocked","slug":"currency-locked","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether currency cannot be changed. The currency is locked after the first order for the event has been created and is set to the currency of that first order."},{"name":"revenue","slug":"revenue","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Money","referenceFqn":"WixEvents.Money"},"description":"Total revenue, including taxes and excluding fees. Payment provider fees are not deducted."},{"name":"totalOrders","slug":"total-orders","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total number of orders placed for the Wix event."},{"name":"totalSales","slug":"total-sales","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Money","referenceFqn":"WixEvents.Money"},"description":"Total sales balance for confirmed transactions."},{"name":"totalTickets","slug":"total-tickets","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total number of tickets sold."}]},"WixEvents.OnlineConferencing":{"name":"OnlineConferencing","fqn":"WixEvents.OnlineConferencing","slug":"online-conferencing","actions":[],"properties":[{"name":"conferenceType","slug":"conference-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Online conference type. Defaults to `\"MEETING\"`.\r\nOne of:\r\n + `\"MEETING\"`\r\n + `\"WEBINAR\"`"},{"name":"enabled","slug":"enabled","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether online conferencing is enabled. Not supported for Wix events that are TBDs (events whose time is not yet determined).\r\n When enabled, links to join the conference are generated and provided to guests in an email when the guest registers."},{"name":"providerId","slug":"provider-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the online conferencing provider."},{"name":"session","slug":"session","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Session","referenceFqn":"WixEvents.Session"},"description":"Session details for the Wix event."}]},"WixEvents.Session":{"name":"Session","fqn":"WixEvents.Session","slug":"session","actions":[],"properties":[{"name":"guestLink","slug":"guest-link","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Link for the guests to use to join the online conference session."},{"name":"hostLink","slug":"host-link","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Link for the event host to use to start the online conference session."},{"name":"password","slug":"password","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The password required to join the online conference session (when relevant). Requiring a password is dependent on the online conferencing provider. For example, Zoom provides passwords for its meetings while LiveVideo does not."}]},"WixEvents.WixEventInfo":{"name":"WixEventInfo","fqn":"WixEvents.WixEventInfo","slug":"wix-event-info","actions":[],"properties":[{"name":"about","slug":"about","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Rich-text (HTML) content for the \"About Event\" section."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Wix event description."},{"name":"guestList","slug":"guest-list","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GuestListSettingsInfo","referenceFqn":"WixEvents.GuestListSettingsInfo"},"description":"Wix event guest list settings."},{"name":"location","slug":"location","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LocationInfo","referenceFqn":"WixEvents.LocationInfo"},"description":"Wix event location settings.\r\n `location.address` is required for non-TBD events.\r\n `location.name` is required for TBD events.\r\n (TBD events are events whose times are yet \"to be determined.\")"},{"name":"mainImage","slug":"main-image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The location of an image that represents the Wix event. This image is printed on the ticket (PDF format). The image file must be an image file from the Media Manager. \r\n\r\n The URL format is:\r\n `wix:image://v1//#originWidth=&originHeight=[&watermark=]`"},{"name":"registration","slug":"registration","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixEventRegistrationInfo","referenceFqn":"WixEvents.WixEventRegistrationInfo"},"description":"Wix event registration settings."},{"name":"scheduling","slug":"scheduling","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SchedulingInfo","referenceFqn":"WixEvents.SchedulingInfo"},"description":"Wix event scheduling settings."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Wix event title."},{"name":"videoConferencing","slug":"video-conferencing","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnlineConferencingInfo","referenceFqn":"WixEvents.OnlineConferencingInfo"},"description":"Wix event online conferencing settings."}]},"WixEvents.GuestListSettingsInfo":{"name":"GuestListSettingsInfo","fqn":"WixEvents.GuestListSettingsInfo","slug":"guest-list-settings-info","actions":[],"properties":[{"name":"public","slug":"public","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether guests can see other guests attending the Wix event. Defaults to `true`."}]},"WixEvents.LocationInfo":{"name":"LocationInfo","fqn":"WixEvents.LocationInfo","slug":"location-info","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressInfo","referenceFqn":"WixEvents.AddressInfo"},"description":"Full [address](https://www.wix.com/velo/reference/$w/addressinput/value).\r\n The `address` is required for non-TBD events. (TBD events are events whose time is yet \"to be determined.\") \r\n You can specify the `address` for non-TBD events in the following ways: \r\n + By entering the `address.formatted` property, which the API then uses to populate the other address properties.\r\n + By entering the individual `address` properties including the `address.addressLine1` property and, if needed, the `address.addressLine2`property. (Do not specify `address.streetAddress`.) The API uses this data to populate the `address.formatted` property.\r\n + By entering the individual `address` properties including `address.streetAddress`. (Do not specify `address.addressLine1`.) The API uses this data to populate the `address.formatted` property."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Location name. `name` is required for TBD events (events whose time is yet \"to be determined\")."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Location type. Defaults to `\"VENUE\"`.\r\nOne of:\r\n + `\"VENUE\"`. The event is being held at a physical location.\r\n + `\"ONLINE\"`. The event is being held at a virtual online location, such as with online conferencing."}]},"WixEvents.AddressInfo":{"name":"AddressInfo","fqn":"WixEvents.AddressInfo","slug":"address-info","actions":[],"oneofProperties":{"addressInfoStreet":[{"name":"addressLine1","slug":"address-line1","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main address line (usually street and number) as free text. For non-TBD events, either `addressLine1` or `streetAddress` must be entered. Optional for TBD events."},{"name":"streetAddress","slug":"street-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StreetAddressInfo","referenceFqn":"WixEvents.StreetAddressInfo"},"description":"Street address object, with number and name in separate fields. For non-TBD events, either `addressLine1` or `streetAddress` must be entered. Optional for TBD events."}]},"properties":[{"name":"addressLine2","slug":"address-line2","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Free text providing more detailed address information, such as apartment, suite, or floor."},{"name":"city","slug":"city","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"City name."},{"name":"country","slug":"country","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format."},{"name":"formatted","slug":"formatted","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Human-readable address string. If not provided, the value is generated from the available address data. If provided, the value is parsed and used to populate other address properties."},{"name":"location","slug":"location","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressLocationInfo","referenceFqn":"WixEvents.AddressLocationInfo"},"description":"Coordinates of the physical address."},{"name":"postalCode","slug":"postal-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Postal or zip code."},{"name":"subdivision","slug":"subdivision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Code for a subdivision (such as state, prefecture, or province) in an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format."}]},"WixEvents.AddressLocationInfo":{"name":"AddressLocationInfo","fqn":"WixEvents.AddressLocationInfo","slug":"address-location-info","actions":[],"properties":[{"name":"latitude","slug":"latitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address's latitude."},{"name":"longitude","slug":"longitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address's longitude."}]},"WixEvents.StreetAddressInfo":{"name":"StreetAddressInfo","fqn":"WixEvents.StreetAddressInfo","slug":"street-address-info","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street name."},{"name":"number","slug":"number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street number."}]},"WixEvents.WixEventRegistrationInfo":{"name":"WixEventRegistrationInfo","fqn":"WixEvents.WixEventRegistrationInfo","slug":"wix-event-registration-info","actions":[],"properties":[{"name":"externalRegistrationUrl","slug":"external-registration-url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Registration URL, if registration for the Wix event is managed externally. Guests go to this URL to register. Setting this property changes the read-only `registration.type` property to `EXTERNAL`."},{"name":"registrationDisabled","slug":"registration-disabled","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to disable registration. For example, you might want to disable registration if you will not have enough supplies on-hand for more attendees. Setting to `true` changes the read-only `registration.type` property to `NO_REGISTRATION`."},{"name":"registrationPaused","slug":"registration-paused","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to temporarily suspend (pause) registration. For example, you might want to pause registration temporarily if you need to change venues to allow for more attendees."},{"name":"restrictedTo","slug":"restricted-to","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Who can register to the Wix event. Defaults to `\"MEMBER\"`.\r\nOne of:\r\n + `\"MEMBER\"`. Only logged-in guests can register. \r\n + `\"VISITOR_OR_MEMBER\"`. Everyone can register, whether they are logged-in to the site or not."},{"name":"rsvp","slug":"rsvp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RsvpInfo","referenceFqn":"WixEvents.RsvpInfo"},"description":"Registration settings for the RSVP Wix event."},{"name":"tickets","slug":"tickets","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TicketsInfo","referenceFqn":"WixEvents.TicketsInfo"},"description":"Registration settings for the ticketed Wix event."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event type. Only RSVP and TICKETS are allowed when creating an event (`initialType`), however after initial event\r\ncreation the `type` can be changed to other values.\r\nOne of:\r\n + `\"RSVP\"`. The Wix event is an RSVP event. It cannot be changed to a ticketed event.\r\n + `\"TICKETS\"`. The Wix event is a ticketed event. It cannot be changed to an RSVP event.\r\n + `\"EXTERNAL\"`. If you created a guest list before setting up external registration, the current guest list remains but is likely to be \r\n incomplete. So when sending out messages to the Wix-managed guest list, not all \r\n guests will receive them. Messages should be sent from the external registration system\r\n to the complete guest list.\r\n You can change the value back at any point if you no longer want the event to be managed externally.\r\n + `\"NO_REGISTRATION\"`. No registration is necessary for the event."}]},"WixEvents.RsvpInfo":{"name":"RsvpInfo","fqn":"WixEvents.RsvpInfo","slug":"rsvp-info","actions":[],"properties":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum number of guests allowed to register to the Wix event. If a guest adds additional guests to the same RSVP, the additional guests are also included when calculating the `limit`."},{"name":"rsvpStatusOptions","slug":"rsvp-status-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Whether the Wix event accepts `NO` rsvps in addition to `YES` rsvps. Defaults to `\"YES_ONLY\"`.\r\nOne of:\r\n + `\"YES_ONLY\"`\r\n + `\"YES_AND_NO\"`"},{"name":"waitlist","slug":"waitlist","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to open a waitlist when the guest `limit` for the Wix event is reached. Waitlisted guests are assigned a `WAITING` status."}]},"WixEvents.TicketsInfo":{"name":"TicketsInfo","fqn":"WixEvents.TicketsInfo","slug":"tickets-info","actions":[],"properties":[{"name":"formAssignedPerTicket","slug":"form-assigned-per-ticket","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When ordering, whether each ticket in the order needs its own order form or if one form covers multiple tickets."},{"name":"tax","slug":"tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TaxSettingInfo","referenceFqn":"WixEvents.TaxSettingInfo"},"description":"Tax settings."}]},"WixEvents.TaxSettingInfo":{"name":"TaxSettingInfo","fqn":"WixEvents.TaxSettingInfo","slug":"tax-setting-info","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tax name."},{"name":"rate","slug":"rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tax rate, such as `21.55`."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"When the tax is applied. Defaults to `\"INCLUDED\"`.\r\nOne of:\r\n + `\"INCLUDED\"`. Tax is built-in to the price. \r\n + `\"ADDED_AT_CHECKOUT\"`. Tax is added when the guest checks out."}]},"WixEvents.SchedulingInfo":{"name":"SchedulingInfo","fqn":"WixEvents.SchedulingInfo","slug":"scheduling-info","actions":[],"properties":[{"name":"endDate","slug":"end-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"End date and time for the Wix event. Optional for TBD (\"to be determined\") events."},{"name":"hideEndDate","slug":"hide-end-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the end date is hidden in the formatted schedule."},{"name":"showTimeZone","slug":"show-time-zone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the time zone is displayed in the formatted schedule."},{"name":"startDate","slug":"start-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Start date and time for the Wix event. Optional for TBD (\"to be determined\") events."},{"name":"tbd","slug":"tbd","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event's time is to be determined later. If `true`, the Wix event's schedule is defined as TBD (\"to be determined\").\r\n Because the Wix event's start and end dates are not yet defined, a message, set in `tbdMessage`, is displayed instead.\r\n `startDate`, `endDate`, and `timeZoneId` are optional for TBD events."},{"name":"tbdMessage","slug":"tbd-message","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"A message to display for events whose `tbd` property is `true`."},{"name":"timeZoneId","slug":"time-zone-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the time zone for the Wix event in [tz database format](https://en.wikipedia.org/wiki/Tz_database), such as `EST`, or `America/Los_Angeles`. Optional for TBD events."}]},"WixEvents.OnlineConferencingInfo":{"name":"OnlineConferencingInfo","fqn":"WixEvents.OnlineConferencingInfo","slug":"online-conferencing-info","actions":[],"properties":[{"name":"conferenceType","slug":"conference-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Online conference type. Defaults to `\"MEETING\"`.\r\nOne of:\r\n + `\"MEETING\"`\r\n + `\"WEBINAR\"`"},{"name":"enabled","slug":"enabled","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether online conferencing is enabled. Not supported for Wix events that are TBDs (events whose time is not yet determined).\r\n When enabled, links to join the conference are generated and provided to guests in an email when the guest registers."},{"name":"providerId","slug":"provider-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the online conferencing provider."}]},"WixEvents.WixEventInfoOptions":{"name":"WixEventInfoOptions","fqn":"WixEvents.WixEventInfoOptions","slug":"wix-event-info-options","actions":[],"properties":[{"name":"language","slug":"language","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Content language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\r\n Used for translating tickets' PDF labels, registration forms, automatic emails, and so on.\r\n Supported languages: `ar`, `bg`, `cs`, `da`, `de`, `el`, `en`, `es`, `fi`, `fr`, `he`, `hi`, `hu`, `id`, `it`, `ja`, `ko`, `ms`, `nl`, `no`, `pl`, `pt`, `ro`, `ru`, `sv`, `th`, `tl`, `tr`, `uk`, `zh`.\r\n Defaults to `en`."}]},"WixEvents.EventsQueryBuilder.EventsQueryBuilder":{"name":"EventsQueryBuilder","fqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","slug":"events-query-builder","actions":[{"name":"and","fqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder.and","slug":"and","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder"},"description":"Contains functionality for refining a Wix events query."}],"description":"Adds an `and` condition to the query.\r\n\r\nThe `and()` function adds an `and` condition to an `EventsQueryBuilder`.\r\nA query with an `and` returns all the items that match the query\r\nas defined up to the `and` function and also match the query or\r\nfilter passed to the `and` function.\r\n\r\nNote that when chaining multiple `EventsQueryBuilder` functions to a query an `and` condition is assumed.\r\nIn such cases, you do not need to add a call to the `and()` function.\r\nFor example, this query returns results where status is either `SCHEDULED` or `STARTED` **and** a specific\r\nevent manager created the event. \r\n\r\n```javascript\r\nwixEvents.queryEvents()\r\n .hasSome(\"status\", [\"SCHEDULED\", \"STARTED\"])\r\n .eq(\"createdBy\", \"4c47c608-cfa8-4037-93ac-738f09560ed3\");\r\n```\r\n\r\nThe `and()` function is needed when performing compound queries. For\r\nexample, the final query in this set of queries returns results where the event is an introductory class\r\nwhose title contains either `beginner` or `basic` **and** whose status is either `STARTED` or `ENDED`. If\r\nboth these conditions are `true` we might want to let the participants for these introductory classes know about\r\nupcoming intermediate level classes.\r\n\r\n```javascript\r\nlet levelQuery = wixEvents.queryEvents()\r\n .contains(\"title\", \"beginner\")\r\n .or(\r\n wixEvents.queryEvents()\r\n .contains(\"title\", \"basic\")\r\n);\r\n\r\nlet statusQuery = wixEvents.queryEvents()\r\n .hasSome(\"status\", [\"STARTED\", \"ENDED\"])\r\n\r\nlet readyForIntermediateQuery = levelQuery.and(statusQuery);\r\n```\r\n\r\nThe `and()` function is designed to work with 2 or more queries or filters.\r\nIf you use it on its own, it will return all the items in a collection."},{"name":"ascending","fqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort.\r\n\r\nSupported properties:\r\n+ `title`\r\n+ `slug`\r\n+ `scheduling.startTime`\r\n+ `scheduling.endTime`\r\n+ `_createdDate`\r\n+ `_updatedDate`"}],"description":"Adds a sort to a query, sorting by the specified properties in ascending order.\r\n\r\nThe `ascending()` function refines an `EventsQueryBuilder` to sort in ascending order of\r\nthe specified properties. If you specify more than one property,\r\n`ascending()` sorts the results in ascending order by each property in the\r\norder they are listed.\r\n\r\nYou can sort the following types:\r\n\r\n+ Date: Sorts by date and time.\r\n+ String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n\r\nIf a property contains a number as a String, that value will be sorted\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified sort property are ranked lowest."},{"name":"contains","fqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder.contains","slug":"contains","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `title`\r\n+ `status`\r\n+ `slug`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value contains a specified string.\r\n\r\nThe `contains()` function refines an `EventsQueryBuilder` to only\r\nmatch items where the value of the specified property contains the specified string.\r\nMatching with `contains()` is case-sensitive, so `\"TEXT\"` does not contain `\"text\"`.\r\n\r\nYou can only use `contains()` with a property whose value is a String."},{"name":"descending","fqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort.\r\n\r\nSupported properties:\r\n+ `title`\r\n+ `slug`\r\n+ `scheduling.startTime`\r\n+ `scheduling.endTime`\r\n+ `_createdDate`\r\n+ `_updatedDate`"}],"description":"Adds a sort to a query, sorting by the specified properties in descending order.\r\n\r\nThe `descending()` function refines an `EventsQueryBuilder` to sort in descending order of\r\nthe specified properties. If you specify more than one property,\r\n`descending()` sorts the results in descending order by each property in the\r\norder they are listed.\r\n\r\nYou can sort the following types:\r\n\r\n+ Date: Sorts by date and time.\r\n+ String: Sorts lexicographically, so `\"abc\"` comes before `\"XYZ\"`.\r\n\r\nIf a property contains a number as a String, that value will be sorted\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified sort property are ranked lowest."},{"name":"eq","fqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `_id`\r\n+ `title`\r\n+ `createdBy`\r\n+ `status`\r\n+ `slug`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value equals the specified value.\r\n\r\nThe `eq()` function refines an `EventsQueryBuilder` to only\r\nmatch items where the value of the specified property equals the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nMatching strings with `eq()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\nIf the value of the `propertyName` property is an Array, `eq()` includes items\r\nin which any of the elements of the Array match the specified `value`."},{"name":"find","fqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"EventsQueryResult","referenceFqn":"WixEvents.EventsQueryResult.EventsQueryResult"},"description":"Fulfilled - The results of a Wix events query, containing the retrieved items.\r\n When you execute a query with the `find()`\r\n function, it returns a Promise that resolves to an `EventsQueryResult` object.\r\n This object contains the items that match the query, information about the\r\n query itself, and functions for paging through the query results.\r\nRejected - Error that caused the query to fail."},"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"QueryOptions","referenceFqn":"WixEvents.QueryOptions"},"description":"Options to use when performing a query or query count."}],"description":"Returns the items that match the query.\r\n\r\nThe `find()` function returns a Promise that resolves to the results found\r\n by the query and some information about the results. The Promise is\r\n rejected if `find()` is called with incorrect permissions or if any of the\r\n functions used to refine the query are invalid.\r\n\r\n> **Note:** A guest can only view their own events. You can override the permissions by setting the `suppressAuth` option to `true`."},{"name":"ge","fqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `scheduling.startDate`\r\n+ `scheduling.endDate`\r\n+ `title`\r\n+ `slug`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is greater than or equal to the specified value.\r\n\r\nThe `ge()` function refines an `EventsQueryBuilder` to only\r\nmatch items where the value of the specified property is greater than or equal to the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nIf a property contains a number as a String, that value will be compared\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified property are ranked lowest.\r\n\r\nThe following types of properties can be compared:\r\n\r\n+ Number: Compares numerically.\r\n+ Date: Compares JavaScript Date objects.\r\n+ String: Compares lexicographically,\r\n`\"abc\"` is greater than or equal to `\"ABC\"` (because of the greater than),\r\nbut `\"ABC\"` is not greater than or equal to `\"abc\"`"},{"name":"gt","fqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder.gt","slug":"gt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `scheduling.startDate`\r\n+ `scheduling.endDate`\r\n+ `title`\r\n+ `slug`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is greater than the specified value.\r\n\r\nThe `gt()` function refines an `EventsQueryBuilder` to only\r\nmatch items where the value of the specified property is greater than the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nIf a property contains a number as a String, that value will be compared\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified property are ranked lowest.\r\n\r\nThe following types of properties can be compared:\r\n\r\n+ Number: Compares numerically.\r\n+ Date: Compares JavaScript Date objects.\r\n+ String: Compares lexicographically, so `\"text\"` is greater than `\"Text\"`."},{"name":"hasSome","fqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","values"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `_id`\r\n+ `title`\r\n+ `createdBy`\r\n+ `status`\r\n+ `slug`"},{"name":"values","slug":"values","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value contains any of the specified values.\r\n\r\nThe `hasSome()` function refines an `EventsQueryBuilder` to only\r\nmatch items where any of the values of the array of the specified property equal any of\r\nthe specified values.\r\n\r\nMatching with `hasSome()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`."},{"name":"le","fqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder.le","slug":"le","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `scheduling.startDate`\r\n+ `scheduling.endDate`\r\n+ `title`\r\n+ `slug`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is less than or equal to the specified value.\r\n\r\nThe `le()` function refines an `EventsQueryBuilder` to only\r\nmatch items where the value of the specified property is less than or equal to the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nIf a property contains a number as a String, that value will be compared\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified property are ranked lowest.\r\n\r\nThe following types of properties can be compared:\r\n\r\n+ Number: Compares numerically.\r\n+ Date: Compares JavaScript Date objects.\r\n+ String: Compares lexicographically,\r\nso `\"ABC\"` is less than or equal to `\"abc\"` (because of the less than),\r\nbut `\"abc\"` is not less than or equal to `\"ABC\"`."},{"name":"limit","fqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"limit The number of items to return, which is also the [`pageSize`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/page-size) of the results object."}],"description":"Limits the number of items the query returns.\r\n\r\nThe `limit()` function defines the number of results a query returns in each\r\npage. Only one page of results is retrieved at a time. The [`next()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/next)\r\nand [`prev()`](wix-events-backend.eventsqueryresult.htmlhttps://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/prev) functions are used to\r\nnavigate the pages of a query result.\r\n\r\nBy default, `limit` is set to `50`.\r\n\r\nThe maximum value that `limit()` can accept is `1000`."},{"name":"lt","fqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `scheduling.startDate`\r\n+ `scheduling.endDate`\r\n+ `title`\r\n+ `slug`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is less than the specified value.\r\n\r\nThe `lt()` function refines an `EventsQueryBuilder` to only\r\nmatch items where the value of the specified property is less than the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nIf a property contains a number as a String, that value will be compared\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified property are ranked lowest.\r\n\r\nThe following types of properties can be compared:\r\n\r\n+ Number: Compares numerically.\r\n+ Date: Compares JavaScript Date objects.\r\n+ String: Compares lexicographically, so `\"Text\"` is less than `\"text\"`."},{"name":"ne","fqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder.ne","slug":"ne","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `_id`\r\n+ `title`\r\n+ `createdBy`\r\n+ `status`\r\n+ `slug`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value does not equal the specified value.\r\n\r\nThe `ne()` function refines an `EventsQueryBuilder` to only\r\nmatch items where the value of the specified property does not equal the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nMatching strings with `ne()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\nIf the value of the `propertyName` property is an Array, `ne()` includes items\r\nin which none of the elements of the Array match the specified `value`."},{"name":"not","fqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder.not","slug":"not","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder"},"description":"Contains functionality for refining a Wix events query."}],"description":"Adds an `not` condition to the query.\r\n\r\nThe `not()` function adds a `not` condition to an `EventsQueryBuilder`. A query\r\nwith a `not` returns all the items that match the query as defined up to\r\nthe `not` function, but don't match the query passed to the `not` function.\r\n\r\nIf the query only contains a `not()` function, it returns all the items\r\nthat don't match the query defined by the `not` method."},{"name":"or","fqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder.or","slug":"or","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder"},"description":"Contains functionality for refining a Wix events query."}],"description":"Adds an `or` condition to the query.\r\n\r\nThe `or()` function adds an inclusive `or` condition to an `EventsQueryBuilder`. A query\r\nwith an `or` returns all the items that match the query as defined up to\r\nthe `or` function, the items that match the query passed to the `or`\r\nfunction, and the items that match both.\r\n\r\nThe `or()` function is designed to work with 2 or more queries.\r\nIf you use it on its own, it will return all the items in a collection."},{"name":"skip","fqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\r\n\r\nThe `skip()` function defines the number of results to skip in the query\r\nresults before returning new query results.\r\n\r\nFor example, if you query a collection and 50 items match your query, but\r\nyou set `skip` to 10, the results returned will skip the first 10 items\r\nthat match and return the 11th through 50th items.\r\n\r\nBy default, `skip` is set to 0."}],"properties":[]},"WixEvents.QueryOptions":{"name":"QueryOptions","fqn":"WixEvents.QueryOptions","slug":"query-options","actions":[],"properties":[{"name":"suppressAuth","slug":"suppress-auth","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When `true`, prevents permission checks from running for the operation. Defaults to `false`."}]},"WixEvents.EventsQueryResult.EventsQueryResult":{"name":"EventsQueryResult","fqn":"WixEvents.EventsQueryResult.EventsQueryResult","slug":"events-query-result","actions":[{"name":"hasNext","fqn":"WixEvents.EventsQueryResult.EventsQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"description":"Indicates if the query has more results."},{"name":"hasPrev","fqn":"WixEvents.EventsQueryResult.EventsQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"description":"Indicates if the query has previous results."},{"name":"next","fqn":"WixEvents.EventsQueryResult.EventsQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"EventsQueryResult","referenceFqn":"WixEvents.EventsQueryResult.EventsQueryResult"},"description":"Fulfilled - The results of a Wix events query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-events-backend.eventsquerybuilder.htmlhttps://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/find)\r\nfunction, it returns a Promise that resolves to an `EventsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"description":"Retrieves the next page of query results.\r\n\r\nThe `next()` function retrieves the next page of query results.\r\n\r\nThe page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/page-size) property, and\r\nnavigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/prev) and\r\n[`next()`](wix-events/events-query-result/next) functions.\r\n\r\nIf items are added or removed between calls to `next()` the values returned\r\nby `EventsQueryResult` may change."},{"name":"prev","fqn":"WixEvents.EventsQueryResult.EventsQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"EventsQueryResult","referenceFqn":"WixEvents.EventsQueryResult.EventsQueryResult"},"description":"Fulfilled - The results of a Wix events query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-events-backend.eventsquerybuilder.htmlhttps://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/find)\r\nfunction, it returns a Promise that resolves to an `EventsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"description":"Retrieves the previous page of query results.\r\n\r\nThe `prev()` function retrieves the previous page of query results.\r\n\r\nThe page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/page-size) property, and\r\nnavigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/prev) and\r\n[`next()`](wix-events/events-query-result/next) functions.\r\n\r\nIf items are added or removed between calls to `prev()` the values returned\r\nby `EventsQueryResult` may change."}],"properties":[{"name":"currentPage","slug":"current-page","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the index of the current results page number.\r\n\r\nThe `currentPage` is a zero-based index of the current page of results.\r\n\r\nThe page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/page-size) property, and\r\nnavigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/prev) and\r\n[`next()`](wix-events/events-query-result/next) functions.\r\n\r\nThe `currentPage` property returns `undefined` if the query returned no results."},{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"WixEvent","referenceFqn":"WixEvents.WixEvent"}},"description":"Returns the items that match the query.\r\n\r\nThe current page of Wix events retrieved by the query.\r\n\r\n> **Note:** When no items match the query, the `items` array is empty.\r\n\r\nTo paginate your query results, use the `EventsQueryResult` pagination properties and functions."},{"name":"length","slug":"length","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current results page.\r\n\r\nThe page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/page-size) property, and\r\nnavigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/prev) and\r\n[`next()`](wix-events/events-query-result/next) functions."},{"name":"pageSize","slug":"page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the query page size.\r\n\r\nThe page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/page-size) property, and\r\nnavigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/prev) and\r\n[`next()`](wix-events/events-query-result/next) functions."},{"name":"query","slug":"query","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder"},"description":"Contains functionality for refining a Wix events query.\r\n\r\nThe `EventsQueryBuilder` functions enable you to run, sort, filter, and control\r\n which results a query returns.\r\n\r\n Typically, you build a query using any of the event query functions,\r\n refine the query by chaining `EventsQueryBuilder` functions, and then execute the\r\n query by chaining the [`find()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/find) function.\r\n\r\n For example, the following code returns the first 5 upcoming Wix events created by\r\n a given event manager, including scheduled events and events that\r\n have started. The events are listed in ascending\r\n order by the event's start date.\r\n\r\n ```javascript\r\n import { wixEvents } from 'wix-events-backend';\r\n\r\n wixEventsBackend.queryEvents()\r\n .eq(\"createdBy\", \"4c47c608-cfa8-4037-93ac-738f09560ed3\")\r\n .hasSome(\"status\", [\"SCHEDULED\", \"STARTED\"])\r\n .ascending(\"scheduling.startDate\")\r\n .limit(5)\r\n .find()\r\n .then( (results) => {\r\n console.log(results.items);\r\n } );\r\n```"},{"name":"totalCount","slug":"total-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of items that match the query.\r\n\r\nThe `totalCount` returns the total number of items that match the query,\r\n not just the number of items in the current page."},{"name":"totalPages","slug":"total-pages","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of pages the query produced.\r\n\r\nThe page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/page-size) property, and\r\nnavigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/prev) and\r\n[`next()`](wix-events/events-query-result/next) functions."}]},"WixEvents.WixEventUpdateInfo":{"name":"WixEventUpdateInfo","fqn":"WixEvents.WixEventUpdateInfo","slug":"wix-event-update-info","actions":[],"properties":[{"name":"about","slug":"about","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Rich-text (HTML) content for the \"About Event\" section."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Wix event description."},{"name":"guestList","slug":"guest-list","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GuestListSettingsInfo","referenceFqn":"WixEvents.GuestListSettingsInfo"},"description":"Wix event guest list settings."},{"name":"location","slug":"location","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LocationInfo","referenceFqn":"WixEvents.LocationInfo"},"description":"Wix event location settings.\r\n Address is required for non-TBD events.\r\n Location name is required for TBD events.\r\n (TBD events are events whose times are yet \"to be determined.\")"},{"name":"mainImage","slug":"main-image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The location of an image that represents the Wix event. This image is printed on the ticket (PDF format). The image file must be an image file from the Media Manager. \r\n\r\n The URL format is:\r\n `wix:image://v1//#originWidth=&originHeight=[&watermark=]`"},{"name":"registration","slug":"registration","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixEventRegistrationInfo","referenceFqn":"WixEvents.WixEventRegistrationInfo"},"description":"Wix event registration settings."},{"name":"scheduling","slug":"scheduling","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SchedulingInfo","referenceFqn":"WixEvents.SchedulingInfo"},"description":"Wix event scheduling settings."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Wix event title."},{"name":"videoConferencing","slug":"video-conferencing","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnlineConferencingInfo","referenceFqn":"WixEvents.OnlineConferencingInfo"},"description":"Wix event online conferencing settings."}]},"Events.CanceledEvent":{"name":"CanceledEvent","fqn":"Events.CanceledEvent","slug":"canceled-event","actions":[],"properties":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time the event was canceled."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event title."}]},"Events.CreatedEvent":{"name":"CreatedEvent","fqn":"Events.CreatedEvent","slug":"created-event","actions":[],"properties":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"location","slug":"location","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Location","referenceFqn":"Events.Location"},"description":"Event location."},{"name":"scheduleConfig","slug":"schedule-config","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ScheduleConfiguration","referenceFqn":"Events.ScheduleConfiguration"},"description":"Event's schedule configuration."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time the event was created/copied."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event title."},{"name":"userId","slug":"user-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the user who created/copied the event."}]},"Events.Location":{"name":"Location","fqn":"Events.Location","slug":"location","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Single line address representation of the location."},{"name":"coordinates","slug":"coordinates","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MapCoordinates","referenceFqn":"Events.MapCoordinates"},"description":"The location's map coordinates."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Location name. Maximum allowed characters is 50."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Type of location.\r\n One of:\r\n\r\n + `\"VENUE\"`: Event is hosted in the venue.\r\n + `\"ONLINE\"`: Event is hosted online."}]},"Events.MapCoordinates":{"name":"MapCoordinates","fqn":"Events.MapCoordinates","slug":"map-coordinates","actions":[],"properties":[{"name":"lat","slug":"lat","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Latitude."},{"name":"lng","slug":"lng","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Longitude."}]},"Events.ScheduleConfiguration":{"name":"ScheduleConfiguration","fqn":"Events.ScheduleConfiguration","slug":"schedule-configuration","actions":[],"properties":[{"name":"endDate","slug":"end-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Event end date."},{"name":"scheduleTbd","slug":"schedule-tbd","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event's schedule is to be determined later.\r\n\r\n If an event's time is not yet decided, the TBD message is displayed instead of the\r\n start date and end date.\r\n\r\n When `scheduleTbd` is `true`, `startDate`, `endDate`, and `timeZoneId` are not required."},{"name":"scheduleTbdMessage","slug":"schedule-tbd-message","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Schedule TBD message."},{"name":"startDate","slug":"start-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Event start date."},{"name":"timeZoneId","slug":"time-zone-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the time zone for the Wix event in [tz database format](https://en.wikipedia.org/wiki/Tz_database), such as `EST`, or `America/Los_Angeles`. Optional for TBD events."}]},"Events.DeletedEvent":{"name":"DeletedEvent","fqn":"Events.DeletedEvent","slug":"deleted-event","actions":[],"properties":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time the event was deleted."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event title."}]},"Events.EndedEvent":{"name":"EndedEvent","fqn":"Events.EndedEvent","slug":"ended-event","actions":[],"properties":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the event."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time the event ended."}]},"Events.EventReminder":{"name":"EventReminder","fqn":"Events.EventReminder","slug":"event-reminder","actions":[],"properties":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"location","slug":"location","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Location","referenceFqn":"Events.Location"},"description":"Event location."},{"name":"scheduleConfig","slug":"schedule-config","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ScheduleConfiguration","referenceFqn":"Events.ScheduleConfiguration"},"description":"Event's schedule configuration."},{"name":"startsIn","slug":"starts-in","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimeDuration","referenceFqn":"Events.TimeDuration"},"description":"The time between now and the event start."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time the reminder was sent."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event title."},{"name":"userId","slug":"user-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the user who created the event."}]},"Events.TimeDuration":{"name":"TimeDuration","fqn":"Events.TimeDuration","slug":"time-duration","actions":[],"properties":[{"name":"days","slug":"days","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of days in the time duration."},{"name":"hours","slug":"hours","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of hours in the time duration."},{"name":"minutes","slug":"minutes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of minutes in the time duration."}]},"Events.StartedEvent":{"name":"StartedEvent","fqn":"Events.StartedEvent","slug":"started-event","actions":[],"properties":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time the event started."}]},"Events.UpdatedEvent":{"name":"UpdatedEvent","fqn":"Events.UpdatedEvent","slug":"updated-event","actions":[],"properties":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"location","slug":"location","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Location","referenceFqn":"Events.Location"},"description":"Event location."},{"name":"scheduleConfig","slug":"schedule-config","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ScheduleConfiguration","referenceFqn":"Events.ScheduleConfiguration"},"description":"Event's schedule configuration."},{"name":"scheduleConfigUpdated","slug":"schedule-config-updated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the schedule configuration was updated."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time the event was updated."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event title."}]},"Events.OrderConfirmedEvent":{"name":"OrderConfirmedEvent","fqn":"Events.OrderConfirmedEvent","slug":"order-confirmed-event","actions":[],"properties":[{"name":"checkoutForm","slug":"checkout-form","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FormResponse","referenceFqn":"Events.FormResponse"},"description":"Checkout form response."},{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID associated with this order."},{"name":"created","slug":"created","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time order was created."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer email."},{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer first name."},{"name":"invoice","slug":"invoice","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Invoice","referenceFqn":"Events.Invoice"},"description":"Order invoice."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer last name."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID associated with this order."},{"name":"method","slug":"method","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Payment method used. For example, \"payPal\" or \"creditCard\"."},{"name":"orderNumber","slug":"order-number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique order number."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Order status.\r\n One of:\r\n\r\n + `\"FREE\"`: Order is confirmed, no payment required.\r\n + `\"PENDING\"`: Order was paid, but the payment provider suspended the payment. Eventually changes to `\"PAID\"`.\r\n + `\"PAID\"`: Order paid using the payment provider.\r\n + `\"OFFLINE_PENDING\"`: Order confirmed, but has to be paid offline and status needs to be manually updated to `\"PAID\"`.\r\n + `\"INITIATED\"`: Order is awaiting payment."},{"name":"tickets","slug":"tickets","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Ticket","referenceFqn":"Events.Ticket"}},"description":"Tickets generated after payment."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time order was confirmed."}]},"Events.FormResponse":{"name":"FormResponse","fqn":"Events.FormResponse","slug":"form-response","actions":[],"properties":[{"name":"inputValues","slug":"input-values","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"InputValue","referenceFqn":"Events.InputValue"}},"description":"Values that were entered in the guest form."}]},"Events.InputValue":{"name":"InputValue","fqn":"Events.InputValue","slug":"input-value","actions":[],"properties":[{"name":"inputName","slug":"input-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the form input."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Value of the form input, when there is just one value."},{"name":"values","slug":"values","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Values of the form input, when there are multiple values."}]},"Events.Invoice":{"name":"Invoice","fqn":"Events.Invoice","slug":"invoice","actions":[],"properties":[{"name":"discount","slug":"discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Discount","referenceFqn":"Events.Discount"},"description":"Invoice applied discount."},{"name":"fees","slug":"fees","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Fee","referenceFqn":"Events.Fee"}},"description":"Invoice applied fee charges."},{"name":"grandTotal","slug":"grand-total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Money","referenceFqn":"Events.Money"},"description":"Invoice total amount after discount, tax, and fees.\r\n Grand total is calculated in the following manner:\r\n\r\n 1. Total price of all items in the cart.\r\n 2. Discount is subtracted from the cart (if applicable).\r\n 3. Tax is added (if applicable).\r\n 4. Wix service fee is added."},{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"InvoiceItem","referenceFqn":"Events.InvoiceItem"}},"description":"Invoice items."},{"name":"revenue","slug":"revenue","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Money","referenceFqn":"Events.Money"},"description":"Total revenue with taxes, excluding fees. Payment provider fees are not deducted."},{"name":"subTotal","slug":"sub-total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Money","referenceFqn":"Events.Money"},"description":"Invoice total amount before discount, tax, and fees."},{"name":"tax","slug":"tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Tax","referenceFqn":"Events.Tax"},"description":"Invoice applied tax."}]},"Events.Discount":{"name":"Discount","fqn":"Events.Discount","slug":"discount","actions":[],"properties":[{"name":"afterDiscount","slug":"after-discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Money","referenceFqn":"Events.Money"},"description":"Amount after discount."},{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Money","referenceFqn":"Events.Money"},"description":"Discount amount."},{"name":"discounts","slug":"discounts","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DiscountItem","referenceFqn":"Events.DiscountItem"}},"description":"Discount items."}]},"Events.Money":{"name":"Money","fqn":"Events.Money","slug":"money","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Decimal amount."},{"name":"currency","slug":"currency","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Currency code. Must be a valid [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code (for example, `USD`)."}]},"Events.DiscountItem":{"name":"DiscountItem","fqn":"Events.DiscountItem","slug":"discount-item","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Money","referenceFqn":"Events.Money"},"description":"Discount amount."},{"name":"coupon","slug":"coupon","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountCoupon","referenceFqn":"Events.DiscountCoupon"},"description":"Discount coupon."},{"name":"paidPlan","slug":"paid-plan","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PricingPlanDiscount","referenceFqn":"Events.PricingPlanDiscount"},"description":"Pricing plan discount."}]},"Events.DiscountCoupon":{"name":"DiscountCoupon","fqn":"Events.DiscountCoupon","slug":"discount-coupon","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon code."},{"name":"couponId","slug":"coupon-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon ID."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon name."}]},"Events.PricingPlanDiscount":{"name":"PricingPlanDiscount","fqn":"Events.PricingPlanDiscount","slug":"pricing-plan-discount","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Pricing plan name."},{"name":"percentDiscount","slug":"percent-discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PercentDiscount","referenceFqn":"Events.PercentDiscount"},"description":"Percentage applied discount."}]},"Events.PercentDiscount":{"name":"PercentDiscount","fqn":"Events.PercentDiscount","slug":"percent-discount","actions":[],"properties":[{"name":"quantityDiscounted","slug":"quantity-discounted","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of discounted items."},{"name":"rate","slug":"rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Discount rate percentage. Possible values are between `\"0.01\"` and `\"100\"`, using up to 2 decimal places."}]},"Events.Fee":{"name":"Fee","fqn":"Events.Fee","slug":"fee","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Money","referenceFqn":"Events.Money"},"description":"Total amount of fee charges."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Fee name. Value is `\"WIX_FEE\"`: Wix service fee applied to the item."},{"name":"rate","slug":"rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Rate percentage. Possible values are between `\"0.01\"` and `\"100\"`, using up to 2 decimal places."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Fee calculation method.\r\n One of:\r\n\r\n + `\"FEE_ADDED\"`: Fee is added to the ticket price at checkout.\r\n + `\"FEE_INCLUDED\"`: Seller absorbs the fee. It is deducted from the ticket price."}]},"Events.InvoiceItem":{"name":"InvoiceItem","fqn":"Events.InvoiceItem","slug":"invoice-item","actions":[],"properties":[{"name":"discount","slug":"discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Discount","referenceFqn":"Events.Discount"},"description":"Invoice item applied discount."},{"name":"fees","slug":"fees","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Fee","referenceFqn":"Events.Fee"}},"description":"Invoice item applied fee charges."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Invoice item ID."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Invoice item name."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Money","referenceFqn":"Events.Money"},"description":"Invoice item price."},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Invoice item quantity."},{"name":"tax","slug":"tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Tax","referenceFqn":"Events.Tax"},"description":"Invoice item applied tax."},{"name":"total","slug":"total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Money","referenceFqn":"Events.Money"},"description":"Invoice item total."}]},"Events.Tax":{"name":"Tax","fqn":"Events.Tax","slug":"tax","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Money","referenceFqn":"Events.Money"},"description":"Total tax amount."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tax name."},{"name":"rate","slug":"rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Rate percentage. Possible values are between `\"0.01\"` and `\"100\"`, using up to 2 decimal places."},{"name":"taxable","slug":"taxable","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Money","referenceFqn":"Events.Money"},"description":"Taxable amount."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tax type.\r\n One of:\r\n\r\n + `\"INCLUDED\"`: Tax is included in the ticket price.\r\n + `\"ADDED\"`: Tax is added to the order at checkout."}]},"Events.Ticket":{"name":"Ticket","fqn":"Events.Ticket","slug":"ticket","actions":[],"properties":[{"name":"archived","slug":"archived","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the ticket is archived."},{"name":"checkIn","slug":"check-in","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckIn","referenceFqn":"Events.CheckIn"},"description":"Ticket check-in."},{"name":"confirmed","slug":"confirmed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the ticket is confirmed."},{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID associated with this ticket."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Guest email address."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Guest first name."},{"name":"form","slug":"form","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FormResponse","referenceFqn":"Events.FormResponse"},"description":"Ticket form response. Only assigned tickets contain a separate form."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Guest last name."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID associated with this ticket."},{"name":"ticketDefinitionId","slug":"ticket-definition-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket definition ID."},{"name":"ticketNumber","slug":"ticket-number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique ticket number."}]},"Events.CheckIn":{"name":"CheckIn","fqn":"Events.CheckIn","slug":"check-in","actions":[],"properties":[{"name":"created","slug":"created","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time guest was checked-in."}]},"Events.OrderDeletedEvent":{"name":"OrderDeletedEvent","fqn":"Events.OrderDeletedEvent","slug":"order-deleted-event","actions":[],"properties":[{"name":"anonymized","slug":"anonymized","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the order was anonymized by a GDPR delete."},{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID associated with this order."},{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID associated with this order."},{"name":"orderNumber","slug":"order-number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique order number."},{"name":"orderType","slug":"order-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Order type.\r\n One of:\r\n\r\n + `\"UNASSIGNED_TICKETS\"`: Buyer form is used for all tickets.\r\n + `\"ASSIGNED_TICKETS\"`: Each order ticket has its own form."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time order was deleted."}]},"Events.OrderInitiatedEvent":{"name":"OrderInitiatedEvent","fqn":"Events.OrderInitiatedEvent","slug":"order-initiated-event","actions":[],"properties":[{"name":"checkoutForm","slug":"checkout-form","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FormResponse","referenceFqn":"Events.FormResponse"},"description":"Checkout form response."},{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID associated with this order."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer email."},{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer first name."},{"name":"invoice","slug":"invoice","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Invoice","referenceFqn":"Events.Invoice"},"description":"Order invoice."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer last name."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID associated with this order."},{"name":"orderNumber","slug":"order-number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique order number."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Order status.\r\n One of:\r\n\r\n + `\"FREE\"`: Order is confirmed, no payment required.\r\n + `\"PENDING\"`: Order was paid, but the payment provider suspended the payment. Eventually changes to `\"PAID\"`.\r\n + `\"PAID\"`: Order paid using the payment provider.\r\n + `\"OFFLINE_PENDING\"`: Order confirmed, but has to be paid offline and status needs to be manually updated to `\"PAID\"`.\r\n + `\"INITIATED\"`: Order is awaiting payment."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time order was initiated."}]},"Events.OrderUpdatedEvent":{"name":"OrderUpdatedEvent","fqn":"Events.OrderUpdatedEvent","slug":"order-updated-event","actions":[],"properties":[{"name":"archived","slug":"archived","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the order is archived."},{"name":"checkoutForm","slug":"checkout-form","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FormResponse","referenceFqn":"Events.FormResponse"},"description":"Checkout form response."},{"name":"confirmed","slug":"confirmed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the order is confirmed An order gets confirmed\r\n when the payment gateway processes the payment and the funds reach the merchant's account."},{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID associated with this order."},{"name":"created","slug":"created","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time order was created."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer email."},{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer first name."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer last name."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID associated with this order."},{"name":"method","slug":"method","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Payment method used. For example, \"payPal\" or \"creditCard\"."},{"name":"orderNumber","slug":"order-number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique order number."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Order status.\r\n One of:\r\n\r\n + `\"FREE\"`: Order is confirmed, no payment required.\r\n + `\"PENDING\"`: Order was paid, but the payment provider suspended the payment. Eventually changes to `\"PAID\"`.\r\n + `\"PAID\"`: Order paid using the payment provider.\r\n + `\"OFFLINE_PENDING\"`: Order confirmed, but has to be paid offline and status needs to be manually updated to `\"PAID\"`.\r\n + `\"INITIATED\"`: Order is awaiting payment."},{"name":"tickets","slug":"tickets","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Ticket","referenceFqn":"Events.Ticket"}},"description":"Tickets generated after payment."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time order was updated."}]},"Events.ReservationCreatedEvent":{"name":"ReservationCreatedEvent","fqn":"Events.ReservationCreatedEvent","slug":"reservation-created-event","actions":[],"properties":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"expires","slug":"expires","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time reservation expires."},{"name":"reservationId","slug":"reservation-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Reservation ID. Can be used to retrieve an invoice."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Reservation status.\r\n One of:\r\n\r\n + `\"RESERVATION_PENDING\"`: Reservation is pending confirmation. It will expire after expiration due time.\r\n + `\"RESERVATION_CONFIRMED\"`: Reservation was confirmed and will not expire.\r\n + `\"RESERVATION_CANCELED\"`: Reservation was canceled because of non payment.\r\n + `\"RESERVATION_CANCELED_MANUALLY\"`: Reservation was canceled manually by the buyer."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time tickets were reserved."}]},"Events.ReservationUpdatedEvent":{"name":"ReservationUpdatedEvent","fqn":"Events.ReservationUpdatedEvent","slug":"reservation-updated-event","actions":[],"properties":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"reservationId","slug":"reservation-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Reservation ID. Can be used to retrieve an invoice."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Reservation status.\r\n One of:\r\n\r\n + `\"RESERVATION_PENDING\"`: Reservation is pending confirmation. It will expire after expiration due time.\r\n + `\"RESERVATION_CONFIRMED\"`: Reservation was confirmed and will not expire.\r\n + `\"RESERVATION_CANCELED\"`: Reservation was canceled because of non payment.\r\n + `\"RESERVATION_CANCELED_MANUALLY\"`: Reservation was canceled manually by the buyer."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time tickets were reserved."}]},"Events.RsvpCreatedEvent":{"name":"RsvpCreatedEvent","fqn":"Events.RsvpCreatedEvent","slug":"rsvp-created-event","actions":[],"properties":[{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID associated with the RSVP."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Guest email address."},{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Guest first name."},{"name":"guests","slug":"guests","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Guest","referenceFqn":"Events.Guest"}},"description":"List of guests."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Guest last name."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID associated with the RSVP."},{"name":"rsvpForm","slug":"rsvp-form","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FormResponse","referenceFqn":"Events.FormResponse"},"description":"RSVP form response."},{"name":"rsvpId","slug":"rsvp-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"RSVP ID."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"RSVP response status.\r\n One of:\r\n\r\n + `\"YES\"`: Guest is attending.\r\n + `\"NO\"`: Guest is not attending.\r\n + `\"WAITING\"`: Guest added to the wait list."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time the RSVP was created."}]},"Events.Guest":{"name":"Guest","fqn":"Events.Guest","slug":"guest","actions":[],"properties":[{"name":"fullName","slug":"full-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Full name of the guest."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Guest ID, which is unique within the RSVP."},{"name":"index","slug":"index","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Index of the guest in the RSVP guest list. Indices are zero-based."}]},"Events.RsvpDeletedEvent":{"name":"RsvpDeletedEvent","fqn":"Events.RsvpDeletedEvent","slug":"rsvp-deleted-event","actions":[],"properties":[{"name":"anonymized","slug":"anonymized","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the RSVP was anonymized as a result of a GDPR delete."},{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID associated with this RSVP."},{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID associated with this RSVP."},{"name":"rsvpId","slug":"rsvp-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"RSVP ID."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time RSVP was deleted."}]},"Events.RsvpUpdatedEvent":{"name":"RsvpUpdatedEvent","fqn":"Events.RsvpUpdatedEvent","slug":"rsvp-updated-event","actions":[],"properties":[{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID associated with this RSVP."},{"name":"created","slug":"created","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time the RSVP was created."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Guest email."},{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Guest first name."},{"name":"guests","slug":"guests","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Guest","referenceFqn":"Events.Guest"}},"description":"List of guests."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Guest last name."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID associated with this RSVP."},{"name":"rsvpForm","slug":"rsvp-form","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FormResponse","referenceFqn":"Events.FormResponse"},"description":"RSVP form response."},{"name":"rsvpId","slug":"rsvp-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"RSVP ID."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"RSVP response status.\r\n One of:\r\n\r\n + `\"YES\"`: Guest is attending.\r\n + `\"NO\"`: Guest is not attending.\r\n + `\"WAITING\"`: Guest added to the wait list."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time the RSVP was updated."}]},"Events.TicketDefinitionCreatedEvent":{"name":"TicketDefinitionCreatedEvent","fqn":"Events.TicketDefinitionCreatedEvent","slug":"ticket-definition-created-event","actions":[],"properties":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"ticketDefinitionId","slug":"ticket-definition-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket definition ID."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time ticket definition was created."}]},"Events.TicketDefinitionDeletedEvent":{"name":"TicketDefinitionDeletedEvent","fqn":"Events.TicketDefinitionDeletedEvent","slug":"ticket-definition-deleted-event","actions":[],"properties":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"ticketDefinitionId","slug":"ticket-definition-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket definition ID."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time ticket definition was deleted."}]},"Events.TicketDefinitionUpdatedEvent":{"name":"TicketDefinitionUpdatedEvent","fqn":"Events.TicketDefinitionUpdatedEvent","slug":"ticket-definition-updated-event","actions":[],"properties":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"ticketDefinitionId","slug":"ticket-definition-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket definition ID."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time ticket definition was updated."}]},"Events.CanceledWixEvent":{"name":"CanceledWixEvent","fqn":"Events.CanceledWixEvent","slug":"canceled-wix-event","actions":[],"properties":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Time the event was canceled."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event title."}]}},"standaloneTypes":[],"metadata":{},"actions":[],"webhooks":[],"namespaces":[{"name":"Events","slug":"events","fqn":"Events","standaloneTypes":[],"metadata":{},"actions":[{"name":"onEventCanceled","fqn":"Events.onEventCanceled","slug":"on-event-canceled","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when an existing Wix event is canceled","content":"// Place this code in the events.js file\n// of your site's Backend section. \n// Add the file if it doesn't exist.\n\nexport function wixEvents_onEventCanceled(event) {\n let eventId = event.eventId;\n let title = event.title;\n}\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-26T13:57:50.699Z\",\n * \"eventId\": \"46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b\",\n * \"title\": \"My event\",\n * \"userId\": \"01cb99e2-e969-421a-b65f-43bea2a66fa1\"\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CanceledEvent","referenceFqn":"Events.CanceledEvent"},"description":"Information about the event that was canceled."}],"description":"A backend event that fires when a Wix event is canceled.\r\n\r\nThe `onEventCanceled()` event handler runs when an existing Wix event is canceled.\r\n The received `CanceledEvent` object contains information about the event that was canceled.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onEventCreated","fqn":"Events.onEventCreated","slug":"on-event-created","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when a new Wix event is created","content":"// Place this code in the events.js file\n// of your site's Backend section. \n// Add the file if it doesn't exist.\n\nexport function wixEvents_onEventCreated(event) {\n let eventId = event.eventId;\n let title = event.title;\n}\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-26T13:57:50.699Z\",\n * \"eventId\": \"46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b\",\n * \"location\": {\n * \"name\": \"Wix Playground\",\n * \"coordinates\": {\n * \"lat\": 40.739254,\n * \"lng\": -74.008925\n * },\n * \"address\": \"100 Gansevoort St, New York, NY 10014, USA\",\n * \"type\": \"VENUE\"\n * },\n * \"scheduleConfig\": {\n * \"scheduleTbd\": false,\n * \"scheduleTbdMessage\": \"\",\n * \"startDate\": \"2020-05-10T16:00:00.000Z\",\n * \"endDate\": \"2020-05-10T20:00:00.000Z\",\n * \"timeZoneId\": \"EST\"\n * },\n * \"title\": \"My event\",\n * \"userId\": \"01cb99e2-e969-421a-b65f-43bea2a66fa1\"\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CreatedEvent","referenceFqn":"Events.CreatedEvent"},"description":"Information about the event that was created."}],"description":"A backend event that fires when a Wix event is created or copied.\r\n\r\nThe `onEventCreated()` event handler runs when a Wix event is created or copied in your site.\r\n The received `CreatedEvent` object contains information about the new Wix event that was created/copied.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onEventDeleted","fqn":"Events.onEventDeleted","slug":"on-event-deleted","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when an existing Wix event is deleted","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixEvents_onEventDeleted(event) {\n let eventId = event.eventId;\n let title = event.title;\n}\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-26T13:57:50.699Z\",\n * \"eventId\": \"46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b\",\n * \"title\": \"My event\",\n * \"userId\": \"01cb99e2-e969-421a-b65f-43bea2a66fa1\"\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeletedEvent","referenceFqn":"Events.DeletedEvent"},"description":"Information about the event that was deleted."}],"description":"A backend event that fires when a Wix event is deleted.\r\n\r\nThe `onEventDeleted()` event handler runs when an existing event is deleted.\r\n The received `DeletedEvent` object contains information about the event that was deleted.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onEventEnded","fqn":"Events.onEventEnded","slug":"on-event-ended","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when a Wix event ends","content":"// Place this code in the events.js file\n// of your site's Backend section. \n// Add the file if it doesn't exist.\n\nexport function wixEvents_onEventEnded(event) {\n let eventId = event.eventId;\n let title = event.title;\n}\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-26T13:57:50.699Z\",\n * \"eventId\": \"46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b\",\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EndedEvent","referenceFqn":"Events.EndedEvent"},"description":"Information about the event that has ended."}],"description":"A backend event that fires when a Wix event ends.\r\n\r\nThe `onEventEnded()` event handler runs when a Wix event ends.\r\n The received `EndedEvent` object contains information about the ended event.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onEventReminder","fqn":"Events.onEventReminder","slug":"on-event-reminder","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when a Wix event's reminders are sent","content":"// Place this code in the events.js file\n// of your site's Backend section. \n// Add the file if it doesn't exist.\n\nexport function wixEvents_onEventReminder(event) {\n let eventId = event.eventId;\n let title = event.title;\n}\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-26T13:57:50.699Z\",\n * \"eventId\": \"46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b\",\n * \"location\": {\n * \"name\": \"Wix Playground\",\n * \"coordinates\": {\n * \"lat\": 40.739254,\n * \"lng\": -74.008925\n * },\n * \"address\": \"100 Gansevoort St, New York, NY 10014, USA\",\n * \"type\": \"VENUE\"\n * },\n * \"scheduleConfig\": {\n * \"scheduleTbd\": false,\n * \"scheduleTbdMessage\": \"\",\n * \"startDate\": \"2020-05-10T16:00:00.000Z\",\n * \"endDate\": \"2020-05-10T20:00:00.000Z\",\n * \"timeZoneId\": \"EST\"\n * },\n * \"title\": \"My event\",\n * \"userId\": \"01cb99e2-e969-421a-b65f-43bea2a66fa1\",\n * \"startsIn\": {\n * \"days\": 3,\n * \"hours\": 0,\n * \"minutes\": 0\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventReminder","referenceFqn":"Events.EventReminder"},"description":"Information about the event that the reminder was sent for."}],"description":"A backend event that fires when a Wix event's reminders are sent.\r\n\r\nThe `onEventReminder()` event handler runs when a Wix event is set to have a reminder\r\n and the time of the reminder arrives.\r\n The received `EventReminder` object contains information about the event.\r\n\r\n Configure when the reminder is sent in the site dashboard.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onEventStarted","fqn":"Events.onEventStarted","slug":"on-event-started","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when a Wix event starts","content":"// Place this code in the events.js file\n// of your site's Backend section. \n// Add the file if it doesn't exist.\n\nexport function wixEvents_onEventStarted(event) {\n let eventId = event.eventId;\n let title = event.title;\n}\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-26T13:57:50.699Z\",\n * \"eventId\": \"46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b\"\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StartedEvent","referenceFqn":"Events.StartedEvent"},"description":"Information about the event that has started."}],"description":"A backend event that fires when a Wix event starts.\r\n\r\nThe `onEventStarted()` event handler runs when a Wix event starts.\r\n The received `StartedEvent` object contains information about the started event.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onEventUpdated","fqn":"Events.onEventUpdated","slug":"on-event-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when an existing Wix event is updated","content":"// Place this code in the events.js file\n// of your site's Backend section. \n// Add the file if it doesn't exist.\n\nexport function wixEvents_onEventUpdated(event) {\n let eventId = event.eventId;\n let title = event.title;\n}\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-26T13:57:50.699Z\",\n * \"eventId\": \"46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b\",\n * \"location\": {\n * \"name\": \"Wix Playground\",\n * \"coordinates\": {\n * \"lat\": 40.739254,\n * \"lng\": -74.008925\n * },\n * \"address\": \"100 Gansevoort St, New York, NY 10014, USA\",\n * \"type\": \"VENUE\"\n * },\n * \"scheduleConfig\": {\n * \"scheduleTbd\": false,\n * \"scheduleTbdMessage\": \"\",\n * \"startDate\": \"2020-05-10T16:00:00.000Z\",\n * \"endDate\": \"2020-05-10T20:00:00.000Z\",\n * \"timeZoneId\": \"EST\"\n * },\n * \"title\": \"My event\",\n * \"scheduleConfigUpdated\": true\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdatedEvent","referenceFqn":"Events.UpdatedEvent"},"description":"Information about the event that was updated."}],"description":"A backend event that fires when an existing Wix event is updated.\r\n\r\nThe `onEventUpdated()` event handler runs when an existing Wix event is updated.\r\n The received `UpdatedEvent` object contains information about the event that was updated.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onOrderConfirmed","fqn":"Events.onOrderConfirmed","slug":"on-order-confirmed","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when a ticket order is confirmed","content":"// Place this code in the events.js file\n// of your site's Backend section. \n// Add the file if it doesn't exist.\n\nexport function wixEvents_onOrderConfirmed(event) {\n let eventId = event.eventId;\n let orderNumber = event.orderNumber;\n let status = event.status;\n\n let buyerFirstName = event.firstName;\n let buyerLastName = event.lastName;\n let buyerEmail = event.email;\n\n let invoice = event.invoice;\n let grandTotal = invoice.grandTotal;\n\n let tickets = event.tickets;\n let firstTicket = tickets[0];\n let secondTicket = tickets[1];\n}\n\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-28T12:23:57.154Z\",\n * \"eventId\": \"566e7be9-1410-4095-ae7a-349a4ac95c6b\",\n * \"orderNumber\": \"FMXC-BZG3-OT\",\n * \"contactId\": \"eea3ac0f-f9e6-4ed3-a135-99743c8e90b8\",\n * \"memberId\": \"b272b0bb-d013-415a-8461-e8a175fe8dc6\",\n * \"created\": \"2020-04-28T12:23:51.523Z\",\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\": \"john.doe@somedomain.com\",\n * \"status\": \"PAID\",\n * \"method\": \"payPal\",\n * \"checkoutForm\": {\n * \"inputValues\": [\n * {\n * \"inputName\": \"firstName\",\n * \"value\": \"John\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"lastName\",\n * \"value\": \"Doe\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"email\",\n * \"value\": \"john.doe@somedomain.com\",\n * \"values\": []\n * }\n * ]\n * },\n * \"tickets\": [\n * {\n * \"ticketNumber\": \"FMXC-BZG3-OT021\",\n * \"ticketDefinitionId\": \"d72874cb-012a-4ad2-afbb-57fe8cf1e308\",\n * \"price\": {\n * \"amount\": \"123.00\",\n * \"currency\": \"USD\"\n * },\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\": \"john.doe@somedomain.com\",\n * \"contactId\": \"eea3ac0f-f9e6-4ed3-a135-99743c8e90b8\",\n * \"memberId\": \"b272b0bb-d013-415a-8461-e8a175fe8dc6\",\n * \"confirmed\": true,\n * \"form\": {\n * \"inputValues\": [\n * {\n * \"inputName\": \"custom\",\n * \"value\": \"Another comment\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"email\",\n * \"value\": \"john.doe@somedomain.com\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"lastName\",\n * \"value\": \"Doe\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"firstName\",\n * \"value\": \"John\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"date\",\n * \"value\": \"2020-04-28\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"comment\",\n * \"value\": \"Comment\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"address\",\n * \"value\": \"\",\n * \"values\": [\n * \"Wix Playground, 100 Gansevoort St\",\n * \"New York City\",\n * \"New York\",\n * \"USA\",\n * \"NY 10014\"\n * ]\n * },\n * {\n * \"inputName\": \"phone\",\n * \"value\": \"(555) 555-1234\",\n * \"values\": []\n * }\n * ]\n * }\n * },\n * {\n * \"ticketNumber\": \"FMXC-BZG3-OT041\",\n * \"ticketDefinitionId\": \"9c3dc432-f1a6-408f-82d8-4f64c7ff581b\",\n * \"price\": {\n * \"amount\": \"0.00\",\n * \"currency\": \"USD\"\n * },\n * \"firstName\": \"Jane\",\n * \"lastName\": \"Doe\",\n * \"email\": \"jane.doe@somedomain.com\",\n * \"contactId\": \"e11af3d4-c205-4d3a-b687-58d4dda78a6c\",\n * \"memberId\": \"62bc4004-548c-46ad-a699-55ef307273e3\",\n * \"confirmed\": true,\n * \"form\": {\n * \"inputValues\": [\n * {\n * \"inputName\": \"custom\",\n * \"value\": \"Another comment\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"email\",\n * \"value\": \"jane.doe@somedomain.com\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"lastName\",\n * \"value\": \"Doe\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"firstName\",\n * \"value\": \"Jane\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"date\",\n * \"value\": \"2020-04-28\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"comment\",\n * \"value\": \"Comment\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"address\",\n * \"value\": \"\",\n * \"values\": [\n * \"Wix Playground, 100 Gansevoort St\",\n * \"New York City\",\n * \"New York\",\n * \"USA\",\n * \"NY 10014\"\n * ]\n * },\n * {\n * \"inputName\": \"phone\",\n * \"value\": \"(555) 555-1234\",\n * \"values\": []\n * }\n * ]\n * }\n * }\n * ],\n * \"invoice\": {\n * \"items\": [\n * {\n * \"id\": \"d72874cb-012a-4ad2-afbb-57fe8cf1e308\",\n * \"quantity\": 1,\n * \"name\": \"VIP\",\n * \"price\": {\n * \"amount\": \"123.00\",\n * \"currency\": \"USD\"\n * },\n * \"total\": {\n * \"amount\": \"123.00\",\n * \"currency\": \"USD\"\n * },\n * \"fees\": [\n * {\n * \"type\": \"FEE_INCLUDED\",\n * \"rate\": \"2.5\",\n * \"amount\": {\n * \"amount\": \"3.08\",\n * \"currency\": \"USD\"\n * }\n * }\n * ]\n * },\n * {\n * \"id\": \"9c3dc432-f1a6-408f-82d8-4f64c7ff581b\",\n * \"quantity\": 1,\n * \"name\": \"Free\",\n * \"price\": {\n * \"amount\": \"0.00\",\n * \"currency\": \"USD\"\n * },\n * \"total\": {\n * \"amount\": \"0.00\",\n * \"currency\": \"USD\"\n * },\n * \"fees\": [\n * {\n * \"rate\": \"2.5\",\n * \"amount\": {\n * \"amount\": \"0.00\",\n * \"currency\": \"USD\"\n * }\n * }\n * ]\n * }\n * ],\n * \"fees\": [\n * {\n * \"rate\": \"2.5\",\n * \"amount\": {\n * \"amount\": \"0.00\",\n * \"currency\": \"USD\"\n * }\n * },\n * {\n * \"type\": \"FEE_INCLUDED\",\n * \"rate\": \"2.5\",\n * \"amount\": {\n * \"amount\": \"3.08\",\n * \"currency\": \"USD\"\n * }\n * }\n * ],\n * \"subTotal\": {\n * \"amount\": \"123.00\",\n * \"currency\": \"USD\"\n * },\n * \"grandTotal\": {\n * \"amount\": \"123.00\",\n * \"currency\": \"USD\"\n * },\n * \"revenue\": {\n * \"amount\": \"119.92\",\n * \"currency\": \"USD\"\n * }\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderConfirmedEvent","referenceFqn":"Events.OrderConfirmedEvent"},"description":"Information about the ticket order that was confirmed."}],"description":"A backend event that fires when a ticket order is confirmed.\r\n\r\nThe `onOrderConfirmed()` event handler runs when a ticket order is confirmed.\r\n The received `OrderConfirmedEvent`\r\n object contains information about the confirmed ticket order.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onOrderDeleted","fqn":"Events.onOrderDeleted","slug":"on-order-deleted","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when a ticket order is deleted","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixEvents_onOrderDeleted(event) {\n let eventId = event.eventId;\n let orderNumber = event.orderNumber;\n}\n\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-28T12:24:29.768Z\",\n * \"eventId\": \"566e7be9-1410-4095-ae7a-349a4ac95c6b\",\n * \"orderNumber\": \"FMXC-BZG3-OT\",\n * \"contactId\": \"eea3ac0f-f9e6-4ed3-a135-99743c8e90b8\",\n * \"memberId\": \"b272b0bb-d013-415a-8461-e8a175fe8dc6\",\n * \"anonymized\": true,\n * \"orderType\": \"ASSIGNED_TICKETS\"\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderDeletedEvent","referenceFqn":"Events.OrderDeletedEvent"},"description":"Information about the ticket order that was deleted."}],"description":"A backend event that fires when a ticket order is deleted.\r\n\r\nThe `onOrderDeleted()` event handler runs when a ticket order is deleted.\r\n The received `OrderDeletedEvent`\r\n object contains information about the deleted order.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onOrderInitiated","fqn":"Events.onOrderInitiated","slug":"on-order-initiated","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when a ticket order is initiated","content":"// Place this code in the events.js file\n// of your site's Backend section. \n// Add the file if it doesn't exist.\n\nexport function wixEvents_onOrderInitiated(event) {\n let eventId = event.eventId;\n let orderNumber = event.orderNumber;\n let status = event.status;\n\n let buyerFirstName = event.firstName;\n let buyerLastName = event.lastName;\n let buyerEmail = event.email;\n\n let invoice = event.invoice;\n let grandTotal = invoice.grandTotal;\n}\n\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-28T12:23:51.523Z\",\n * \"eventId\": \"566e7be9-1410-4095-ae7a-349a4ac95c6b\",\n * \"orderNumber\": \"FMXC-BZG3-OT\",\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\": \"john.doe@somedomain.com\",\n * \"status\": \"INITIATED\",\n * \"checkoutForm\": {\n * \"inputValues\": [\n * {\n * \"inputName\": \"firstName\",\n * \"value\": \"John\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"lastName\",\n * \"value\": \"Doe\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"email\",\n * \"value\": \"john.doe@somedomain.com\",\n * \"values\": []\n * }\n * ]\n * },\n * \"invoice\": {\n * \"items\": [\n * {\n * \"id\": \"d72874cb-012a-4ad2-afbb-57fe8cf1e308\",\n * \"quantity\": 1,\n * \"name\": \"VIP\",\n * \"price\": {\n * \"amount\": \"123.00\",\n * \"currency\": \"USD\"\n * },\n * \"total\": {\n * \"amount\": \"123.00\",\n * \"currency\": \"USD\"\n * },\n * \"fees\": [\n * {\n * \"type\": \"FEE_INCLUDED\",\n * \"rate\": \"2.5\",\n * \"amount\": {\n * \"amount\": \"3.08\",\n * \"currency\": \"USD\"\n * }\n * }\n * ]\n * },\n * {\n * \"id\": \"9c3dc432-f1a6-408f-82d8-4f64c7ff581b\",\n * \"quantity\": 1,\n * \"name\": \"Free\",\n * \"price\": {\n * \"amount\": \"0.00\",\n * \"currency\": \"USD\"\n * },\n * \"total\": {\n * \"amount\": \"0.00\",\n * \"currency\": \"USD\"\n * },\n * \"fees\": [\n * {\n * \"rate\": \"2.5\",\n * \"amount\": {\n * \"amount\": \"0.00\",\n * \"currency\": \"USD\"\n * }\n * }\n * ]\n * }\n * ],\n * \"fees\": [\n * {\n * \"rate\": \"2.5\",\n * \"amount\": {\n * \"amount\": \"0.00\",\n * \"currency\": \"USD\"\n * }\n * },\n * {\n * \"type\": \"FEE_INCLUDED\",\n * \"rate\": \"2.5\",\n * \"amount\": {\n * \"amount\": \"3.08\",\n * \"currency\": \"USD\"\n * }\n * }\n * ],\n * \"subTotal\": {\n * \"amount\": \"123.00\",\n * \"currency\": \"USD\"\n * },\n * \"grandTotal\": {\n * \"amount\": \"123.00\",\n * \"currency\": \"USD\"\n * },\n * \"revenue\": {\n * \"amount\": \"119.92\",\n * \"currency\": \"USD\"\n * }\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderInitiatedEvent","referenceFqn":"Events.OrderInitiatedEvent"},"description":"Information about the ticket order that was initiated."}],"description":"A backend event that fires when a ticket order is initiated.\r\n\r\nThe `onOrderInitiated()` event handler runs when a ticket order is initiated.\r\n The received `OrderInitiatedEvent`\r\n object contains information about the initiated ticket order.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onOrderUpdated","fqn":"Events.onOrderUpdated","slug":"on-order-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when a ticket order is updated","content":"// Place this code in the events.js file\n// of your site's Backend section. \n// Add the file if it doesn't exist.\n\nexport function wixEvents_onOrderUpdated(event) {\n let eventId = event.eventId;\n let orderNumber = event.orderNumber;\n let status = event.status;\n\n let buyerFirstName = event.firstName;\n let buyerLastName = event.lastName;\n let buyerEmail = event.email;\n\n let invoice = event.invoice;\n let grandTotal = invoice.grandTotal;\n\n let tickets = event.tickets;\n let firstTicket = tickets[0];\n let secondTicket = tickets[1];\n}\n\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-28T12:24:29.768Z\",\n * \"eventId\": \"566e7be9-1410-4095-ae7a-349a4ac95c6b\",\n * \"orderNumber\": \"FMXC-BZG3-OT\",\n * \"contactId\": \"eea3ac0f-f9e6-4ed3-a135-99743c8e90b8\",\n * \"memberId\": \"b272b0bb-d013-415a-8461-e8a175fe8dc6\",\n * \"created\": \"2020-04-28T12:23:51.523Z\",\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\": \"john.doe@somedomain.com\",\n * \"confirmed\": true,\n * \"status\": \"PAID\",\n * \"method\": \"payPal\",\n * \"archived\": false,\n * \"checkoutForm\": {\n * \"inputValues\": [\n * {\n * \"inputName\": \"firstName\",\n * \"value\": \"John\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"lastName\",\n * \"value\": \"Doe\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"email\",\n * \"value\": \"john.doe@somedomain.com\",\n * \"values\": []\n * }\n * ]\n * },\n * \"tickets\": [\n * {\n * \"ticketNumber\": \"FMXC-BZG3-OT021\",\n * \"ticketDefinitionId\": \"d72874cb-012a-4ad2-afbb-57fe8cf1e308\",\n * \"checkIn\": {\n * \"created\": \"2020-04-28T12:24:20.102Z\"\n * },\n * \"price\": {\n * \"amount\": \"123.00\",\n * \"currency\": \"USD\"\n * },\n * \"archived\": false,\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\": \"john.doe@somedomain.com\",\n * \"contactId\": \"eea3ac0f-f9e6-4ed3-a135-99743c8e90b8\",\n * \"memberId\": \"b272b0bb-d013-415a-8461-e8a175fe8dc6\",\n * \"confirmed\": true,\n * \"form\": {\n * \"inputValues\": [\n * {\n * \"inputName\": \"custom\",\n * \"value\": \"Another comment\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"email\",\n * \"value\": \"john.doe@somedomain.com\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"lastName\",\n * \"value\": \"Doe\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"firstName\",\n * \"value\": \"John\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"date\",\n * \"value\": \"2020-04-28\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"comment\",\n * \"value\": \"Comment\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"address\",\n * \"value\": \"\",\n * \"values\": [\n * \"Wix Playground, 100 Gansevoort St\",\n * \"New York City\",\n * \"New York\",\n * \"USA\",\n * \"NY 10014\"\n * ]\n * },\n * {\n * \"inputName\": \"phone\",\n * \"value\": \"(555) 555-1234\",\n * \"values\": []\n * }\n * ]\n * }\n * },\n * {\n * \"ticketNumber\": \"FMXC-BZG3-OT041\",\n * \"ticketDefinitionId\": \"9c3dc432-f1a6-408f-82d8-4f64c7ff581b\",\n * \"price\": {\n * \"amount\": \"0.00\",\n * \"currency\": \"USD\"\n * },\n * \"archived\": false,\n * \"firstName\": \"Jane\",\n * \"lastName\": \"Doe\",\n * \"email\": \"jane.doe@somedomain.com\",\n * \"contactId\": \"e11af3d4-c205-4d3a-b687-58d4dda78a6c\",\n * \"memberId\": \"62bc4004-548c-46ad-a699-55ef307273e3\",\n * \"confirmed\": true,\n * \"form\": {\n * \"inputValues\": [\n * {\n * \"inputName\": \"custom\",\n * \"value\": \"Another comment\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"email\",\n * \"value\": \"jane.doe@somedomain.com\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"lastName\",\n * \"value\": \"Doe\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"firstName\",\n * \"value\": \"Jane\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"date\",\n * \"value\": \"2020-04-28\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"comment\",\n * \"value\": \"Comment\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"address\",\n * \"value\": \"\",\n * \"values\": [\n * \"Wix Playground, 100 Gansevoort St\",\n * \"New York City\",\n * \"New York\",\n * \"USA\",\n * \"NY 10014\"\n * ]\n * },\n * {\n * \"inputName\": \"phone\",\n * \"value\": \"(555) 555-1234\",\n * \"values\": []\n * }\n * ]\n * }\n * }\n * ]\n * }\n */"},{"title":"Send a triggered email to a customer when an order has expired","description":"This example uses [triggered emails](https://dev.wix.com/docs/develop-websites/articles/workspace-tools/developer-tools/triggered-emails/getting-started-with-triggered-emails). Create a triggered email before trying this example.","content":"/*****************************************\n * Backend code - my-backend-file.web.js *\n *****************************************/\n\nimport { triggeredEmails } from 'wix-crm-backend';\nimport { webMethod, Permissions } from 'wix-web-module';\n\nexport const sendEmailToContact = webMethod(\n Permissions.Anyone, \n async (contactId) => { // Pass the contact ID from the onOrderUpdated event in the event.js code\n const triggeredEmailTemplate = 'myEmail'; // Use your email template name from Triggered Emails\n try {\n await triggeredEmails.emailContact(triggeredEmailTemplate, contactId);\n console.log('Email sent to contact');\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n });\n\n\n/*****************************************\n * Backend code - events.js *\n *****************************************/\n\nimport { sendEmailToContact } from 'backend/my-backend-file.web.js'\n\nexport function wixEvents_onOrderUpdated(event) { // Set the event that fires when an order is updated\n if (event.status === 'CANCELED') { // Send an email only if the order is canceled\n const contactId = event.contactId; // Save the site visitor contact ID from the event payload\n sendEmailToContact(contactId) // Send an email notification when an order is canceled\n }\n}"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderUpdatedEvent","referenceFqn":"Events.OrderUpdatedEvent"},"description":"Information about the ticket order that was updated."}],"description":"A backend event that fires when a ticket order is updated.\r\n\r\nThe `onOrderUpdated()` event handler runs when a ticket order is updated.\r\n The received `OrderUpdatedEvent`\r\n object contains information about the updated ticket order.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onReservationCreated","fqn":"Events.onReservationCreated","slug":"on-reservation-created","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when tickets are reserved","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixEvents_onReservationCreated(event) {\n let eventId = event.eventId;\n let reservationId = event.reservationId;\n}\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-26T13:00:00.000Z\",\n * \"eventId\": \"46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b\",\n * \"reservationId\": \"d72874cb-012a-4ad2-afbb-57fe8cf1e308\",\n * \"expires\": \"2020-04-26T13:20:00.000Z\",\n * \"status\": \"RESERVATION_PENDING\"\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ReservationCreatedEvent","referenceFqn":"Events.ReservationCreatedEvent"},"description":"Information about the ticket reservation that was created."}],"description":"A backend event that fires when a ticket reservation is created.\r\n\r\nThe `onReservationCreated()` event handler runs when a ticket reservation is created.\r\n The received `ReservationCreatedEvent`\r\n object contains information about the created reservation.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onReservationUpdated","fqn":"Events.onReservationUpdated","slug":"on-reservation-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when a ticket reservation is updated","content":"// Place this code in the events.js file\n// of your site's Backend section. \n// Add the file if it doesn't exist.\n\nexport function wixEvents_onReservationUpdated(event) {\n let eventId = event.eventId;\n let reservationId = event.reservationId;\n}\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-26T13:00:00.000Z\",\n * \"eventId\": \"46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b\",\n * \"reservationId\": \"d72874cb-012a-4ad2-afbb-57fe8cf1e308\",\n * \"status\": \"RESERVATION_CONFIRMED\"\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ReservationUpdatedEvent","referenceFqn":"Events.ReservationUpdatedEvent"},"description":"Information about the ticket reservation that was updated."}],"description":"A backend event that fires when a ticket reservation is updated.\r\n\r\nThe `onReservationUpdated()` event handler runs when a ticket reservation is updated.\r\n The received `ReservationUpdatedEvent`\r\n object contains information about the updated reservation.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onRsvpCreated","fqn":"Events.onRsvpCreated","slug":"on-rsvp-created","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when guest registers to a Wix event","content":"// Place this code in the events.js file\n// of your site's Backend section. \n// Add the file if it doesn't exist.\n\nexport function wixEvents_onRsvpCreated(event) {\n let eventId = event.eventId;\n let rsvpId = event.rsvpId;\n let status = event.status;\n\n let firstName = event.firstName;\n let lastName = event.lastName;\n let email = event.email;\n}\n\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-27T12:37:22.444Z\",\n * \"eventId\": \"0adc383d-db6b-4c4a-8fb8-5fe77c6569bb\",\n * \"rsvpId\": \"4160c868-35b8-49f3-bff2-9d3912be9c0a\",\n * \"status\": \"YES\",\n * \"contactId\": \"2b1df22d-cfcf-447e-9afe-27b782aecd8c\",\n * \"memberId\": \"c2b48f6f-5964-46ad-9888-1e9d3f81b83b\",\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\": \"john.doe@somedomain.com\",\n * \"rsvpForm\": {\n * \"inputValues\": [\n * {\n * \"inputName\": \"email\",\n * \"value\": \"john.doe@somedomain.com\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"lastName\",\n * \"value\": \"Doe\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"firstName\",\n * \"value\": \"John\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"date\",\n * \"value\": \"2020-04-27\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"additionalGuests\",\n * \"value\": \"2\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"guestNames\",\n * \"value\": \"\",\n * \"values\": [\n * \"Jane Doe\",\n * \"Baby Doe\"\n * ]\n * },\n * {\n * \"inputName\": \"comment\",\n * \"value\": \"A comment\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"custom\",\n * \"value\": \"Another comment\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"address\",\n * \"value\": \"\",\n * \"values\": [\n * \"Wix Playground, 100 Gansevoort St, New York, NY 10014, USA\"\n * ]\n * },\n * {\n * \"inputName\": \"phone\",\n * \"value\": \"(555) 555-1234\",\n * \"values\": []\n * }\n * ]\n * },\n * \"guests\": [\n * {\n * \"index\": 0,\n * \"fullName\": \"John Doe\",\n * \"id\": 1\n * },\n * {\n * \"index\": 1,\n * \"fullName\": \"Jane Doe\",\n * \"id\": 2\n * },\n * {\n * \"index\": 2,\n * \"fullName\": \"Baby Doe\",\n * \"id\": 3\n * }\n * ]\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RsvpCreatedEvent","referenceFqn":"Events.RsvpCreatedEvent"},"description":"Information about the RSVP that was created."}],"description":"A backend event that fires when a guest registers to a Wix event.\r\n\r\nThe `onRsvpCreated()` event handler runs when a guest registers to a Wix event.\r\n The received `RsvpCreatedEvent` object contains information about the created RSVP.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onRsvpDeleted","fqn":"Events.onRsvpDeleted","slug":"on-rsvp-deleted","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when an RSVP is deleted","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixEvents_onRsvpDeleted(event) {\n let eventId = event.eventId;\n let rsvpId = event.rsvpId;\n}\n\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-27T13:37:22.444Z\",\n * \"eventId\": \"0adc383d-db6b-4c4a-8fb8-5fe77c6569bb\",\n * \"rsvpId\": \"4160c868-35b8-49f3-bff2-9d3912be9c0a\",\n * \"contactId\": \"2b1df22d-cfcf-447e-9afe-27b782aecd8c\",\n * \"memberId\": \"c2b48f6f-5964-46ad-9888-1e9d3f81b83b\",\n * \"anonymized\": false\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RsvpDeletedEvent","referenceFqn":"Events.RsvpDeletedEvent"},"description":"Information about the RSVP that was deleted."}],"description":"A backend event that fires when an RSVP is deleted.\r\n\r\nThe `onRsvpDeleted()` event handler runs when an RSVP is deleted.\r\n The received `RsvpDeletedEvent` object contains information about the deleted RSVP.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onRsvpUpdated","fqn":"Events.onRsvpUpdated","slug":"on-rsvp-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when an RSVP is updated","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixEvents_onRsvpUpdated(event) {\n let eventId = event.eventId;\n let rsvpId = event.rsvpId;\n let status = event.status;\n\n let firstName = event.firstName;\n let lastName = event.lastName;\n let email = event.email;\n}\n\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-27T13:37:22.444Z\",\n * \"eventId\": \"0adc383d-db6b-4c4a-8fb8-5fe77c6569bb\",\n * \"rsvpId\": \"4160c868-35b8-49f3-bff2-9d3912be9c0a\",\n * \"status\": \"YES\",\n * \"contactId\": \"2b1df22d-cfcf-447e-9afe-27b782aecd8c\",\n * \"memberId\": \"c2b48f6f-5964-46ad-9888-1e9d3f81b83b\",\n * \"created\": \"2020-04-27T12:37:22.444Z\",\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\": \"john.doe@somedomain.com\",\n * \"rsvpForm\": {\n * \"inputValues\": [\n * {\n * \"inputName\": \"email\",\n * \"value\": \"john.doe@somedomain.com\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"lastName\",\n * \"value\": \"Doe\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"firstName\",\n * \"value\": \"John\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"date\",\n * \"value\": \"2020-04-27\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"additionalGuests\",\n * \"value\": \"2\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"guestNames\",\n * \"value\": \"\",\n * \"values\": [\n * \"Jane Doe\",\n * \"Baby Doe\"\n * ]\n * },\n * {\n * \"inputName\": \"comment\",\n * \"value\": \"A comment\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"custom\",\n * \"value\": \"Another comment\",\n * \"values\": []\n * },\n * {\n * \"inputName\": \"address\",\n * \"value\": \"\",\n * \"values\": [\n * \"Wix Playground, 100 Gansevoort St, New York, NY 10014, USA\"\n * ]\n * },\n * {\n * \"inputName\": \"phone\",\n * \"value\": \"(555) 555-1234\",\n * \"values\": []\n * }\n * ]\n * },\n * \"guests\": [\n * {\n * \"index\": 0,\n * \"fullName\": \"John Doe\",\n * \"id\": 1\n * },\n * {\n * \"index\": 1,\n * \"fullName\": \"Jane Doe\",\n * \"id\": 2\n * },\n * {\n * \"index\": 2,\n * \"fullName\": \"Baby Doe\",\n * \"id\": 3\n * }\n * ]\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RsvpUpdatedEvent","referenceFqn":"Events.RsvpUpdatedEvent"},"description":"Information about the RSVP that was updated."}],"description":"A backend event that fires when an RSVP is updated.\r\n\r\nThe `onRsvpUpdated()` event handler runs when an RSVP is updated.\r\n The received `RsvpUpdatedEvent` object contains information about the updated RSVP.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onTicketDefinitionCreated","fqn":"Events.onTicketDefinitionCreated","slug":"on-ticket-definition-created","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when a ticket definition is created","content":"// Place this code in the events.js file\n// of your site's Backend section. \n// Add the file if it doesn't exist.\n\nexport function wixEvents_onTicketDefinitionCreated(event) {\n let eventId = event.eventId;\n let ticketDefinitionId = event.ticketDefinitionId;\n}\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-26T13:57:50.699Z\",\n * \"eventId\": \"46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b\",\n * \"ticketDefinitionId\": \"d72874cb-012a-4ad2-afbb-57fe8cf1e308\"\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TicketDefinitionCreatedEvent","referenceFqn":"Events.TicketDefinitionCreatedEvent"},"description":"Information about the ticket definition that was created."}],"description":"A backend event that fires when a ticket definition is created.\r\n\r\nThe `onTicketDefinitionCreated()` event handler runs when a ticket definition is created.\r\n The received `TicketDefinitionCreatedEvent`\r\n object contains information about the created ticket definition.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onTicketDefinitionDeleted","fqn":"Events.onTicketDefinitionDeleted","slug":"on-ticket-definition-deleted","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when a ticket definition is deleted","content":"// Place this code in the events.js file\n// of your site's Backend section. \n// Add the file if it doesn't exist.\n\nexport function wixEvents_onTicketDefinitionDeleted(event) {\n let eventId = event.eventId;\n let ticketDefinitionId = event.ticketDefinitionId;\n}\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-26T13:57:50.699Z\",\n * \"eventId\": \"46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b\",\n * \"ticketDefinitionId\": \"d72874cb-012a-4ad2-afbb-57fe8cf1e308\"\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TicketDefinitionDeletedEvent","referenceFqn":"Events.TicketDefinitionDeletedEvent"},"description":"Information about the ticket definition that was deleted."}],"description":"A backend event that fires when a ticket definition is deleted.\r\n\r\nThe `onTicketDefinitionDeleted()` event handler runs when a ticket definition is deleted.\r\n The received `TicketDefinitionDeletedEvent`\r\n object contains information about the deleted ticket definition.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onTicketDefinitionUpdated","fqn":"Events.onTicketDefinitionUpdated","slug":"on-ticket-definition-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when a ticket definition is updated","content":"// Place this code in the events.js file\n// of your site's Backend section. \n// Add the file if it doesn't exist.\n\nexport function wixEvents_onTicketDefinitionUpdated(event) {\n let eventId = event.eventId;\n let ticketDefinitionId = event.ticketDefinitionId;\n}\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-26T13:57:50.699Z\",\n * \"eventId\": \"46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b\",\n * \"ticketDefinitionId\": \"d72874cb-012a-4ad2-afbb-57fe8cf1e308\"\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TicketDefinitionUpdatedEvent","referenceFqn":"Events.TicketDefinitionUpdatedEvent"},"description":"Information about the ticket definition that was updated."}],"description":"A backend event that fires when a ticket definition is updated.\r\n\r\nThe `onTicketDefinitionUpdated()` event handler runs when a ticket definition is updated.\r\n The received `TicketDefinitionUpdatedEvent`\r\n object contains information about the updated ticket definition.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."},{"name":"onWixEventCanceled","fqn":"Events.onWixEventCanceled","slug":"on-wix-event-canceled","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"A backend event that occurs when an existing Wix event is canceled","content":"// Place this code in the events.js file\n// of your site's Backend section. \n// Add the file if it doesn't exist.\n\nexport function wixEvents_onEventCanceled(event) {\n let eventId = event.eventId;\n let title = event.title;\n}\n\n/* Full event object:\n * {\n * \"timestamp\": \"2020-04-26T13:57:50.699Z\",\n * \"eventId\": \"46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b\",\n * \"title\": \"My event\",\n * \"userId\": \"01cb99e2-e969-421a-b65f-43bea2a66fa1\"\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CanceledWixEvent","referenceFqn":"Events.CanceledWixEvent"},"description":"Information about the Wix event that was canceled."}],"description":"A backend event that fires when a Wix event is canceled.\r\n\r\nThe `onEventCanceled()` event handler runs when an existing Wix event is canceled.\r\n The received `CanceledEvent` object contains information about the event that was canceled.\r\n\r\n> **Note:** Backend events are **not** fired when previewing your site."}],"webhooks":[],"articles":[{"content":"# Introduction\nBackend events are fired in your site's backend when certain changes occur in your site's Wix events.\n You can write event handlers that react to these backend events. Event handler functions\n receive data that corresponds to the backend event that has occurred. Use event handlers\n to create custom responses to the backend events.\n\n > **Note:** For clarity, this reference refers to:\n > + \"backend events\" when discussing events that get fired and are handled by event handlers. \n > + \"Wix events\" when discussing events that people attend.\n\n Backend events are **not** fired when previewing your site.\n\n To add an event handler, add an **events.js** file to the **Backend** section\n of your site if one does not already exist. All event handler functions for your\n site are defined in this file.\n\n Event handler functions are defined using the following pattern:\n\n ```javascript\n export function _(event) { }\n ```\n\n For example, an event handler that handles the start of a site event looks\n like this:\n\n ```javascript\n export function wixEvents_onEventStarted(event) { }\n ```","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"WixEvents","slug":"wix-events","fqn":"WixEvents","standaloneTypes":[],"metadata":{},"actions":[{"name":"cancelEvent","fqn":"WixEvents.cancelEvent","slug":"cancel-event","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["eventId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixEvent","referenceFqn":"WixEvents.WixEvent"},"description":"Fulfilled - The canceled Wix event.\r\nRejected - Error message."},"examples":[{"title":"Cancel a Wix event","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { wixEvents } from 'wix-events-backend';\nimport { elevate } from 'wix-auth';\n\n/* Sample eventId value: '9d720f99-1b5a-4141-9877-d32985391e18'; */\n\nexport const myCancelEventFunction = webMethod(Permissions.Anyone, async (eventId) => {\n try {\n const elevatedCancelEvent = elevate(wixEvents.cancelEvent);\n const canceledEvent = await elevatedCancelEvent(eventId);\n console.log('Success! Canceled event:', canceledEvent);\n return canceledEvent;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n{\n \"about\": \"Learn to handcraft leather goods using saddle stitching techniques, from choosing the leather to sealing the edges.\",\n \"assignedContactsLabel\": \"custom.leather-crafting-101-a-course-by-christina-roth-1-\",\n \"calendarLinks\": {},\n \"categories\": [],\n \"createdBy\": \"8a8b9b73-4da8-47a5-8268-4396e68a0605\",\n \"_createdDate\": \"2023-02-03T10:56:59.721Z\",\n \"description\": \"\",\n \"eventUrl\": {},\n \"form\": {\n \"messages\": {\n \"checkout\": {},\n \"registrationClosed\": {},\n \"rsvp\": {\n \"noMessages\": {},\n \"waitingMessages\": {},\n \"yesMessages\": {}\n }\n }\n },\n \"guestList\": {\n \"public\": true\n },\n \"_id\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"language\": \"en\",\n \"location\": {\n \"address\": {\n \"formatted\": \"Tacoma, WA, USA\",\n \"location\": {\n \"latitude\": 47.2528768,\n \"longitude\": -122.4442906\n },\n \"city\": \"Tacoma\",\n \"subdivision\": \"WA\",\n \"country\": \"US\",\n \"streetAddress\": {\n \"name\": \"\",\n \"number\": \"\",\n \"apt\": \"\"\n }\n },\n \"name\": \"Tacoma\",\n \"tbd\": false,\n \"type\": \"VENUE\"\n },\n \"registration\": {\n \"rsvp\": {},\n \"tickets\": {\n \"highestTicketPrice\": {},\n \"lowestTicketPrice\": {},\n \"tax\": {}\n }\n },\n \"scheduling\": {\n \"formatted\": \"Time is TBD\",\n \"hideEndDate\": false,\n \"showTimeZone\": false,\n \"startDateFormatted\": \"\",\n \"startTimeFormatted\": \"\",\n \"tbd\": true,\n \"tbdMessage\": \"Time is TBD\"\n },\n \"slug\": \"leather-crafting-101-a-course-by-christina-roth-1\",\n \"status\": \"CANCELED\",\n \"summary\": {\n \"rsvp\": {},\n \"tickets\": {\n \"revenue\": {},\n \"totalSales\": {}\n }\n },\n \"title\": \"Leather Crafting 101, A course by Christina Roth (1)\",\n \"_updatedDate\": \"2023-11-08T11:56:16.000Z\",\n \"videoConferencing\": {\n \"session\": {}\n }\n}\n*/"}],"actionParams":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."}],"description":"Cancels a Wix event and closes its registration.\r\n\r\nThe `cancelEvent()` function returns a Promise that resolves to the newly-canceled Wix event after the specified Wix event is successfully canceled.\r\n\r\n This function does the following:\r\n + Changes the event status to `\"CANCELED\"`. You can also see this status change in the [Events collection](https://support.wix.com/en/article/velo-wix-events-events-collection-fields).\r\n + Sends cancellation emails and/or pushes notifications to registered guests, if Wix event [cancellation notifications are enabled](https://support.wix.com/en/article/wix-events-editing-default-emails).\r\n + Changes the registration status to `CLOSED`.\r\n\r\n Canceled Wix events cannot be \"un-canceled.\" You can only delete and copy them.\r\n\r\n > **Tip**: You can copy a canceled Wix event if you want to reinstate it. Copying an event resets the event's status and registration status.\r\n\r\n When using the API, you do not need to cancel a Wix event before deleting it. When using the Wix Events app in the Editor, you must cancel the Wix event first.\r\n\r\n Only those with \"Manage Events\" permissions can cancel Wix events.\r\n\r\n> **Note**: This function requires [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) to run.\r\n>\r\n> This function is not [universal](https://www.wix.com/velo/reference/api-overview/api-versions#api-overview_api-versions_universal-modules) and runs only on the backend."},{"name":"copyEvent","fqn":"WixEvents.copyEvent","slug":"copy-event","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["eventId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixEvent","referenceFqn":"WixEvents.WixEvent"},"description":"Fulfilled - The copied Wix event.\r\nRejected - Error message."},"examples":[{"title":"Copy a Wix event","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { wixEvents } from \"wix-events-backend\";\nimport { elevate } from 'wix-auth';\n\n/* Sample eventId value: '3d3d5c04-ece0-45a8-85f0-11a58edaa192'; */\n\nexport const myCopyEventFunction = webMethod(Permissions.Anyone, async (eventId) => {\n try {\n const elevatedCopyEvent = elevate(wixEvents.copyEvent);\n const copiedEvent = await elevatedCopyEvent(eventId);\n console.log('Success! Copied event:', copiedEvent);\n return copiedEvent;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n{\n \"about\": \"Learn to design and handmake your own custom, leather sandals from scratch.\",\n \"assignedContactsLabel\": \"custom.artisanal-leather-shoemaking-for-beginners-a-cou-4\",\n \"calendarLinks\": {\n \"google\": \"http://calendar.google.com/calendar/render?action=TEMPLATE&text=Artisanal+Leather+Shoemaking+for+Beginners%2C+A+course+by+Marta+Grau+%282%29&dates=&location=Washington%2C+USA&details=Thank+you+for+registering+to+our+event%21+Your+tickets+are+attached+to+this+email.+Don%27t+forget+to+bring+them.%0A%0AWe%27re+looking+forward+to+seeing+you+there.%0A%0AHere+are+the+details%3A%0A%0AArtisanal+Leather+Shoemaking+for+Beginners%2C+A+course+by+Marta+Grau+%282%29%0ATime+is+TBD%0AOnline%2C+Washington%2C+USA\",\n \"ics\": \"https://www.wixevents.com/media/v2/calendar?token=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6e1widmFsdWVcIjpcIjRlNWU0YWRiLTk3NzgtNDE3MS1hOWJiLTQ0ZTI3ODM0YWM4OVwifSxcIm9jTGlua1wiOm51bGx9IiwiaWF0IjoxNjk5NDQ4MTg4fQ.VeW4d5EuToAZ0A53h8kHEmmjUQdulyU-EOuAu4oZ0FE\"\n },\n \"categories\": [],\n \"createdBy\": \"\",\n \"_createdDate\": \"2023-11-08T12:56:28.545Z\",\n \"description\": \"\",\n \"eventUrl\": {\n \"baseUrl\": \"https://mysite.com/events\",\n \"path\": \"/event-details-registration/artisanal-leather-shoemaking-for-beginners-a-course-by-marta-grau-2\"\n },\n \"form\": {\n \"inputGroups\": [\n {\n \"_id\": \"name\",\n \"inputs\": [\n {\n \"additionalLabels\": [],\n \"label\": \"First name\",\n \"maxLength\": 50,\n \"name\": \"firstName\",\n \"options\": [],\n \"required\": true,\n \"type\": \"TEXT\"\n },\n {\n \"additionalLabels\": [],\n \"label\": \"Last name\",\n \"maxLength\": 50,\n \"name\": \"lastName\",\n \"options\": [],\n \"required\": true,\n \"type\": \"TEXT\"\n }\n ],\n \"orderIndex\": 0,\n \"system\": true,\n \"type\": \"NAME\"\n },\n {\n \"_id\": \"email\",\n \"inputs\": [\n {\n \"additionalLabels\": [],\n \"label\": \"Email\",\n \"maxLength\": 255,\n \"name\": \"email\",\n \"options\": [],\n \"required\": true,\n \"type\": \"TEXT\"\n }\n ],\n \"orderIndex\": 1,\n \"system\": true,\n \"type\": \"INPUT\"\n }\n ],\n \"messages\": {\n \"checkout\": {\n \"checkoutLabel\": \"Continue\",\n \"title\": \"Add your details\"\n },\n \"registrationClosed\": {\n \"exploreEventsLabel\": \"See other events\",\n \"message\": \"Registration is closed\"\n },\n \"rsvp\": {\n \"noMessages\": {\n \"confirmationTitle\": \"Sorry You Can't Make It\",\n \"shareLabel\": \"Share\",\n \"title\": \"Add your details\"\n },\n \"rsvpNo\": \"Not Going\",\n \"rsvpYes\": \"I'm Going\",\n \"submitRsvpLabel\": \"SUBMIT\",\n \"waitingMessages\": {\n \"addToCalendarLabel\": \"Add to Calendar\",\n \"confirmationMessage\": \"We'll update you if additional spots become available.\",\n \"confirmationTitle\": \"Thanks! You've been added to the waitlist.\",\n \"shareLabel\": \"Share\",\n \"title\": \"Looks Like This Event Is Full. Join the waiting list\"\n },\n \"yesMessages\": {\n \"addToCalendarLabel\": \"Add to Calendar\",\n \"confirmationMessage\": \"An email with all the event info was sent to you.\",\n \"confirmationTitle\": \"Thank you!\",\n \"shareLabel\": \"Share\",\n \"title\": \"Add your details\"\n }\n }\n }\n },\n \"guestList\": {\n \"public\": true\n },\n \"_id\": \"4e5e4adb-9778-4171-a9bb-44e27834ac89\",\n \"language\": \"en\",\n \"location\": {\n \"address\": {\n \"formatted\": \"Washington, USA\",\n \"location\": {\n \"latitude\": 47.7510741,\n \"longitude\": -120.7401386\n },\n \"subdivision\": \"WA\",\n \"country\": \"US\",\n \"streetAddress\": {\n \"name\": \"\",\n \"number\": \"\",\n \"apt\": \"\"\n }\n },\n \"name\": \"Online\",\n \"tbd\": false,\n \"type\": \"VENUE\"\n },\n \"mainImage\": \"wix:image://v1/8a8b9b_c91a236e494c4e66b771b1acf59021ff~mv2.webp/file#originWidth=1280&originHeight=720\",\n \"registration\": {\n \"initialType\": \"TICKETS\",\n \"restrictedTo\": \"VISITOR\",\n \"rsvp\": {\n \"responseOptions\": \"YES_ONLY\",\n \"waitlist\": false\n },\n \"status\": \"CLOSED\",\n \"tickets\": {\n \"currency\": \"EUR\",\n \"formAssignedPerTicket\": false,\n \"highestTicketPrice\": {},\n \"lowestTicketPrice\": {\n \"currency\": \"EUR\",\n \"value\": \"0.00\"\n },\n \"lowestTicketPriceFormatted\": \"€0\",\n \"tax\": {}\n },\n \"type\": \"TICKETS\"\n },\n \"scheduling\": {\n \"formatted\": \"Time is TBD\",\n \"hideEndDate\": false,\n \"showTimeZone\": false,\n \"startDateFormatted\": \"\",\n \"startTimeFormatted\": \"\",\n \"tbd\": true,\n \"tbdMessage\": \"Time is TBD\"\n },\n \"slug\": \"artisanal-leather-shoemaking-for-beginners-a-course-by-marta-grau-2\",\n \"status\": \"SCHEDULED\",\n \"summary\": {\n \"rsvp\": {\n \"noCount\": 0,\n \"totalRsvps\": 0,\n \"waitlistCount\": 0,\n \"yesCount\": 0\n },\n \"tickets\": {\n \"currencyLocked\": false,\n \"revenue\": {},\n \"totalOrders\": 0,\n \"totalSales\": {},\n \"totalTickets\": 0\n }\n },\n \"title\": \"Artisanal Leather Shoemaking for Beginners, A course by Marta Grau (2)\",\n \"_updatedDate\": \"2023-11-08T12:56:28.000Z\",\n \"videoConferencing\": {\n \"session\": {\n \"guestLink\": \"https://www.wixevents.com/oc?join=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJqb2luXCIsXCJpbnN0YW5jZUlkXCI6XCIxZjZkYzkwNi04MDNkLTQ2NTAtODNmNS03MmVhMWQ4ODEwMGJcIixcImV2ZW50SWRcIjpcIjRlNWU0YWRiLTk3NzgtNDE3MS1hOWJiLTQ0ZTI3ODM0YWM4OVwifSIsImlhdCI6MTY5OTQ0ODE4OH0.l4M7dk9tCmOtfLpwJC7AfHlVfzMbqsDNqr5ne-Y_ry8\",\n \"hostLink\": \"https://www.wixevents.com/oc?start=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJzdGFydFwiLFwiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6XCI0ZTVlNGFkYi05Nzc4LTQxNzEtYTliYi00NGUyNzgzNGFjODlcIn0iLCJpYXQiOjE2OTk0NDgxODh9.bFuTU4SXSL8BuDV7uA3dLw2dfZa9y4KKWpmPxhNo81M\"\n }\n }\n}\n*/"}],"actionParams":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."}],"description":"Copies a Wix event.\r\n\r\nThe `copyEvent()` function returns a Promise that resolves to the newly-copied Wix event after it has successfully been copied.\r\n\r\n This function copies a Wix event, including its registration form, notifications, and ticket settings. The newly-copied event is scheduled two weeks from the date of the original event.\r\n\r\n When copying Wix events:\r\n + If your site has multilingual enabled, and your event has additional, translated elements (such as registration messages), the translated elements are also copied to the new event.\r\n + When an event with same title already exists, the title of the newly-copied event has a numeric suffix in parentheses appended to it. For example: Copying an event titled \"My Event\" creates \"My Event (1)\".\r\n + Very long event titles are cropped: For example: \"Daily stand-up ev... (2)\". \r\n The maximum number of characters allowed is 120, which includes the suffix identifying the copy of the event.\r\n\r\n The [`onEventCreated( )`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/events/on-event-created) event handler runs when a Wix event is copied.\r\n The received `CreatedEvent` object contains information about the new Wix event that was copied.\r\n\r\n Only those with \"Manage Events\" permissions can copy Wix events.\r\n\r\n> **Note**: This function requires [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) to run.\r\n>\r\n> This function is not [universal](https://www.wix.com/velo/reference/api-overview/api-versions#api-overview_api-versions_universal-modules) and runs only on the backend."},{"name":"createEvent","fqn":"WixEvents.createEvent","slug":"create-event","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["eventInfo","options"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixEvent","referenceFqn":"WixEvents.WixEvent"},"description":"Fulfilled - The created Wix event.\r\nRejected - Error message."},"examples":[{"title":"Create a Wix event","description":"This example creates a ticketed event.","content":"\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { wixEvents } from 'wix-events-backend';\nimport { elevate } from 'wix-auth';\n\n/* Sample eventInfo value:\n\n{\n title: \"Nature's Symphony: A Musical Journey Through Wildlife.\",\n description: \"Immerse yourself in the enchanting harmony of nature's symphony as it intertwines with the power of music!\",\n registration: {\n initialType: \"TICKETS\",\n restrictedTo: \"VISITOR\",\n tickets: {\n formAssignedPerTicket: false,\n tax: {\n type: \"INCLUDED\"\n }\n }\n },\n guestList: {\n public: true\n },\n about: \"Join us for Nature's Symphony: A Musical Journey Through Wildlife at the iconic Royal Albert Hall.\",\n location: {\n name: \"Royal Albert Hall\",\n address: {\n formatted: \"Kensington Gore, London SW7, UK\",\n location: {\n latitude: 51.5009132,\n longitude: -0.1766086\n },\n city: \"London\",\n country: \"GB\",\n postalCode: \"SW7 2BL\",\n streetAddress: {\n name: \"Kensington Gore\",\n number: \"SW7\"\n }\n },\n type: \"VENUE\"\n },\n scheduling: {\n tbd: false,\n startDate: new Date(\"2024-09-14T19:00:00.000Z\"),\n endDate: new Date (\"2024-09-14T23:00:00.000Z\"),\n timeZoneId: \"Europe/Dublin\",\n hideEndDate: false,\n showTimeZone: false\n }\n}\n\nSample options value:\n\n{\n \"language\": \"de\"\n}\n\n*/\n\nexport const myCreateEventFunction = webMethod(Permissions.Anyone, async (eventInfo, options) => {\n try {\n const elevatedCreateEvent = elevate(wixEvents.createEvent);\n const createdEvent = await elevatedCreateEvent(eventInfo, options);\n console.log('Success! CreatedEvent:', createdEvent);\n return createdEvent;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n {\n \"about\": \"Join us for Nature's Symphony: A Musical Journey Through Wildlife at the iconic Royal Albert Hall.\",\n \"assignedContactsLabel\": \"custom.natures-symphony-a-musical-journey-through-wildlif\",\n \"calendarLinks\": {\n \"google\": \"http://calendar.google.com/calendar/render?action=TEMPLATE&text=Nature%27s+Symphony%3A+A+Musical+Journey+Through+Wildlife&dates=20231129T190000Z%2F20231129T230000Z&location=Kensington+Gore%2C+London+SW7%2C+UK&details=Thank+you+for+registering+to+our+event%21+Your+tickets+are+attached+to+this+email.+Don%27t+forget+to+bring+them.%0A%0AWe%27re+looking+forward+to+seeing+you+there.%0A%0AHere+are+the+details%3A%0A%0ANature%27s+Symphony%3A+A+Musical+Journey+Through+Wildlife%0A29+November+2023%2C+19%3A00%E2%80%9323%3A00%0ARoyal+Albert+Hall%2C+Kensington+Gore%2C+London+SW7%2C+UK\",\n \"ics\": \"https://www.wixevents.com/media/v2/calendar?token=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6e1widmFsdWVcIjpcImMyNDFlNmUyLWM5NTEtNDQwZC04YjYyLTUyYTZlYzM4MjE0MFwifSxcIm9jTGlua1wiOm51bGx9IiwiaWF0IjoxNjk5NDUwMDE2fQ.2wZA5WH2TOR4f8M1QICFOu8oD4gX70jBaCRMCFQRbqI\"\n },\n \"categories\": [],\n \"createdBy\": \"8a8b9b73-4da8-47a5-8268-4396e68a0605\",\n \"_createdDate\": \"2023-07-13T12:52:00.911Z\",\n \"description\": \"Immerse yourself in the enchanting harmony of nature's symphony as it intertwines with the power of music!\",\n \"eventUrl\": {\n \"baseUrl\": \"https://mysite.com/events\",\n \"path\": \"/event-details-registration/natures-symphony-a-musical-journey-through-wildlife\"\n },\n \"form\": {\n \"inputGroups\": [\n {\n \"_id\": \"name\",\n \"inputs\": [\n {\n \"additionalLabels\": [],\n \"label\": \"First name\",\n \"maxLength\": 50,\n \"name\": \"firstName\",\n \"options\": [],\n \"required\": true,\n \"type\": \"TEXT\"\n },\n {\n \"additionalLabels\": [],\n \"label\": \"Last name\",\n \"maxLength\": 50,\n \"name\": \"lastName\",\n \"options\": [],\n \"required\": true,\n \"type\": \"TEXT\"\n }\n ],\n \"orderIndex\": 0,\n \"system\": true,\n \"type\": \"NAME\"\n },\n {\n \"_id\": \"email\",\n \"inputs\": [\n {\n \"additionalLabels\": [],\n \"label\": \"Email\",\n \"maxLength\": 255,\n \"name\": \"email\",\n \"options\": [],\n \"required\": true,\n \"type\": \"TEXT\"\n }\n ],\n \"orderIndex\": 1,\n \"system\": true,\n \"type\": \"INPUT\"\n }\n ],\n \"messages\": {\n \"checkout\": {\n \"checkoutLabel\": \"Continue\",\n \"title\": \"Add your details\"\n },\n \"registrationClosed\": {\n \"exploreEventsLabel\": \"See other events\",\n \"message\": \"Registration is closed\"\n },\n \"rsvp\": {\n \"noMessages\": {\n \"confirmationTitle\": \"Sorry You Can't Make It\",\n \"shareLabel\": \"Share\",\n \"title\": \"Add your details\"\n },\n \"rsvpNo\": \"Not Going\",\n \"rsvpYes\": \"I'm Going\",\n \"submitRsvpLabel\": \"SUBMIT\",\n \"waitingMessages\": {\n \"addToCalendarLabel\": \"Add to Calendar\",\n \"confirmationMessage\": \"We'll update you if additional spots become available.\",\n \"confirmationTitle\": \"Thanks! You've been added to the waitlist.\",\n \"shareLabel\": \"Share\",\n \"title\": \"Looks like this event is full. Join the waitlist.\"\n },\n \"yesMessages\": {\n \"addToCalendarLabel\": \"Add to Calendar\",\n \"confirmationMessage\": \"An email with all the event info was sent to you.\",\n \"confirmationTitle\": \"Thank you!\",\n \"shareLabel\": \"Share\",\n \"title\": \"Add your details\"\n }\n }\n }\n },\n \"guestList\": {\n \"public\": true\n },\n \"_id\": \"c241e6e2-c951-440d-8b62-52a6ec382140\",\n \"language\": \"en\",\n \"location\": {\n \"address\": {\n \"formatted\": \"Kensington Gore, London SW7, UK\",\n \"location\": {\n \"latitude\": 51.5009132,\n \"longitude\": -0.1766086\n },\n \"city\": \"London\",\n \"country\": \"GB\",\n \"postalCode\": \"SW7 2BL\",\n \"streetAddress\": {\n \"name\": \"Kensington Gore\",\n \"number\": \"SW7\",\n \"apt\": \"\"\n }\n },\n \"name\": \"Royal Albert Hall\",\n \"tbd\": false,\n \"type\": \"VENUE\"\n },\n \"registration\": {\n \"initialType\": \"TICKETS\",\n \"restrictedTo\": \"VISITOR\",\n \"rsvp\": {\n \"responseOptions\": \"YES_ONLY\",\n \"waitlist\": false\n },\n \"status\": \"OPEN_TICKETS\",\n \"tickets\": {\n \"currency\": \"EUR\",\n \"formAssignedPerTicket\": false,\n \"highestTicketPrice\": {\n \"currency\": \"EUR\",\n \"value\": \"20.00\"\n },\n \"highestTicketPriceFormatted\": \"€20\",\n \"lowestTicketPrice\": {\n \"currency\": \"EUR\",\n \"value\": \"20.00\"\n },\n \"lowestTicketPriceFormatted\": \"€20\",\n \"tax\": {}\n },\n \"type\": \"TICKETS\"\n },\n \"scheduling\": {\n \"endDate\": \"2023-11-29T23:00:00.137Z\",\n \"formatted\": \"29 November 2023, 19:00–23:00\",\n \"hideEndDate\": false,\n \"showTimeZone\": false,\n \"startDate\": \"2023-11-29T19:00:00.000Z\",\n \"startDateFormatted\": \"29 November 2023\",\n \"startTimeFormatted\": \"19:00\",\n \"tbd\": false,\n \"timeZoneId\": \"Europe/Dublin\"\n },\n \"slug\": \"natures-symphony-a-musical-journey-through-wildlife\",\n \"status\": \"SCHEDULED\",\n \"summary\": {\n \"rsvp\": {\n \"noCount\": 0,\n \"totalRsvps\": 0,\n \"waitlistCount\": 0,\n \"yesCount\": 0\n },\n \"tickets\": {\n \"currencyLocked\": false,\n \"revenue\": {},\n \"totalOrders\": 0,\n \"totalSales\": {},\n \"totalTickets\": 0\n }\n },\n \"title\": \"Nature's Symphony: A Musical Journey Through Wildlife\",\n \"_updatedDate\": \"2023-11-08T13:22:57.000Z\",\n \"videoConferencing\": {\n \"session\": {\n \"guestLink\": \"https://www.wixevents.com/oc?join=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJqb2luXCIsXCJpbnN0YW5jZUlkXCI6XCIxZjZkYzkwNi04MDNkLTQ2NTAtODNmNS03MmVhMWQ4ODEwMGJcIixcImV2ZW50SWRcIjpcImMyNDFlNmUyLWM5NTEtNDQwZC04YjYyLTUyYTZlYzM4MjE0MFwifSIsImlhdCI6MTY5OTQ1MDAxNn0.AfJHpzU54hY8M1oVB0KGe47GUSzOzkWBVpKTTWEXk5Y\",\n \"hostLink\": \"https://www.wixevents.com/oc?start=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJzdGFydFwiLFwiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6XCJjMjQxZTZlMi1jOTUxLTQ0MGQtOGI2Mi01MmE2ZWMzODIxNDBcIn0iLCJpYXQiOjE2OTk0NTAwMTZ9.VmvnxZHBL6cCyE0ZYRdAa6cCud8aNchTTrLJX0b-Mhs\"\n }\n }\n}\n*/"},{"title":"Create a \"TBD\" Wix event","description":"This example creates a TBD ticketed event.","content":"\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { wixEvents } from 'wix-events-backend';\nimport { elevate } from 'wix-auth';\n\n/* Sample eventInfo value:\n\n{\n title: \"Nature's Symphony: A Musical Journey Through Wildlife.\",\n description: \"Immerse yourself in the enchanting harmony of nature's symphony as it intertwines with the power of music!\",\n registration: {\n initialType: \"TICKETS\",\n restrictedTo: \"VISITOR\",\n tickets: {\n formAssignedPerTicket: false,\n tax: {\n type: \"INCLUDED\"\n }\n }\n },\n guestList: {\n public: true\n },\n about: \"Join us for Nature's Symphony: A Musical Journey Through Wildlife at the iconic Royal Albert Hall.\",\n location: {\n name: \"Royal Albert Hall\",\n address: {\n formatted: \"Kensington Gore, London SW7, UK\",\n location: {\n latitude: 51.5009132,\n longitude: -0.1766086\n },\n city: \"London\",\n country: \"GB\",\n postalCode: \"SW7 2BL\",\n streetAddress: {\n name: \"Kensington Gore\",\n number: \"SW7\"\n }\n },\n type: \"VENUE\"\n },\n scheduling: {\n tbd: true,\n tbdMessage: \"The date will be announced soon, stay tuned!\"\n hideEndDate: false,\n showTimeZone: false\n }\n}\n\nSample options value:\n\n{\n \"language\": \"de\"\n}\n\n*/\n\n\nexport const myCreateEventFunction = webMethod(Permissions.Anyone, async (eventInfo, options) => {\n try {\n const elevatedCreateEvent = elevate(wixEvents.createEvent);\n const createdEvent = await elevatedCreateEvent(eventInfo, options);\n console.log('Success! CreatedEvent:', createdEvent);\n return createdEvent;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n {\n \"about\": \"Join us for Nature's Symphony: A Musical Journey Through Wildlife at the iconic Royal Albert Hall.\",\n \"assignedContactsLabel\": \"custom.natures-symphony-a-musical-journey-through-wildl\",\n \"calendarLinks\": {\n \"google\": \"http://calendar.google.com/calendar/render?action=TEMPLATE&text=Nature%27s+Symphony%3A+A+Musical+Journey+Through+Wildlife.&dates=&location=Kensington+Gore%2C+London+SW7%2C+UK&details=Thank+you+for+registering+to+our+event%21+Your+tickets+are+attached+to+this+email.+Don%27t+forget+to+bring+them.%0A%0AWe%27re+looking+forward+to+seeing+you+there.%0A%0AHere+are+the+details%3A%0A%0ANature%27s+Symphony%3A+A+Musical+Journey+Through+Wildlife.%0AThe+date+will+be+announced+soon%2C+stay+tuned%21%0ARoyal+Albert+Hall%2C+Kensington+Gore%2C+London+SW7%2C+UK\",\n \"ics\": \"https://www.wixevents.com/media/v2/calendar?token=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6e1widmFsdWVcIjpcImQxNTJmNDJjLTcyMWMtNDc3MC1hMTc4LWYwZTZjMWQ1NWYyN1wifSxcIm9jTGlua1wiOm51bGx9IiwiaWF0IjoxNjk5NDU1OTczfQ.jRP6qkUbDv_HIfIEVFKmBB1cf2R5XdgF3X50gHNW-Go\"\n },\n \"categories\": [],\n \"createdBy\": \"\",\n \"_createdDate\": \"2023-11-08T15:06:13.353Z\",\n \"description\": \"Immerse yourself in the enchanting harmony of nature's symphony as it intertwines with the power of music!\",\n \"eventUrl\": {\n \"baseUrl\": \"https://mysite.com/events\",\n \"path\": \"/event-details-registration/natures-symphony-a-musical-journey-through-wildlife\"\n },\n \"form\": {\n \"inputGroups\": [\n {\n \"_id\": \"name\",\n \"inputs\": [\n {\n \"additionalLabels\": [],\n \"label\": \"First name\",\n \"maxLength\": 50,\n \"name\": \"firstName\",\n \"options\": [],\n \"required\": true,\n \"type\": \"TEXT\"\n },\n {\n \"additionalLabels\": [],\n \"label\": \"Last name\",\n \"maxLength\": 50,\n \"name\": \"lastName\",\n \"options\": [],\n \"required\": true,\n \"type\": \"TEXT\"\n }\n ],\n \"orderIndex\": 0,\n \"system\": true,\n \"type\": \"NAME\"\n },\n {\n \"_id\": \"email\",\n \"inputs\": [\n {\n \"additionalLabels\": [],\n \"label\": \"Email\",\n \"maxLength\": 255,\n \"name\": \"email\",\n \"options\": [],\n \"required\": true,\n \"type\": \"TEXT\"\n }\n ],\n \"orderIndex\": 1,\n \"system\": true,\n \"type\": \"INPUT\"\n }\n ],\n \"messages\": {\n \"checkout\": {\n \"checkoutLabel\": \"Continue\",\n \"title\": \"Add your details\"\n },\n \"registrationClosed\": {\n \"exploreEventsLabel\": \"See other events\",\n \"message\": \"Registration is closed\"\n },\n \"rsvp\": {\n \"noMessages\": {\n \"confirmationTitle\": \"Sorry You Can't Make It\",\n \"shareLabel\": \"Share\",\n \"title\": \"Add your details\"\n },\n \"rsvpNo\": \"Not Going\",\n \"rsvpYes\": \"I'm Going\",\n \"submitRsvpLabel\": \"SUBMIT\",\n \"waitingMessages\": {\n \"addToCalendarLabel\": \"Add to Calendar\",\n \"confirmationMessage\": \"We'll update you if additional spots become available.\",\n \"confirmationTitle\": \"Thanks! You've been added to the waitlist.\",\n \"shareLabel\": \"Share\",\n \"title\": \"Looks like this event is full. Join the waitlist.\"\n },\n \"yesMessages\": {\n \"addToCalendarLabel\": \"Add to Calendar\",\n \"confirmationMessage\": \"An email with all the event info was sent to you.\",\n \"confirmationTitle\": \"Thank you!\",\n \"shareLabel\": \"Share\",\n \"title\": \"Add your details\"\n }\n }\n }\n },\n \"guestList\": {\n \"public\": true\n },\n \"_id\": \"d152f42c-721c-4770-a178-f0e6c1d55f27\",\n \"language\": \"en\",\n \"location\": {\n \"address\": {\n \"formatted\": \"Kensington Gore, London SW7, UK\",\n \"location\": {\n \"latitude\": 51.5009132,\n \"longitude\": -0.1766086\n },\n \"city\": \"London\",\n \"country\": \"GB\",\n \"postalCode\": \"SW7 2BL\",\n \"streetAddress\": {\n \"name\": \"Kensington Gore\",\n \"number\": \"SW7\",\n \"apt\": \"\"\n }\n },\n \"name\": \"Royal Albert Hall\",\n \"tbd\": false,\n \"type\": \"VENUE\"\n },\n \"registration\": {\n \"initialType\": \"TICKETS\",\n \"restrictedTo\": \"VISITOR\",\n \"rsvp\": {\n \"responseOptions\": \"YES_ONLY\",\n \"waitlist\": false\n },\n \"status\": \"CLOSED\",\n \"tickets\": {\n \"formAssignedPerTicket\": false,\n \"highestTicketPrice\": {},\n \"lowestTicketPrice\": {},\n \"tax\": {}\n },\n \"type\": \"TICKETS\"\n },\n \"scheduling\": {\n \"formatted\": \"The date will be announced soon, stay tuned!\",\n \"hideEndDate\": false,\n \"showTimeZone\": false,\n \"startDateFormatted\": \"\",\n \"startTimeFormatted\": \"\",\n \"tbd\": true,\n \"tbdMessage\": \"The date will be announced soon, stay tuned!\"\n },\n \"slug\": \"natures-symphony-a-musical-journey-through-wildlife-2\",\n \"status\": \"SCHEDULED\",\n \"summary\": {\n \"rsvp\": {\n \"noCount\": 0,\n \"totalRsvps\": 0,\n \"waitlistCount\": 0,\n \"yesCount\": 0\n },\n \"tickets\": {\n \"currencyLocked\": false,\n \"revenue\": {},\n \"totalOrders\": 0,\n \"totalSales\": {},\n \"totalTickets\": 0\n }\n },\n \"title\": \"Nature's Symphony: A Musical Journey Through Wildlife.\",\n \"_updatedDate\": \"2023-11-08T15:06:13.000Z\",\n \"videoConferencing\": {\n \"session\": {\n \"guestLink\": \"https://www.wixevents.com/oc?join=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJqb2luXCIsXCJpbnN0YW5jZUlkXCI6XCIxZjZkYzkwNi04MDNkLTQ2NTAtODNmNS03MmVhMWQ4ODEwMGJcIixcImV2ZW50SWRcIjpcImQxNTJmNDJjLTcyMWMtNDc3MC1hMTc4LWYwZTZjMWQ1NWYyN1wifSIsImlhdCI6MTY5OTQ1NTk3M30.DSiViUeWe2Yr9aqWtdp_TCA97sUwfOmZ3uE8XyLmXQk\",\n \"hostLink\": \"https://www.wixevents.com/oc?start=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJzdGFydFwiLFwiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6XCJkMTUyZjQyYy03MjFjLTQ3NzAtYTE3OC1mMGU2YzFkNTVmMjdcIn0iLCJpYXQiOjE2OTk0NTU5NzN9.LZ5MYRXsUE-Pqzn4YtLJdAk7PXzKoJelPJvj1wUTjw8\"\n }\n }\n}\n*/"}],"actionParams":[{"name":"eventInfo","slug":"event-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixEventInfo","referenceFqn":"WixEvents.WixEventInfo"},"description":"Info used to create the Wix event."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixEventInfoOptions","referenceFqn":"WixEvents.WixEventInfoOptions"},"description":"Options to use when creating the Wix event."}],"description":"Creates a Wix event.\r\n\r\nThe `createEvent()` function returns a Promise that resolves to the newly-created Wix event after it has successfully been created.\r\n\r\n When creating an event, you must define if the event is an RSVP event or a ticketed event. This is stored in the `registration.initialType` property.\r\n After the initial save, you can further define event registration details. If you change the event's registration to be external or unnecessary,\r\n this is reflected in the `registration.type` property. The `registration.initialType` property after initial creation is read-only.\r\n\r\n The new Wix event is created with a default [registration form](https://support.wix.com/en/article/wix-events-customizing-your-registration-form-page) in the site's default language, using the site's default regional settings.\r\n\r\n The default registration form includes input fields for first name, last name, and email. Keep in mind that the registration form\r\n for a ticketed event has different fields from the form for a non-ticketed event.\r\n\r\n By default, the event is automatically configured to send daily summary reports of new registrations to the site's business email.\r\n\r\n Only those with \"Manage Events\" permissions can create Wix events.\r\n\r\n> **Note**: This function requires [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) to run.\r\n>\r\n> This function is not [universal](https://www.wix.com/velo/reference/api-overview/api-versions#api-overview_api-versions_universal-modules) and runs only on the backend."},{"name":"deleteEvent","fqn":"WixEvents.deleteEvent","slug":"delete-event","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["eventId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the event is deleted.\r\nRejected - Error message."},"examples":[{"title":"Delete a Wix event","content":"import { Permissions, webMethod } from \"wix-web-module\";\nimport { wixEvents } from \"wix-events-backend\";\nimport { elevate } from \"wix-auth\";\n\n/* Sample eventId value: '9d720f99-1b5a-4141-9877-d32985391e18'; */\n\nexport const myDeleteEventFunction = webMethod(Permissions.Anyone, async (eventId) => {\n try {\n const elevatedDeleteEvent = elevate(wixEvents.deleteEvent);\n const deletedEvent = await elevatedDeleteEvent(eventId);\n console.log('Success! Deleted event:', deletedEvent);\n return deletedEvent;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to void */"}],"actionParams":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."}],"description":"Deletes a Wix event.\r\n\r\nThe `deleteEvent()` function returns a Promise that resolves when the specified Wix event is deleted.\r\n\r\n Any event can be deleted regardless of its status or if attendees are registered.\r\n\r\n Deleted events are not returned by the [`getEvent()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/get-event) or [`queryEvent()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/query-events) functions.\r\n\r\n Only those with \"Manage Events\" permissions can delete Wix events.\r\n\r\n> **Note**: This function requires [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) to run.\r\n>\r\n> This function is not [universal](https://www.wix.com/velo/reference/api-overview/api-versions#api-overview_api-versions_universal-modules) and runs only on the backend."},{"name":"getEvent","fqn":"WixEvents.getEvent","slug":"get-event","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["eventId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixEvent","referenceFqn":"WixEvents.WixEvent"},"description":"Fulfilled - The Wix event.\r\nRejected - Error message."},"examples":[{"title":"Get a Wix event","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { wixEvents } from \"wix-events-backend\";\nimport { elevate } from 'wix-auth';\n\n/* Sample eventId value: 'c241e6e2-c951-440d-8b62-52a6ec382140'; */\n\nexport const myGetEventFunction = webMethod(Permissions.Anyone, async (eventId) => {\n try {\n const elevatedGetEvent = elevate(wixEvents.getEvent);\n const getEvent = await elevatedGetEvent(eventId);\n console.log('Success! Event:', getEvent);\n return getEvent;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n{\n \"about\": \"Join us for Nature's Symphony: A Musical Journey Through Wildlife at the iconic Royal Albert Hall.\",\n \"assignedContactsLabel\": \"custom.natures-symphony-a-musical-journey-through-wildlif\",\n \"calendarLinks\": {\n \"google\": \"http://calendar.google.com/calendar/render?action=TEMPLATE&text=Nature%27s+Symphony%3A+A+Musical+Journey+Through+Wildlife&dates=20231129T190000Z%2F20231129T230000Z&location=Kensington+Gore%2C+London+SW7%2C+UK&details=Thank+you+for+registering+to+our+event%21+Your+tickets+are+attached+to+this+email.+Don%27t+forget+to+bring+them.%0A%0AWe%27re+looking+forward+to+seeing+you+there.%0A%0AHere+are+the+details%3A%0A%0ANature%27s+Symphony%3A+A+Musical+Journey+Through+Wildlife%0A29+November+2023%2C+19%3A00%E2%80%9323%3A00%0ARoyal+Albert+Hall%2C+Kensington+Gore%2C+London+SW7%2C+UK\",\n \"ics\": \"https://www.wixevents.com/media/v2/calendar?token=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6e1widmFsdWVcIjpcImMyNDFlNmUyLWM5NTEtNDQwZC04YjYyLTUyYTZlYzM4MjE0MFwifSxcIm9jTGlua1wiOm51bGx9IiwiaWF0IjoxNjk5NDUwMDE2fQ.2wZA5WH2TOR4f8M1QICFOu8oD4gX70jBaCRMCFQRbqI\"\n },\n \"categories\": [],\n \"createdBy\": \"8a8b9b73-4da8-47a5-8268-4396e68a0605\",\n \"_createdDate\": \"2023-07-13T12:52:00.911Z\",\n \"description\": \"Immerse yourself in the enchanting harmony of nature's symphony as it intertwines with the power of music!\",\n \"eventUrl\": {\n \"baseUrl\": \"https://mysite.com/events\",\n \"path\": \"/event-details-registration/natures-symphony-a-musical-journey-through-wildlife\"\n },\n \"form\": {\n \"inputGroups\": [\n {\n \"_id\": \"name\",\n \"inputs\": [\n {\n \"additionalLabels\": [],\n \"label\": \"First name\",\n \"maxLength\": 50,\n \"name\": \"firstName\",\n \"options\": [],\n \"required\": true,\n \"type\": \"TEXT\"\n },\n {\n \"additionalLabels\": [],\n \"label\": \"Last name\",\n \"maxLength\": 50,\n \"name\": \"lastName\",\n \"options\": [],\n \"required\": true,\n \"type\": \"TEXT\"\n }\n ],\n \"orderIndex\": 0,\n \"system\": true,\n \"type\": \"NAME\"\n },\n {\n \"_id\": \"email\",\n \"inputs\": [\n {\n \"additionalLabels\": [],\n \"label\": \"Email\",\n \"maxLength\": 255,\n \"name\": \"email\",\n \"options\": [],\n \"required\": true,\n \"type\": \"TEXT\"\n }\n ],\n \"orderIndex\": 1,\n \"system\": true,\n \"type\": \"INPUT\"\n }\n ],\n \"messages\": {\n \"checkout\": {\n \"checkoutLabel\": \"Continue\",\n \"title\": \"Add your details\"\n },\n \"registrationClosed\": {\n \"exploreEventsLabel\": \"See other events\",\n \"message\": \"Registration is closed\"\n },\n \"rsvp\": {\n \"noMessages\": {\n \"confirmationTitle\": \"Sorry You Can't Make It\",\n \"shareLabel\": \"Share\",\n \"title\": \"Add your details\"\n },\n \"rsvpNo\": \"Not Going\",\n \"rsvpYes\": \"I'm Going\",\n \"submitRsvpLabel\": \"SUBMIT\",\n \"waitingMessages\": {\n \"addToCalendarLabel\": \"Add to Calendar\",\n \"confirmationMessage\": \"We'll update you if additional spots become available.\",\n \"confirmationTitle\": \"Thanks! You've been added to the waitlist.\",\n \"shareLabel\": \"Share\",\n \"title\": \"Looks like this event is full. Join the waitlist.\"\n },\n \"yesMessages\": {\n \"addToCalendarLabel\": \"Add to Calendar\",\n \"confirmationMessage\": \"An email with all the event info was sent to you.\",\n \"confirmationTitle\": \"Thank you!\",\n \"shareLabel\": \"Share\",\n \"title\": \"Add your details\"\n }\n }\n }\n },\n \"guestList\": {\n \"public\": true\n },\n \"_id\": \"c241e6e2-c951-440d-8b62-52a6ec382140\",\n \"language\": \"en\",\n \"location\": {\n \"address\": {\n \"formatted\": \"Kensington Gore, London SW7, UK\",\n \"location\": {\n \"latitude\": 51.5009132,\n \"longitude\": -0.1766086\n },\n \"city\": \"London\",\n \"country\": \"GB\",\n \"postalCode\": \"SW7 2BL\",\n \"streetAddress\": {\n \"name\": \"Kensington Gore\",\n \"number\": \"SW7\",\n \"apt\": \"\"\n }\n },\n \"name\": \"Royal Albert Hall\",\n \"tbd\": false,\n \"type\": \"VENUE\"\n },\n \"registration\": {\n \"initialType\": \"TICKETS\",\n \"restrictedTo\": \"VISITOR\",\n \"rsvp\": {\n \"responseOptions\": \"YES_ONLY\",\n \"waitlist\": false\n },\n \"status\": \"OPEN_TICKETS\",\n \"tickets\": {\n \"currency\": \"EUR\",\n \"formAssignedPerTicket\": false,\n \"highestTicketPrice\": {\n \"currency\": \"EUR\",\n \"value\": \"20.00\"\n },\n \"highestTicketPriceFormatted\": \"€20\",\n \"lowestTicketPrice\": {\n \"currency\": \"EUR\",\n \"value\": \"20.00\"\n },\n \"lowestTicketPriceFormatted\": \"€20\",\n \"tax\": {}\n },\n \"type\": \"TICKETS\"\n },\n \"scheduling\": {\n \"endDate\": \"2023-11-29T23:00:00.137Z\",\n \"formatted\": \"29 November 2023, 19:00–23:00\",\n \"hideEndDate\": false,\n \"showTimeZone\": false,\n \"startDate\": \"2023-11-29T19:00:00.000Z\",\n \"startDateFormatted\": \"29 November 2023\",\n \"startTimeFormatted\": \"19:00\",\n \"tbd\": false,\n \"timeZoneId\": \"Europe/Dublin\"\n },\n \"slug\": \"natures-symphony-a-musical-journey-through-wildlife\",\n \"status\": \"SCHEDULED\",\n \"summary\": {\n \"rsvp\": {\n \"noCount\": 0,\n \"totalRsvps\": 0,\n \"waitlistCount\": 0,\n \"yesCount\": 0\n },\n \"tickets\": {\n \"currencyLocked\": false,\n \"revenue\": {},\n \"totalOrders\": 0,\n \"totalSales\": {},\n \"totalTickets\": 0\n }\n },\n \"title\": \"Nature's Symphony: A Musical Journey Through Wildlife\",\n \"_updatedDate\": \"2023-11-08T13:22:57.000Z\",\n \"videoConferencing\": {\n \"session\": {\n \"guestLink\": \"https://www.wixevents.com/oc?join=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJqb2luXCIsXCJpbnN0YW5jZUlkXCI6XCIxZjZkYzkwNi04MDNkLTQ2NTAtODNmNS03MmVhMWQ4ODEwMGJcIixcImV2ZW50SWRcIjpcImMyNDFlNmUyLWM5NTEtNDQwZC04YjYyLTUyYTZlYzM4MjE0MFwifSIsImlhdCI6MTY5OTQ1MDAxNn0.AfJHpzU54hY8M1oVB0KGe47GUSzOzkWBVpKTTWEXk5Y\",\n \"hostLink\": \"https://www.wixevents.com/oc?start=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJzdGFydFwiLFwiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6XCJjMjQxZTZlMi1jOTUxLTQ0MGQtOGI2Mi01MmE2ZWMzODIxNDBcIn0iLCJpYXQiOjE2OTk0NTAwMTZ9.VmvnxZHBL6cCyE0ZYRdAa6cCud8aNchTTrLJX0b-Mhs\"\n }\n }\n}\n*/"}],"actionParams":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."}],"description":"Retrieves a Wix event by ID.\r\n\r\nThe `getEvent()` function returns a Promise that resolves to a Wix event whose ID matches the given ID.\r\n\r\n Only those with \"Manage Events\" permissions can get Wix events.\r\n\r\n> **Note**: This function requires [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) to run.\r\n>\r\n> This function is not [universal](https://www.wix.com/velo/reference/api-overview/api-versions#api-overview_api-versions_universal-modules) and runs only on the backend."},{"name":"queryEvents","fqn":"WixEvents.queryEvents","slug":"query-events","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query.\r\nThe `EventsQueryBuilder` functions enable you to run, sort, filter, and control\r\nwhich results a query returns.\r\n\r\nTypically, you build a query using any of the event query functions,\r\nrefine the query by chaining `EventsQueryBuilder` functions, and then execute the\r\nquery by chaining the [`find()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/find) function.\r\n\r\nFor example, the following code returns the first 5 upcoming Wix events created by\r\na given event manager, including scheduled events and events that\r\nhave started. The events are listed in ascending\r\norder by the event's start date.\r\n\r\n```javascript\r\nimport { wixEvents } from 'wix-events-backend';\r\n\r\nwixEvents.queryEvents()\r\n .eq(\"createdBy\", \"4c47c608-cfa8-4037-93ac-738f09560ed3\")\r\n .hasSome(\"status\", [\"SCHEDULED\", \"STARTED\"])\r\n .ascending(\"scheduling.startDate\")\r\n .limit(5)\r\n .find()\r\n .then( (results) => {\r\n console.log(results.items);\r\n } );\r\n```"},"examples":[{"title":"Retrieve the newest Wix event that has the \"SCHEDULED\" status","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { wixEvents } from 'wix-events-backend';\n\nexport const myQueryEventsFunction = webMethod(Permissions.Anyone, async () => {\n try {\n await wixEvents.queryEvents()\n .hasSome(\"status\", [\"SCHEDULED\"])\n .descending(\"createdDate\")\n .find()\n .then((results) => {\n const items = results.items;\n const firstItem = items[0];\n console.log('Success! Events:', firstItem);\n return firstItem;\n })\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to: \n {\n \"about\": \"Join us for Nature's Symphony: A Musical Journey Through Wildlife at the iconic Royal Albert Hall.\",\n \"assignedContactsLabel\": \"custom.natures-symphony-a-musical-journey-through-wildl\",\n \"calendarLinks\": {\n \"google\": \"http://calendar.google.com/calendar/render?action=TEMPLATE&text=Nature%27s+Symphony%3A+A+Musical+Journey+Through+Wildlife.&dates=&location=Kensington+Gore%2C+London+SW7%2C+UK&details=Thank+you+for+registering+to+our+event%21+Your+tickets+are+attached+to+this+email.+Don%27t+forget+to+bring+them.%0A%0AWe%27re+looking+forward+to+seeing+you+there.%0A%0AHere+are+the+details%3A%0A%0ANature%27s+Symphony%3A+A+Musical+Journey+Through+Wildlife.%0AThe+date+will+be+announced+soon%2C+stay+tuned%21%0ARoyal+Albert+Hall%2C+Kensington+Gore%2C+London+SW7%2C+UK\",\n \"ics\": \"https://www.wixevents.com/media/v2/calendar?token=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6e1widmFsdWVcIjpcImQxNTJmNDJjLTcyMWMtNDc3MC1hMTc4LWYwZTZjMWQ1NWYyN1wifSxcIm9jTGlua1wiOm51bGx9IiwiaWF0IjoxNjk5NTMxNjUzfQ.tiiCPGnU-ZD9ZKRoJe6vqcyi0HeHDCju6GKphZEDtN0\"\n },\n \"categories\": [],\n \"createdBy\": \"\",\n \"_createdDate\": \"2023-11-08T15:06:13.353Z\",\n \"description\": \"Immerse yourself in the enchanting harmony of nature's symphony as it intertwines with the power of music!\",\n \"eventUrl\": {\n \"baseUrl\": \"https://mysite.com/events\",\n \"path\": \"/event-details-registration/natures-symphony-a-musical-journey-through-wildlife\"\n },\n \"form\": {\n \"inputGroups\": [\n {\n \"_id\": \"name\",\n \"inputs\": [\n {\n \"additionalLabels\": [],\n \"label\": \"First name\",\n \"maxLength\": 50,\n \"name\": \"firstName\",\n \"options\": [],\n \"required\": true,\n \"type\": \"TEXT\"\n },\n {\n \"additionalLabels\": [],\n \"label\": \"Last name\",\n \"maxLength\": 50,\n \"name\": \"lastName\",\n \"options\": [],\n \"required\": true,\n \"type\": \"TEXT\"\n }\n ],\n \"orderIndex\": 0,\n \"system\": true,\n \"type\": \"NAME\"\n },\n {\n \"_id\": \"email\",\n \"inputs\": [\n {\n \"additionalLabels\": [],\n \"label\": \"Email\",\n \"maxLength\": 255,\n \"name\": \"email\",\n \"options\": [],\n \"required\": true,\n \"type\": \"TEXT\"\n }\n ],\n \"orderIndex\": 1,\n \"system\": true,\n \"type\": \"INPUT\"\n }\n ],\n \"messages\": {\n \"checkout\": {\n \"checkoutLabel\": \"Continue\",\n \"title\": \"Add your details\"\n },\n \"registrationClosed\": {\n \"exploreEventsLabel\": \"See other events\",\n \"message\": \"Registration is closed\"\n },\n \"rsvp\": {\n \"noMessages\": {\n \"confirmationTitle\": \"Sorry You Can't Make It\",\n \"shareLabel\": \"Share\",\n \"title\": \"Add your details\"\n },\n \"rsvpNo\": \"Not Going\",\n \"rsvpYes\": \"I'm Going\",\n \"submitRsvpLabel\": \"SUBMIT\",\n \"waitingMessages\": {\n \"addToCalendarLabel\": \"Add to Calendar\",\n \"confirmationMessage\": \"We'll update you if additional spots become available.\",\n \"confirmationTitle\": \"Thanks! You've been added to the waitlist.\",\n \"shareLabel\": \"Share\",\n \"title\": \"Looks like this event is full. Join the waitlist.\"\n },\n \"yesMessages\": {\n \"addToCalendarLabel\": \"Add to Calendar\",\n \"confirmationMessage\": \"An email with all the event info was sent to you.\",\n \"confirmationTitle\": \"Thank you!\",\n \"shareLabel\": \"Share\",\n \"title\": \"Add your details\"\n }\n }\n }\n },\n \"guestList\": {\n \"public\": true\n },\n \"_id\": \"d152f42c-721c-4770-a178-f0e6c1d55f27\",\n \"language\": \"en\",\n \"location\": {\n \"address\": {\n \"formatted\": \"Kensington Gore, London SW7, UK\",\n \"location\": {\n \"latitude\": 51.5009132,\n \"longitude\": -0.1766086\n },\n \"city\": \"London\",\n \"country\": \"GB\",\n \"postalCode\": \"SW7 2BL\",\n \"streetAddress\": {\n \"name\": \"Kensington Gore\",\n \"number\": \"SW7\",\n \"apt\": \"\"\n }\n },\n \"name\": \"Royal Albert Hall\",\n \"tbd\": false,\n \"type\": \"VENUE\"\n },\n \"registration\": {\n \"initialType\": \"TICKETS\",\n \"restrictedTo\": \"VISITOR\",\n \"rsvp\": {\n \"responseOptions\": \"YES_ONLY\",\n \"waitlist\": false\n },\n \"status\": \"CLOSED\",\n \"tickets\": {\n \"formAssignedPerTicket\": false,\n \"highestTicketPrice\": {},\n \"lowestTicketPrice\": {},\n \"tax\": {}\n },\n \"type\": \"TICKETS\"\n },\n \"scheduling\": {\n \"formatted\": \"The date will be announced soon, stay tuned!\",\n \"hideEndDate\": false,\n \"showTimeZone\": false,\n \"startDateFormatted\": \"\",\n \"startTimeFormatted\": \"\",\n \"tbd\": true,\n \"tbdMessage\": \"The date will be announced soon, stay tuned!\"\n },\n \"slug\": \"natures-symphony-a-musical-journey-through-wildlife\",\n \"status\": \"SCHEDULED\",\n \"summary\": {\n \"rsvp\": {},\n \"tickets\": {\n \"revenue\": {},\n \"totalSales\": {}\n }\n },\n \"title\": \"Nature's Symphony: A Musical Journey Through Wildlife.\",\n \"_updatedDate\": \"2023-11-08T15:06:13.000Z\",\n \"videoConferencing\": {\n \"session\": {}\n }\n}\n*/"}],"description":"Creates a query to retrieve a list of Wix events.\r\n\r\nThe `queryEvents()` function builds a query to retrieve a list of Wix events and returns\r\n a [EventsQueryBuilder](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/introduction) object.\r\n\r\n The returned object contains the query definition which is typically used to run the query\r\n using the [`find()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/find) function.\r\n\r\n You can refine the query by chaining `EventsQueryBuilder` functions onto the query. `EventsQueryBuilder`\r\n functions enable you to sort, filter, and control the results that `queryEvents.find()` returns.\r\n\r\n The query runs with the following `EventsQueryBuilder` defaults that you can override:\r\n\r\n + [`limit`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/limit): `50`\r\n + [`descending`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/descending): `_createdDate`\r\n\r\n The functions that are chained to `queryEvents()` are applied in the order they are called. For example,\r\n if you sort on the `_createdDate` property in ascending order and then on the `status` property in\r\n descending order, the results are sorted first by the created date of the items and then, if there are\r\n multiple results with the same date, the items are sorted by status in descending order, per created date value.\r\n\r\n\r\nThe following `EventsQueryBuilder` functions are supported for `queryEvents()`.\r\n\r\nFor a full description of the Wix Event object, see the object returned for the [`items`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/items)\r\nproperty in [`EventsQueryResult`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/introduction).\r\n\r\n| Property | Supported Filters & Sorting |\r\n| ---------------------------- | ------------------------------------------------------------------------------------------ |\r\n|`_id` |[`eq()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/eq), [`ne()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ne), [`hasSome()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/has-some) |\r\n|`title` |[`eq()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/eq), [`ne()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ne), [`lt()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/lt), [`le()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/le), [`gt()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/gt), [`ge()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ge), [`hasSome()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/has-some), [`contains()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/contains),[`ascending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ascending), [`descending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/descending) |\r\n|`status` |[`eq()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/eq), [`ne()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ne), [`hasSome()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/has-some), [`contains()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/contains) |\r\n|`createdBy` |[`eq()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/eq), [`ne()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ne), [`hasSome()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/has-some) |\r\n|`scheduling.startDate` |[`lt()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/lt), [`le()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/le), [`gt()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/gt), [`ge()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ge), [`ascending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ascending), [`descending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/descending) |\r\n|`scheduling.endDate` |[`lt()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/lt), [`le()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/le), [`gt()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/gt), [`ge()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ge), [`ascending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ascending), [`descending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/descending) |\r\n|`_createdDate` |[`ascending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ascending), [`descending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/descending) |\r\n|`_updatedDate` |[`ascending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ascending), [`descending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/descending) |\r\n|`slug` |[`eq()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/eq), [`ne()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ne), [`lt()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/lt), [`le()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/le), [`gt()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/gt), [`ge()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ge), [`hasSome()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/has-some), [`contains()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/contains), [`ascending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/ascending), [`descending()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/descending) |\r\n\r\n You can only use one filter function for each property. If a property is used in more than one filter,\r\n only the first filter will work.\r\n\r\n>**Notes:**\r\n> + A guest can only see their own Wix events unless `suppressAuth` is set to `true` in the queryOptions for the [`find()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/find) function.\r\n> + When using the `queryEvents()` function immediately following a change to your Wix events, the data retrieved may not contain your most recent changes. See [Wix-data and Eventual Consistency](reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency) for more information. To solve this problem, you can use the [`setTimeout()`](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Asynchronous/Timeouts_and_intervals#setTimeout) function to delay querying for a number of seconds, following any changes to your Wix events data.\r\n\r\n\r\n\r\nOnly those with \"Manage Events\" permissions can query Wix events. Only the events they are authorized to\r\nreceive are returned."},{"name":"updateEvent","fqn":"WixEvents.updateEvent","slug":"update-event","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["eventId","eventInfo","options"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixEvent","referenceFqn":"WixEvents.WixEvent"},"description":"Fulfilled - The updated Wix event.\r\nRejected - Error message."},"examples":[{"title":"Update a Wix event","description":"This example demonstrates how to update a TBD event once the date is known. In\n addition to updating the date, we set the `scheduling.tbd` field to `false`.","content":"\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { wixEvents } from \"wix-events-backend\";\nimport { elevate } from 'wix-auth';\n\n/* Sample eventId value: '3d3d5c04-ece0-45a8-85f0-11a58edaa192'\n\nSample eventInfo value: \n{\n scheduling: {\n tbd: false,\n startDate: new Date(\"2024-09-14T19:00:00.000Z\"),\n endDate: new Date (\"2024-09-14T23:00:00.000Z\"),\n timeZoneId: \"Europe/Dublin\",\n hideEndDate: false,\n showTimeZone: false\n }\n}\n\n*/\n\nexport const myUpdateEventFunction = webMethod(Permissions.Anyone, async (eventId, eventInfo, options) => {\n try {\n const elevatedUpdateEvent = elevate(wixEvents.updateEvent);\n const updatedEvent = await elevatedUpdateEvent(eventId, eventInfo, options);\n console.log('Success! Updated event:', updatedEvent);\n return updatedEvent;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n \n/* Promise resolves to:\n {\n \"about\": \"Join us for Nature's Symphony: A Musical Journey Through Wildlife at the iconic Royal Albert Hall.\",\n \"assignedContactsLabel\": \"custom.natures-symphony-a-musical-journey-through-wildlif\",\n \"calendarLinks\": {\n \"google\": \"http://calendar.google.com/calendar/render?action=TEMPLATE&text=Nature%27s+Symphony%3A+A+Musical+Journey+Through+Wildlife&dates=20231129T190000Z%2F20231129T230000Z&location=Kensington+Gore%2C+London+SW7%2C+UK&details=Thank+you+for+registering+to+our+event%21+Your+tickets+are+attached+to+this+email.+Don%27t+forget+to+bring+them.%0A%0AWe%27re+looking+forward+to+seeing+you+there.%0A%0AHere+are+the+details%3A%0A%0ANature%27s+Symphony%3A+A+Musical+Journey+Through+Wildlife%0A29+November+2023%2C+19%3A00%E2%80%9323%3A00%0ARoyal+Albert+Hall%2C+Kensington+Gore%2C+London+SW7%2C+UK\",\n \"ics\": \"https://www.wixevents.com/media/v2/calendar?token=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6e1widmFsdWVcIjpcImMyNDFlNmUyLWM5NTEtNDQwZC04YjYyLTUyYTZlYzM4MjE0MFwifSxcIm9jTGlua1wiOm51bGx9IiwiaWF0IjoxNjk5NDUwMDE2fQ.2wZA5WH2TOR4f8M1QICFOu8oD4gX70jBaCRMCFQRbqI\"\n },\n \"categories\": [],\n \"createdBy\": \"8a8b9b73-4da8-47a5-8268-4396e68a0605\",\n \"_createdDate\": \"2023-07-13T12:52:00.911Z\",\n \"description\": \"Immerse yourself in the enchanting harmony of nature's symphony as it intertwines with the power of music!\",\n \"eventUrl\": {\n \"baseUrl\": \"https://mysite.com/events\",\n \"path\": \"/event-details-registration/natures-symphony-a-musical-journey-through-wildlife\"\n },\n \"form\": {\n \"inputGroups\": [\n {\n \"_id\": \"name\",\n \"inputs\": [\n {\n \"additionalLabels\": [],\n \"label\": \"First name\",\n \"maxLength\": 50,\n \"name\": \"firstName\",\n \"options\": [],\n \"required\": true,\n \"type\": \"TEXT\"\n },\n {\n \"additionalLabels\": [],\n \"label\": \"Last name\",\n \"maxLength\": 50,\n \"name\": \"lastName\",\n \"options\": [],\n \"required\": true,\n \"type\": \"TEXT\"\n }\n ],\n \"orderIndex\": 0,\n \"system\": true,\n \"type\": \"NAME\"\n },\n {\n \"_id\": \"email\",\n \"inputs\": [\n {\n \"additionalLabels\": [],\n \"label\": \"Email\",\n \"maxLength\": 255,\n \"name\": \"email\",\n \"options\": [],\n \"required\": true,\n \"type\": \"TEXT\"\n }\n ],\n \"orderIndex\": 1,\n \"system\": true,\n \"type\": \"INPUT\"\n }\n ],\n \"messages\": {\n \"checkout\": {\n \"checkoutLabel\": \"Continue\",\n \"title\": \"Add your details\"\n },\n \"registrationClosed\": {\n \"exploreEventsLabel\": \"See other events\",\n \"message\": \"Registration is closed\"\n },\n \"rsvp\": {\n \"noMessages\": {\n \"confirmationTitle\": \"Sorry You Can't Make It\",\n \"shareLabel\": \"Share\",\n \"title\": \"Add your details\"\n },\n \"rsvpNo\": \"Not Going\",\n \"rsvpYes\": \"I'm Going\",\n \"submitRsvpLabel\": \"SUBMIT\",\n \"waitingMessages\": {\n \"addToCalendarLabel\": \"Add to Calendar\",\n \"confirmationMessage\": \"We'll update you if additional spots become available.\",\n \"confirmationTitle\": \"Thanks! You've been added to the waitlist.\",\n \"shareLabel\": \"Share\",\n \"title\": \"Looks like this event is full. Join the waitlist.\"\n },\n \"yesMessages\": {\n \"addToCalendarLabel\": \"Add to Calendar\",\n \"confirmationMessage\": \"An email with all the event info was sent to you.\",\n \"confirmationTitle\": \"Thank you!\",\n \"shareLabel\": \"Share\",\n \"title\": \"Add your details\"\n }\n }\n }\n },\n \"guestList\": {\n \"public\": true\n },\n \"_id\": \"c241e6e2-c951-440d-8b62-52a6ec382140\",\n \"language\": \"en\",\n \"location\": {\n \"address\": {\n \"formatted\": \"Kensington Gore, London SW7, UK\",\n \"location\": {\n \"latitude\": 51.5009132,\n \"longitude\": -0.1766086\n },\n \"city\": \"London\",\n \"country\": \"GB\",\n \"postalCode\": \"SW7 2BL\",\n \"streetAddress\": {\n \"name\": \"Kensington Gore\",\n \"number\": \"SW7\",\n \"apt\": \"\"\n }\n },\n \"name\": \"Royal Albert Hall\",\n \"tbd\": false,\n \"type\": \"VENUE\"\n },\n \"registration\": {\n \"initialType\": \"TICKETS\",\n \"restrictedTo\": \"VISITOR\",\n \"rsvp\": {\n \"responseOptions\": \"YES_ONLY\",\n \"waitlist\": false\n },\n \"status\": \"OPEN_TICKETS\",\n \"tickets\": {\n \"currency\": \"EUR\",\n \"formAssignedPerTicket\": false,\n \"highestTicketPrice\": {\n \"currency\": \"EUR\",\n \"value\": \"20.00\"\n },\n \"highestTicketPriceFormatted\": \"€20\",\n \"lowestTicketPrice\": {\n \"currency\": \"EUR\",\n \"value\": \"20.00\"\n },\n \"lowestTicketPriceFormatted\": \"€20\",\n \"tax\": {}\n },\n \"type\": \"TICKETS\"\n },\n \"scheduling\": {\n \"endDate\": \"2023-11-29T23:00:00.137Z\",\n \"formatted\": \"29 November 2023, 19:00–23:00\",\n \"hideEndDate\": false,\n \"showTimeZone\": false,\n \"startDate\": \"2023-11-29T19:00:00.000Z\",\n \"startDateFormatted\": \"29 November 2023\",\n \"startTimeFormatted\": \"19:00\",\n \"tbd\": false,\n \"timeZoneId\": \"Europe/Dublin\"\n },\n \"slug\": \"natures-symphony-a-musical-journey-through-wildlife\",\n \"status\": \"SCHEDULED\",\n \"summary\": {\n \"rsvp\": {\n \"noCount\": 0,\n \"totalRsvps\": 0,\n \"waitlistCount\": 0,\n \"yesCount\": 0\n },\n \"tickets\": {\n \"currencyLocked\": false,\n \"revenue\": {},\n \"totalOrders\": 0,\n \"totalSales\": {},\n \"totalTickets\": 0\n }\n },\n \"title\": \"Nature's Symphony: A Musical Journey Through Wildlife\",\n \"_updatedDate\": \"2023-11-09T15:00:54.345Z\",\n \"videoConferencing\": {\n \"session\": {\n \"guestLink\": \"https://www.wixevents.com/oc?join=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJqb2luXCIsXCJpbnN0YW5jZUlkXCI6XCIxZjZkYzkwNi04MDNkLTQ2NTAtODNmNS03MmVhMWQ4ODEwMGJcIixcImV2ZW50SWRcIjpcImMyNDFlNmUyLWM5NTEtNDQwZC04YjYyLTUyYTZlYzM4MjE0MFwifSIsImlhdCI6MTY5OTQ1MDAxNn0.AfJHpzU54hY8M1oVB0KGe47GUSzOzkWBVpKTTWEXk5Y\",\n \"hostLink\": \"https://www.wixevents.com/oc?start=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiYWN0aW9uXCI6XCJzdGFydFwiLFwiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6XCJjMjQxZTZlMi1jOTUxLTQ0MGQtOGI2Mi01MmE2ZWMzODIxNDBcIn0iLCJpYXQiOjE2OTk0NTAwMTZ9.VmvnxZHBL6cCyE0ZYRdAa6cCud8aNchTTrLJX0b-Mhs\"\n }\n }\n}\n*/"}],"actionParams":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"eventInfo","slug":"event-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixEventUpdateInfo","referenceFqn":"WixEvents.WixEventUpdateInfo"},"description":"Info used to update the Wix event."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixEventInfoOptions","referenceFqn":"WixEvents.WixEventInfoOptions"},"description":"Options to use when updating the Wix event."}],"description":"Updates a Wix event.\r\n\r\nThe `updateEvent()` function returns a Promise that resolves to the newly-updated Wix event after the Wix event is successfully updated.\r\n\r\n Updating a Wix event does not impact existing guests or generated tickets, orders, and invoices.\r\n\r\n Updating the `title` of a Wix event automatically updates the event's `slug` and `eventUrl.path`.\r\n\r\n Only those with \"Manage Events\" permissions can update Wix events.\r\n\r\n> **Note**: This function requires [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) to run.\r\n>\r\n> This function is not [universal](https://www.wix.com/velo/reference/api-overview/api-versions#api-overview_api-versions_universal-modules) and runs only on the backend."}],"webhooks":[],"articles":[{"content":"# Introduction\nThe Events API provides functionality for creating, updating and managing Wix events created in\n the Wix Events app and using this Wix Events API.\n\n ### About Wix Events\n\n [Wix events](https://www.wix.com/velo/reference/wix-events-backend/events) are gatherings that\n an individual or a business holds for a group of people. We\n refer to these people either as guests, participants, or attendees.\n\n To enable Wix Event API functionality for your site, add the [Wix Events](https://support.wix.com/en/article/adding-wix-events-to-your-site) application to your site.\n You must upgrade your site to a [Premium Plan](https://support.wix.com/en/article/upgrading-your-site-to-premium-3066683) in order to accept online payments for events.\n\n The Wix Events API provides functionality allowing you to:\n + [Get](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/get-event) and [query](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/query-events) Wix event information.\n + [Create](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/create-event) and [update](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/update-event) a Wix event.\n + [Copy](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/copy-event) a Wix event.\n + [Cancel](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/cancel-event) and [delete](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/delete-event) Wix events.\n\n ### Wix Events vs. Backend Events\n\n For clarity, this reference refers to:\n + [\"Backend events\"](https://www.wix.com/velo/reference/wix-events-backend/events) when discussing events that get fired and are handled by event handlers.\n + [\"Wix events\"](https://www.wix.com/velo/reference/wix-events-backend/wixevents) when discussing events that people attend.\n\n ### Creating Wix Events\n\n After [adding the Wix Events application](https://support.wix.com/en/article/adding-wix-events-to-your-site) to your site, you can use the\n [createEvent](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/create-event) and the [copyEvent](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/copy-event) functions to\n start building your catalog of events.\n\n To create a Wix event:\n 1. First, start creating the event by specifying certain initial properties.\n 1. Continue event creation by adding more details to the event.\n\n > **Note:** If you are not logged in when creating the event, the `createdBy` property is empty.\n\n #### Start Creating the Event\n\n Similar to the process of creating an event using the Wix Dashboard, there are certain initial properties you must first specify before\n configuring other event settings.\n\n + Event name\n\n + Whether the event is a Ticketed event or an RSVP event.\n\n This information is stored both in the `registration.initialType`\n and the `registration.type` properties.\n + RSVP events: `RSVP`\n + Ticketed events: `TICKETS`\n\n The `registration.initialType` property value becomes read-only and never changes.\n\n The `registration.type` property value might change after initial event creation, depending on any additional configuration applied\n to the event.\n\n #### Continue Defining the Event\n\n After initial event creation, you can continue defining the event by configuring more of its settings. At this point,\n you can use this API to configure settings for: \n + Location\n + Scheduling\n + Registration\n + Tickets\n + RSVPs\n + Online conferencing\n + Messaging customization\n + Basic registration form customization\n\n #### Defining Registration for the Event\n\n At any point you can pause or close registration with the `registrationDisabled` or\n `registrationPaused` properties.\n\n While you continue to define your Wix events, the `registration.type` property value might change. This is\n because the `registration.type` value reflects the actual, current type of the event. For example:\n\n + All events start off with a `registration.type` value of `RSVP` or `TICKETS`, matching the `registration.initialType` property\n (which never changes). This means that guests must register either by ordering tickets or by RSVPing to the event.\n\n + If you want event registration to be managed externally using some other site,\n update the `externalRegistrationUrl` property to `true`. The `registration.type` value is updated to `\"EXTERNAL\"`.\n The guest list and registration are managed externally. Any existing guest list\n originally managed by Wix Events continues to exist, but is no longer maintained by Wix Events.\n Update the `externalRegistrationUrl` property to configure external registration\n and to direct the guest to the given external URL for registration.\n\n + If you want to indicate that guests do not need to register for the event, use the [`updateEvent()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/update-event) function to change\n the `registrationDisabled` property to\n `true`. The `registration.type` value is updated to `\"NO_REGISTRATION\"`. No registration is required, all guests can attend.\n\n\n ### Defining \"TBD\" Events\n\n Most events have known locations, start, and end times.\n\n However, it is possible you might not know the location, date, and time in advance when initially setting up\n the event. You can create events with times and locations\n \"to be determined\" (TBD) later by setting the following properties in the `eventInfo` object when creating the event:\n\n + `schedulingInfo.tbd` to `true`\n + `schedulingInfo.tbdMessage` to text describing that the date and time have not yet been set\n + `locationInfo.tbd` to `true`\n + `locationInfo.name` to text describing that the location has not yet been set\n\n You can define an event with a TBD location and a known date/time, and vice versa. Both `tbd` properties do not have to be `true` at the same time.\n\n When the Wix event's start and end dates are not yet known, a message is displayed at\n registration time/when an attendee registers. The message is defined in the `scheduling.tbdMessage` property. Similarly, when\n the Wix event's location is not yet known, the message defined in the `location.name` property is displayed.\n\n `scheduling.startDate`, `scheduling.endDate`, and `scheduling.timeZoneId` are optional for events without schedules.\n `addressLine1` and `streetAddress` are optional for events without locations.\n\n For example, here is an `eventInfo` object containing the minimum properties necessary for defining an RSVP-type event that is TBD:\n ```\n {\n \"title\": \"My TBD event\",\n \"location\": {\n \"tbd\": true,\n \"name\": \"Location not set yet, check back later.\"\n },\n \"scheduling\": {\n \"tbd\": true,\n \"tbdMessage\": \"Date not set yet, check back later.\"\n },\n \"registration\": {\n \"initialType\": \"RSVP\"\n }\n }\n```\n\n ### Ticketing Considerations\n\n Once a Wix event is created as a ticketed event, it cannot be updated to an RSVP event.\n\n This API lets you set the following for ticket orders:\n\n + The currency for ticket orders.\n + How taxes are handled.\n + Whether a separate registration form is needed for each ticket, or if one form can be used for all guests on the order.\n + Whether guests can see other guests attending the event.\n\n\n ### RSVP Considerations\n\n Once a Wix event is created as an RSVP event, it cannot be updated to a ticketed event.\n\n You can set whether guests can see other guests attending the event.\n\n\n ### Waitlists\n\n Waitlists are supported only for RSVP events.\n\n ### Online Conferencing Considerations\n\n Online conferencing is enabled in the Dashboard. You can see if online conferencing is enabled using the `videoConferencing.enabled` property.\n\n This API lets you set the following for online conferencing:\n\n + Whether the event is a webinar or a meeting.\n + Provider information.\n\n You can also see session information, such as links and passwords.\n\n### Roles and Permissions\n\n You need some combination of the following roles and permissions to work with Wix events.\n\n\n #### Managing Wix Events\n\n With \"Manage Events\" permissions you can create and manage all Wix events, including deleting events, selling tickets,\n and collecting RSVPs.\n\n Anyone with the \"Site owner/Admin\" role can use the dashboard to manage Wix events and see the Wix Event guest list.\n\n Anyone with the \"Check-in assistant\" role (or Assist Check-ins permissions) can view Wix events in the Dashboard, but cannot update them. They can also see the Wix Event guest list.\n\n #### Managing Guest Lists\n\n Anyone with the \"Site owner/Admin\" role can see and manage a Wix Event's guest list.\n\n If a Wix event has a public guest list, attendees can see who else is also attending the event. Attendees do not see the entire guest list, only those that\n indicated that they were attending.\n\n\n #### Registration Forms\n\n Wix Events lets you manage the data collected from guests during registration using forms.\n\n > **Note:** Using this API, you can see current registration form and message settings using the form properties.\n\n A form is an ordered list of input groups (control blocks), which accept guest information into input fields.\n\n Each input group contains one or more nested input fields. For example, a `Name` input group has two input fields: `First Name` and `Last Name`.\n\n By default, name and email controls are always required and are pinned to the top of the form.\n\n### Using the API\n\nTo use the Wix Events API, import `events` from the `wix-events-backend` module:\n\n```javascript\nimport { wixEvents } from \"wix-events-backend\";\n```","displayName":"Introduction","slugifyName":"introduction"}],"namespaces":[{"name":"EventsQueryBuilder","slug":"events-query-builder","fqn":"WixEvents.EventsQueryBuilder","standaloneTypes":[],"metadata":{},"actions":[{"name":"and","fqn":"WixEvents.EventsQueryBuilder.and","slug":"and","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"examples":[{"title":"Add an `and` filter to a query","content":"const newQuery = query1.and(query2);"},{"title":"Create a compound query, with `and` and `or` filters, and run it","description":"The purpose of this query is to retrieve outdated panels and workshops that can be deleted.\n The `outdatedQuery` compound query returns panel sessions and workshops\n that were created or completed before a certain cutoff date (December 31, 2020).\n The format of the event is determined by checking the event's generated slug. Also,\n when combined with the `ne` filter, the query excludes any panels and workshops that might seem\n outdated but are currently in progress.","content":"import { wixEvents } from 'wix-events-backend';\n\n// ...\n\nconst cutoffDate = new Date(\"2020-12-31\");\n\nconst oldDateQuery = \n wixEvents.queryEvents()\n .le(\"_createdDate\", cutoffDate)\n .or(\n wixEvents.queryEvents()\n .lt(\"scheduling.endDate\", cutoffDate)\n );\n\nconst slugQuery = \n wixEvents.queryEvents()\n .contains(\"slug\", \"panel\")\n .or(\n wixEvents.queryEvents()\n .contains(\"slug\", \"workshop\")\n );\n\nconst outdatedQuery = oldDateQuery.and(slugQuery);\n\nreturn wixEvents.queryEvents()\n .ne(\"status\", \"STARTED\").and(outdatedQuery)\n .find()\n .then( (results) => {\n if(results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n return items;\n // handle case where matching outdated panels\n // and workshops that \n // are not in progress are found, \n // such as deleting them\n } else {\n // handle case where no matching outdated \n // panels and workshops are found, or \n // they are still in progress\n }\n } )\n .catch( (error) => {\n const queryError = error;\n } );\n\n/*\n * The results contain outdated events\n * (created or completed earlier than \n * January 1, 2021) \n * with slugs that contain \n * \"panel\" or \"workshop\":\n *\n * climate-crisis-panel\n * basket-weaving-workshop\n * macrame-workshop\n * \n * But not events that are currently \n * in progress (status = \"STARTED\")\n */"}],"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder"},"description":"Contains functionality for refining a Wix events query."}],"description":"Adds an `and` condition to the query.\r\n\r\nThe `and()` function adds an `and` condition to an `EventsQueryBuilder`.\r\nA query with an `and` returns all the items that match the query\r\nas defined up to the `and` function and also match the query or\r\nfilter passed to the `and` function.\r\n\r\nNote that when chaining multiple `EventsQueryBuilder` functions to a query an `and` condition is assumed.\r\nIn such cases, you do not need to add a call to the `and()` function.\r\nFor example, this query returns results where status is either `SCHEDULED` or `STARTED` **and** a specific\r\nevent manager created the event. \r\n\r\n```javascript\r\nwixEvents.queryEvents()\r\n .hasSome(\"status\", [\"SCHEDULED\", \"STARTED\"])\r\n .eq(\"createdBy\", \"4c47c608-cfa8-4037-93ac-738f09560ed3\");\r\n```\r\n\r\nThe `and()` function is needed when performing compound queries. For\r\nexample, the final query in this set of queries returns results where the event is an introductory class\r\nwhose title contains either `beginner` or `basic` **and** whose status is either `STARTED` or `ENDED`. If\r\nboth these conditions are `true` we might want to let the participants for these introductory classes know about\r\nupcoming intermediate level classes.\r\n\r\n```javascript\r\nlet levelQuery = wixEvents.queryEvents()\r\n .contains(\"title\", \"beginner\")\r\n .or(\r\n wixEvents.queryEvents()\r\n .contains(\"title\", \"basic\")\r\n);\r\n\r\nlet statusQuery = wixEvents.queryEvents()\r\n .hasSome(\"status\", [\"STARTED\", \"ENDED\"])\r\n\r\nlet readyForIntermediateQuery = levelQuery.and(statusQuery);\r\n```\r\n\r\nThe `and()` function is designed to work with 2 or more queries or filters.\r\nIf you use it on its own, it will return all the items in a collection."},{"name":"ascending","fqn":"WixEvents.EventsQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"examples":[{"title":"Add an `ascending` sort to a query","content":"const query = wixEvents.queryEvents().ascending(\"_createdDate\");"},{"title":"Create a query, add an `ascending` sort, and run it","content":"import { wixEvents } from 'wix-events-backend';\n\n// ...\n\nwixEvents.queryEvents()\n .ascending(\"_createdDate\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n const queryError = error;\n });"},{"title":"Retrieve the first 5 upcoming events for a given event manager","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { wixEvents } from 'wix-events-backend';\n\nexport const myQueryEventFunction = webMethod(Permissions.Anyone, () => {\n return wixEvents.queryEvents()\n .eq(\"createdBy\", \"4c47c608-cfa8-4037-93ac-738f09560ed3\")\n .hasSome(\"status\", [\"SCHEDULED\", \"STARTED\"])\n .ascending(\"scheduling.startDate\")\n .limit(5)\n .find()\n .then((results) => {\n const firstItem = results.items[0]; //see item below\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/* firstItem is: \n *\n * {\n * \"about\": \"

Save the date! Great fair for health-minded people who care about the environment and healthy living.

\",\n * \"assignedContactsLabel\": \"custom.crafts-wholistic-craft-fair-time-is-tbd\",\n * \"calendarLinks\": {\n * \"google\": \"http://calendar.google.com/calendar/render?action=TEMPLATE&text=Crafts%3A+Wholistic+Craft+Fair&dates=20210930T230000Z%2F20211001T030000Z&location=&details=Thank+you+for+registering+to+our+event%21+Your+tickets+are+attached+to+this+email.+Don%27t+forget+to+bring+them.%0A%0AWe%27re+looking+forward+to+seeing+you+there.%0A%0AHere+are+the+details%3A%0A%0ACrafts%3A+Wholistic+Craft+Fair%0ASeptember+30%2C+2021%2C+7%3A00+PM+%E2%80%93+11%3A00+PM%0AModi%27in-Maccabim-Re%27ut\",\n * \"ics\": \"https://www.wixevents.com/media/calendar/265e0437-7730-43d6-ae24-7918bb9bb05b?token=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiZXZlbnRJZFwiOntcInZhbHVlXCI6XCIyNjVlMDQzNy03NzMwLTQzZDYtYWUyNC03OTE4YmI5YmIwNWJcIn0sXCJvY0xpbmtcIjpudWxsfSIsImlhdCI6MTYyNjY4OTI2NH0.u9kHEkFXL6dHBOtADjam7KSx0guh4MVUqWRoqKj3ZlY\"\n * },\n * \"createdBy\": \"4c47c608-cfa8-4037-93ac-738f09560ed3\",\n * \"_createdDate\": \"2021-04-28T06:10:36.714Z\",\n * \"description\": \"This is the annual wholistic craft fair for organic and health-conscious foods, arts, items, crafts, sessions.... and more! \",\n * \"eventUrl\": {\n * \"baseUrl\": \"https://mysite.wixsite.com/lectures\",\n * \"path\": \"/event-details/crafts-wholistic-craft-fair\"\n * },\n * \"form\": {\n * \"inputGroups\": [\n * {\n * \"_id\": \"name\",\n * \"inputs\": [\n * {\n * \"additionalLabels\": [],\n * \"label\": \"First Name\",\n * \"maxLength\": 50,\n * \"name\": \"firstName\",\n * \"options\": [],\n * \"required\": true,\n * \"type\": \"TEXT\"\n * },\n * {\n * \"additionalLabels\": [],\n * \"label\": \"Last Name\",\n * \"maxLength\": 50,\n * \"name\": \"lastName\",\n * \"options\": [],\n * \"required\": true,\n * \"type\": \"TEXT\"\n * }\n * ],\n * \"orderIndex\": 0,\n * \"system\": true,\n * \"type\": \"NAME\"\n * },\n * {\n * \"_id\": \"email\",\n * \"inputs\": [\n * {\n * \"additionalLabels\": [],\n * \"label\": \"Email\",\n * \"maxLength\": 50,\n * \"name\": \"email\",\n * \"options\": [],\n * \"required\": true,\n * \"type\": \"TEXT\"\n * }\n * ],\n * \"orderIndex\": 1,\n * \"system\": true,\n * \"type\": \"INPUT\"\n * }\n * ],\n * \"messages\": {\n * \"checkout\": {\n * \"checkoutLabel\": \"Continue\",\n * \"title\": \"Add Your Details\"\n * },\n * \"registrationClosed\": {\n * \"exploreEventsLabel\": \"See other events\",\n * \"message\": \"Registration is Closed\"\n * },\n * \"rsvp\": {\n * \"noMessages\": {\n * \"confirmationTitle\": \"Sorry You Can't Make It\",\n * \"shareLabel\": \"Share\",\n * \"title\": \"Add Your Details\"\n * },\n * \"rsvpNo\": \"Not Going\",\n * \"rsvpYes\": \"I'm Going\",\n * \"submitRsvpLabel\": \"SUBMIT\",\n * \"waitingMessages\": {\n * \"addToCalendarLabel\": \"Add to Calendar\",\n * \"confirmationMessage\": \"We'll update you if additional spots become available.\",\n * \"confirmationTitle\": \"Thanks! You've been added to the waitlist.\",\n * \"shareLabel\": \"Share\",\n * \"title\": \"Looks Like This Event Is Full. Join the waiting list\"\n * },\n * \"yesMessages\": {\n * \"addToCalendarLabel\": \"Add to Calendar\",\n * \"confirmationMessage\": \"An email with all the event info was sent to you.\",\n * \"confirmationTitle\": \"Thank you! See you soon.\",\n * \"shareLabel\": \"Share\",\n * \"title\": \"Add Your Details\"\n * }\n * }\n * }\n * },\n * \"guestList\": {\n * \"public\": true\n * },\n * \"_id\": \"265e0437-7730-43d6-ae24-7918bb9bb05b\",\n * \"language\": \"en\",\n * \"location\": {\n * \"name\": \"My Location\",\n * \"tbd\": true,\n * \"type\": \"VENUE\"\n * },\n * \"mainImage\": \"wix:image://v1/c1ec532b6db54aa4bc3275363c5ba35e.jpg/file#originWidth=2700&originHeight=1800\",\n * \"registration\": {\n * \"initialType\": \"TICKETS\",\n * \"restrictedTo\": \"VISITOR\",\n * \"rsvp\": {\n * \"responseOptions\": \"YES_ONLY\",\n * \"waitlist\": false\n * },\n * \"status\": \"OPEN_TICKETS\",\n * \"tickets\": {\n * \"currency\": \"USD\",\n * \"formAssignedPerTicket\": false,\n * \"highestTicketPrice\": {\n * \"currency\": \"USD\",\n * \"value\": \"20.50\"\n * },\n * \"highestTicketPriceFormatted\": \"$20.50\",\n * \"lowestTicketPrice\": {\n * \"currency\": \"USD\",\n * \"value\": \"10.25\"\n * },\n * \"lowestTicketPriceFormatted\": \"$10.25\",\n * \"tax\": {}\n * },\n * \"type\": \"TICKETS\"\n * },\n * \"scheduling\": {\n * \"endDate\": \"2021-10-01T03:00:00.000Z\",\n * \"formatted\": \"September 30, 2021, 7:00 PM – 11:00 PM\",\n * \"hideEndDate\": false,\n * \"showTimeZone\": false,\n * \"startDate\": \"2021-09-30T23:00:00.000Z\",\n * \"startDateFormatted\": \"September 30, 2021\",\n * \"startTimeFormatted\": \"7:00 PM\",\n * \"tbd\": false,\n * \"timeZoneId\": \"America/New_York\"\n * },\n * \"slug\": \"crafts-wholistic-craft-fair\",\n * \"status\": \"SCHEDULED\",\n * \"summary\": {\n * \"rsvp\": {},\n * \"tickets\": {\n * \"revenue\": {},\n * \"totalSales\": {}\n * }\n * },\n * \"title\": \"Crafts: Wholistic Craft Fair\",\n * \"_updatedDate\": \"2021-07-12T14:18:07.000Z\",\n * \"videoConferencing\": {\n * \"session\": {}\n * }\n * }\n */"}],"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"limit The number of items to return, which is also the [`pageSize`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/page-size) of the results object."}],"description":"Limits the number of items the query returns.\r\n\r\nThe `limit()` function defines the number of results a query returns in each\r\npage. Only one page of results is retrieved at a time. The [`next()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/next)\r\nand [`prev()`](wix-events-backend.eventsqueryresult.htmlhttps://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/prev) functions are used to\r\nnavigate the pages of a query result.\r\n\r\nBy default, `limit` is set to `50`.\r\n\r\nThe maximum value that `limit()` can accept is `1000`."},{"name":"lt","fqn":"WixEvents.EventsQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"examples":[{"title":"Add a \"less than\" filter to a query","content":"const query = wixEvents.queryEvents().lt(\"_updatedDate\", \"2021-01-27T10:00:00.000Z\");"},{"title":"Create a query, add a \"less than\" filter, and run it","content":"import { wixEvents } from 'wix-events-backend';\n\n// ...\n\nwixEvents.queryEvents()\n .lt(\"_updatedDate\", \"2021-01-27T10:00:00.000Z\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n const queryError = error;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `scheduling.startDate`\r\n+ `scheduling.endDate`\r\n+ `title`\r\n+ `slug`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is less than the specified value.\r\n\r\nThe `lt()` function refines an `EventsQueryBuilder` to only\r\nmatch items where the value of the specified property is less than the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nIf a property contains a number as a String, that value will be compared\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified property are ranked lowest.\r\n\r\nThe following types of properties can be compared:\r\n\r\n+ Number: Compares numerically.\r\n+ Date: Compares JavaScript Date objects.\r\n+ String: Compares lexicographically, so `\"Text\"` is less than `\"text\"`."},{"name":"ne","fqn":"WixEvents.EventsQueryBuilder.ne","slug":"ne","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"examples":[{"title":"Add a \"not equals\" filter to a query","content":"const query = wixEvents.queryEvents().ne(\"primary\", false);"},{"title":"Create a query, add a \"not equals\" filter, and run it","content":"import { wixEvents } from 'wix-events-backend';\n\n// ...\n\nwixEvents.queryEvents()\n .ne(\"primary\", false)\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n const queryError = error;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `_id`\r\n+ `title`\r\n+ `createdBy`\r\n+ `status`\r\n+ `slug`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value does not equal the specified value.\r\n\r\nThe `ne()` function refines an `EventsQueryBuilder` to only\r\nmatch items where the value of the specified property does not equal the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nMatching strings with `ne()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\nIf the value of the `propertyName` property is an Array, `ne()` includes items\r\nin which none of the elements of the Array match the specified `value`."},{"name":"not","fqn":"WixEvents.EventsQueryBuilder.not","slug":"not","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"examples":[{"title":"Add a `not` filter to a query","content":"const newQuery = query1.not(query2);"},{"title":"Create a query, add a `not` filter, and run it","description":"The results for this query do not contain any events for advanced attendees. This is determined\n by looking for titles that contain the string \"advanced.\"","content":"import { wixEvents } from 'wix-events-backend';\n\n// ...\n\nwixEvents.queryEvents()\n .not(wixEvents.queryEvents().contains(\"title\", \"advanced\"))\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n const queryError = error;\n });"}],"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder"},"description":"Contains functionality for refining a Wix events query."}],"description":"Adds an `not` condition to the query.\r\n\r\nThe `not()` function adds a `not` condition to an `EventsQueryBuilder`. A query\r\nwith a `not` returns all the items that match the query as defined up to\r\nthe `not` function, but don't match the query passed to the `not` function.\r\n\r\nIf the query only contains a `not()` function, it returns all the items\r\nthat don't match the query defined by the `not` method."},{"name":"or","fqn":"WixEvents.EventsQueryBuilder.or","slug":"or","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"examples":[{"title":"Add an `or` filter to a query","content":"const newQuery = query1.or(query2);"},{"title":"Create a compound query, with `and` and `or` filters, and run it","description":"The purpose of this query is to retrieve outdated panel sessions and workshops that can be deleted.\n The `outdatedQuery` compound query returns panels and workshops\n that were created or completed before a certain cutoff date (December 31, 2020).\n The format of the event is determined by checking the event's generated slug. Also,\n when combined with the `ne` filter, the query excludes any panels and workshops that might seem\n outdated but are currently in progress.","content":"import { wixEvents } from 'wix-events-backend';\n\n// ...\n\nconst cutoffDate = new Date(\"2020-12-31\");\n\nconst oldDateQuery = \n wixEvents.queryEvents()\n .le(\"_createdDate\", cutoffDate)\n .or(\n wixEvents.queryEvents()\n .lt(\"scheduling.endDate\", cutoffDate)\n );\n\nconst slugQuery = \n wixEvents.queryEvents()\n .contains(\"slug\", \"panel\")\n .or(\n wixEvents.queryEvents()\n .contains(\"slug\", \"workshop\")\n );\n\nconst outdatedQuery = oldDateQuery.and(slugQuery);\n\nreturn wixEvents.queryEvents()\n .ne(\"status\", \"STARTED\").and(outdatedQuery)\n .find()\n .then( (results) => {\n if(results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n return items;\n // handle case where matching outdated panels\n // and workshops that \n // are not in progress are found, \n // such as deleting them\n } else {\n // handle case where no matching outdated \n // panels and workshops are found, or \n // they are still in progress\n }\n } )\n .catch( (error) => {\n const queryError = error;\n } );\n\n/*\n * The results contain outdated events\n * (created or completed earlier than \n * January 1, 2021) \n * with slugs that contain \n * \"panel\" or \"workshop\":\n *\n * climate-crisis-panel\n * basket-weaving-workshop\n * macrame-workshop\n * \n * But not events that are currently \n * in progress (status = \"STARTED\")\n */"}],"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder"},"description":"Contains functionality for refining a Wix events query."}],"description":"Adds an `or` condition to the query.\r\n\r\nThe `or()` function adds an inclusive `or` condition to an `EventsQueryBuilder`. A query\r\nwith an `or` returns all the items that match the query as defined up to\r\nthe `or` function, the items that match the query passed to the `or`\r\nfunction, and the items that match both.\r\n\r\nThe `or()` function is designed to work with 2 or more queries.\r\nIf you use it on its own, it will return all the items in a collection."},{"name":"skip","fqn":"WixEvents.EventsQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder","description":"Contains functionality for refining a Wix events query."},"examples":[{"title":"Add a skip to a query","content":"const query = wixEvents.queryEvents().skip(10);"},{"title":"Create a query, add a skip, and run it","content":"import { wixEvents } from 'wix-events-backend';\n\n// ...\n\nwixEvents.queryEvents()\n .skip(10)\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n const queryError = error;\n });"}],"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\r\n\r\nThe `skip()` function defines the number of results to skip in the query\r\nresults before returning new query results.\r\n\r\nFor example, if you query a collection and 50 items match your query, but\r\nyou set `skip` to 10, the results returned will skip the first 10 items\r\nthat match and return the 11th through 50th items.\r\n\r\nBy default, `skip` is set to 0."}],"webhooks":[],"articles":[{"content":"# Introduction\nThe `EventsQueryBuilder` functions enable you to run, sort, filter, and control\nwhich results a query returns.\n\nTypically, you build a query using any of the event query functions,\nrefine the query by chaining `EventsQueryBuilder` functions, and then execute the\nquery by chaining the [`find()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/find) function.\n\n\nFor example, the following code returns the first 5 upcoming Wix events created by\na given event manager, including scheduled events and events that\nhave started. The events are listed in ascending\norder by the event's start date.\n\n\n```javascript\nimport { wixEvents } from 'wix-events-backend';\n\nwixEvents.queryEvents()\n .eq(\"createdBy\", \"4c47c608-cfa8-4037-93ac-738f09560ed3\")\n .hasSome(\"status\", [\"SCHEDULED\", \"STARTED\"])\n .ascending(\"scheduling.startDate\")\n .limit(5)\n .find()\n .then( (results) => {\n console.log(results.items);\n } );\n```","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"EventsQueryResult","slug":"events-query-result","fqn":"WixEvents.EventsQueryResult","standaloneTypes":[],"metadata":{},"actions":[{"name":"hasNext","fqn":"WixEvents.EventsQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"examples":[{"title":"Get the next page of a query result","content":"const hasNext = results.hasNext(); // true"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"import { wixEvents } from 'wix-events-backend';\n\nasync function retrieveAllItems() {\n let allItems = [];\n\n const results = await wixEvents.queryEvents()\n .limit(100)\n .find();\n allItems.push(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems.push(results.items);\n }\n return allItems;\n}\n"}],"description":"Indicates if the query has more results."},{"name":"hasPrev","fqn":"WixEvents.EventsQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"examples":[{"title":"Get the previous page of a query result","content":"const hasPrev = results.hasPrev(); // false"}],"description":"Indicates if the query has previous results."},{"name":"next","fqn":"WixEvents.EventsQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"EventsQueryResult","referenceFqn":"WixEvents.EventsQueryResult.EventsQueryResult"},"description":"Fulfilled - The results of a Wix events query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-events-backend.eventsquerybuilder.htmlhttps://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/find)\r\nfunction, it returns a Promise that resolves to an `EventsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"examples":[{"title":"Get the next page of a query result","content":"oldResults.next()\n .then((results) => {\n const newResults = results;\n const items = newResults.items;\n const firstItem = items[0];\n const totalCount = newResults.totalCount;\n const pageSize = newResults.pageSize;\n const currentPage = newResults.currentPage;\n const totalPages = newResults.totalPages;\n const hasNext = newResults.hasNext();\n const hasPrev = newResults.hasPrev();\n const length = newResults.length;\n const query = newResults.query;\n })\n .catch((error) => {\n const queryError = error;\n });"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"import { wixEvents } from 'wix-events-backend';\n\nasync function retrieveAllItems() {\n let allItems = [];\n\n const results = await wixEvents.queryEvents()\n .limit(100)\n .find();\n allItems.push(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems.push(results.items);\n }\n return allItems;\n}\n"}],"description":"Retrieves the next page of query results.\r\n\r\nThe `next()` function retrieves the next page of query results.\r\n\r\nThe page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/page-size) property, and\r\nnavigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/prev) and\r\n[`next()`](wix-events/events-query-result/next) functions.\r\n\r\nIf items are added or removed between calls to `next()` the values returned\r\nby `EventsQueryResult` may change."},{"name":"prev","fqn":"WixEvents.EventsQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"EventsQueryResult","referenceFqn":"WixEvents.EventsQueryResult.EventsQueryResult"},"description":"Fulfilled - The results of a Wix events query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-events-backend.eventsquerybuilder.htmlhttps://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/find)\r\nfunction, it returns a Promise that resolves to an `EventsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"examples":[{"title":"Get the previous page of a query result","content":"oldResults.prev()\n .then((results) => {\n const newResults = results;\n const items = newResults.items;\n const firstItem = items[0];\n const totalCount = newResults.totalCount;\n const pageSize = newResults.pageSize;\n const currentPage = newResults.currentPage;\n const totalPages = newResults.totalPages;\n const hasNext = newResults.hasNext();\n const hasPrev = newResults.hasPrev();\n const length = newResults.length;\n const query = newResults.query;\n })\n .catch((error) => {\n const queryError = error;\n });"}],"description":"Retrieves the previous page of query results.\r\n\r\nThe `prev()` function retrieves the previous page of query results.\r\n\r\nThe page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/page-size) property, and\r\nnavigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/prev) and\r\n[`next()`](wix-events/events-query-result/next) functions.\r\n\r\nIf items are added or removed between calls to `prev()` the values returned\r\nby `EventsQueryResult` may change."}],"webhooks":[],"articles":[{"content":"# Introduction\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/find)\nfunction, it returns a Promise that resolves to an `EventsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[{"name":"currentPage","slug":"current-page","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the current page index of a query result","content":"const resultPage = results.currentPage; // 0"},{"title":"Perform a query and get the current page index of the query result","content":"import { wixEvents } from 'wix-events-backend';\n\n// ...\n\nwixEvents.queryEvents()\n .find()\n .then((results) => {\n const resultPage = results.currentPage; // 0\n })\n .catch((error) => {\n const queryError = error;\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the index of the current results page number.\r\n\r\nThe `currentPage` is a zero-based index of the current page of results.\r\n\r\nThe page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/page-size) property, and\r\nnavigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/prev) and\r\n[`next()`](wix-events/events-query-result/next) functions.\r\n\r\nThe `currentPage` property returns `undefined` if the query returned no results."},{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Perform a find on a query","content":"import { wixEvents } from 'wix-events-backend';\n\n// ...\n\nwixEvents.queryEvents()\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n const queryError = error;\n });"}],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"WixEvent","referenceFqn":"WixEvents.WixEvent"}},"description":"Returns the items that match the query.\r\n\r\nThe current page of Wix events retrieved by the query.\r\n\r\n> **Note:** When no items match the query, the `items` array is empty.\r\n\r\nTo paginate your query results, use the `EventsQueryResult` pagination properties and functions."},{"name":"length","slug":"length","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the length of a query result","content":"const resultLength = results.length; // 20"},{"title":"Perform a query and get the length of the result","content":"import { wixEvents } from 'wix-events-backend';\n\n// ...\n\nwixEvents.queryEvents()\n .find()\n .then((results) => {\n const resultLength = results.length; // 20\n })\n .catch((error) => {\n const queryError = error;\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current results page.\r\n\r\nThe page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/page-size) property, and\r\nnavigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/prev) and\r\n[`next()`](wix-events/events-query-result/next) functions."},{"name":"pageSize","slug":"page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the page size of a query result","content":"const resultPageSize = results.pageSize; // 50"},{"title":"Perform a query and get the page size of the result","content":"import { wixEvents } from 'wix-events-backend';\n\n// ...\n\nwixEvents.queryEvents()\n .find()\n .then((results) => {\n const resultPageSize = results.pageSize; // 50\n })\n .catch((error) => {\n const queryError = error;\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the query page size.\r\n\r\nThe page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/page-size) property, and\r\nnavigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/prev) and\r\n[`next()`](wix-events/events-query-result/next) functions."},{"name":"query","slug":"query","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query that produced a query result","content":"const resultQuery = results.query;"},{"title":"Perform a query and get the query that produced the result","content":"import { wixEvents } from 'wix-events-backend';\n\n// ...\n\nwixEvents.queryEvents()\n .find()\n .then((results) => {\n const newQuery = results.query;\n newQuery\n .ge(\"_createdDate\", \"2021-01-01T15:21:41.960Z\")\n .find()\n .then((newQueryResults) => {\n const firstItem = newQueryResults.items[0];\n })\n })\n .catch((error) => {\n const queryError = error;\n });"}],"type":{"kind":"REFERENCE","name":"EventsQueryBuilder","referenceFqn":"WixEvents.EventsQueryBuilder.EventsQueryBuilder"},"description":"Contains functionality for refining a Wix events query.\r\n\r\nThe `EventsQueryBuilder` functions enable you to run, sort, filter, and control\r\n which results a query returns.\r\n\r\n Typically, you build a query using any of the event query functions,\r\n refine the query by chaining `EventsQueryBuilder` functions, and then execute the\r\n query by chaining the [`find()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/find) function.\r\n\r\n For example, the following code returns the first 5 upcoming Wix events created by\r\n a given event manager, including scheduled events and events that\r\n have started. The events are listed in ascending\r\n order by the event's start date.\r\n\r\n ```javascript\r\n import { wixEvents } from 'wix-events-backend';\r\n\r\n wixEventsBackend.queryEvents()\r\n .eq(\"createdBy\", \"4c47c608-cfa8-4037-93ac-738f09560ed3\")\r\n .hasSome(\"status\", [\"SCHEDULED\", \"STARTED\"])\r\n .ascending(\"scheduling.startDate\")\r\n .limit(5)\r\n .find()\r\n .then( (results) => {\r\n console.log(results.items);\r\n } );\r\n```"},{"name":"totalCount","slug":"total-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the number of items in a query result","content":"const resultCount = results.totalCount; // 150"},{"title":"Perform a query and get the number of items in the result","content":"import { wixEvents } from 'wix-events-backend';\n\n// ...\n\nwixEvents.queryEvents()\n .find()\n .then((results) => {\n const resultCount = results.totalCount; // 150\n })\n .catch((error) => {\n const queryError = error;\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of items that match the query.\r\n\r\nThe `totalCount` returns the total number of items that match the query,\r\n not just the number of items in the current page."},{"name":"totalPages","slug":"total-pages","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the total number of pages in a query result","content":"const resultPages = results.totalPages; // 3"},{"title":"Perform a query and get the total number of pages in the result","content":"import { wixEvents } from 'wix-events-backend';\n\n// ...\n\nwixEvents.queryEvents()\n .find()\n .then((results) => {\n const resultPages = results.totalPages; // 3\n })\n .catch((error) => {\n const queryError = error;\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of pages the query produced.\r\n\r\nThe page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/page-size) property, and\r\nnavigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/prev) and\r\n[`next()`](wix-events/events-query-result/next) functions."}]}],"builderTypes":[],"properties":[]}],"builderTypes":[],"properties":[{"name":"wixEvents","slug":"wix-events","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixEvents","referenceFqn":"WixEvents.WixEvents"},"description":"The Events API provides functionality for updating and managing events created in the Wix Events app or using this Wix Events API."}],"articles":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.0"},"resourceMetadata":{"lastModifiedBy":"","sourcePath":"","yamlPath":"","name":"wix-events-backend","yamlTitle":"Wix Events Backend 1 0 0","kind":"VELO"}}

onEventCanceled( )