Event Object


Properties
idstringRead-onlyformat GUID

Event ID.


locationobject

Event location.


dateAndTimeSettingsobject

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.


mainImageobject

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
6 enum supported values:
UNKNOWN_EVENT_STATUSUPCOMINGSTARTEDENDEDCANCELEDDRAFT

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.

registrationobject

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


calendarUrlsobjectRead-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.


eventPageUrlobject

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


formobject

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


summariesobject

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.


guestListSettingsobject

Guest list configuration.


userIdstringRead-onlyformat GUID

ID of the user who created the event.


onlineConferencingobject

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.


seoSettingsobject

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


contactLabelstringRead-only

Assigned contacts label key.


agendaSettingsobject

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


eventDisplaySettingsobject

Visual settings for event.

Was this helpful?
Yes
No