Event Object


Properties
idstringRead-onlyformat GUID

Event ID.


locationLocation

Event location.


dateAndTimeSettingsDateAndTimeSettings

Event date and time settings.


titlestringminLength 1maxLength 120

Event title.


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.


detailedDescriptionstringmaxLength 50000

Detailed description of an event. You can enter the description using rich text format (add various types of markups, such as underlines, italics, bolding, color codes, bullet lists, and links by using HTML formatting tags).
Note: This field is returned only when the TEXTS fieldset is included in the request.


mainImageMainImage

Main event image.
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".


createdDatestringRead-onlyformat date-time

Date and time when the event was created.


updatedDatestringRead-onlyformat date-time

Date and time when the event was updated.


statusstringRead-only

Event status. Possible values:

  • UPCOMING: Event is published and scheduled to start.
  • STARTED: Event has started.
  • ENDED: Event has ended.
  • CANCELED: Event is canceled.
  • DRAFT: Event is not published.

registrationRegistration

RSVP or ticketing registration details.
Note: This field is returned only when the REGISTRATION 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.


eventPageUrlEventPageUrl

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.


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.


instanceIdstringRead-only

Instance ID of the site where the event is hosted.


guestListSettingsGuestListSettings

Guest list configuration.


userIdstringRead-onlyformat GUID

ID of the user who created the event.


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.


seoSettingsSeoSettings

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


contactLabelstringRead-only

Assigned contacts label key.


agendaSettingsAgendaSettings

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


eventDisplaySettingsEventDisplaySettings

Visual settings for event.

Did this help?