Event Object


An Event is a structured record of a scheduled gathering, including its title, location, date and time, registration settings, status, and related URLs.

You can use it to model and display event details, configure how guests register, and manage visibility and calendars across the site or app.

Properties
agendaSettingsAgendaSettings

Event schedule details.
Note: This field is returned only when the AGENDA fieldset is included in the request.


calendarUrlsCalendarUrlsRead-only

URLs that allow you to add an event to the Google calendar, or to download an ICS calendar file.
Note: This field is returned only when the DETAILS fieldset is included in the request.


contactLabelstringRead-only

Assigned contacts label key.


createdDatestringRead-onlyformat date-time

Date and time when the event was created.


dateAndTimeSettingsDateAndTimeSettings

Event date and time settings.


descriptionRichContent

Event description. Fallback Message for SSR and Error


detailedDescriptionstringdeprecated - use description insteadmaxLength 50000

Detailed description of an event.

This field is deprecated.


eventDisplaySettingsEventDisplaySettings

Visual settings for event.


eventPageUrlPageUrl

Event page URL components.
Note: This field is returned only when the URLS fieldset is included in the request.


formForm

Event registration form.
Note: This field is returned only when the FORM fieldset is included in the request.


guestListSettingsGuestListSettings

Guest list configuration.


idstringRead-onlyformat GUID

Event ID.


instanceIdstringRead-only

Instance ID of the site where the event is hosted.


locationLocation

Event location.


mainImageImage

Main event image.
Note: This field is returned only when the DETAILS fieldset is included in the request.


onlineConferencingOnlineConferencing

Online conferencing details.
Note: This field is returned only when the ONLINE_CONFERENCING_SESSION fieldset is included in the request and you have the "WIX_EVENTS.READ_ONLINE_CONFERENCING" permissions.


publishedDatestringRead-onlyformat date-time

Event publish timestamp.


registrationRegistration

RSVP or ticketing registration details.
Note: This field is returned only when the REGISTRATION fieldset is included in the request.


seoSettingsSeoSettings

SEO settings.
Note: This field is returned only when the SEO_SETTINGS fieldset is included in the request.


shortDescriptionstringmaxLength 500

Short description that appears under the event title. Note: This field is returned only when the DETAILS fieldset is included in the request.


slugstringRead-only

Unique identifier of the event page. The naming is the same as the event title written in kebab case. For example, if your event title is "Leather Crafting 101", then the slug is "leather-crafting-101".


statusstringRead-only

Event status.


summariesSummaries

Summary of RSVP or ticket sales.
Note: This field is returned only when the DASHBOARD fieldset is included in the request and you have the "WIX_EVENTS.READ_EVENT_DASHBOARD" permissions.


titlestringminLength 1maxLength 120

Event title.


updatedDatestringRead-onlyformat date-time

Date and time when the event was updated.


userIdstringRead-onlyformat GUID

ID of the user who created the event.

Did this help?