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.


detailedDescriptionstringdeprecated - use description insteadmaxLength 50000

Detailed description of an event.

This field is deprecated.


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.


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.


descriptionDescriptionbeta

Event description. Fallback Message for SSR and Error

Event
JSON
{ "event": { "id": "75d64b92-4078-457a-9259-fef2948459f7", "location": { "name": "Javits Center", "type": "VENUE", "address": { "country": "US", "subdivision": "NY", "city": "New York", "postalCode": "10001", "streetAddress": { "number": "429", "name": "11th Avenue", "apt": "", "formattedAddressLine": null }, "addressLine2": null, "formattedAddress": "429 11th Ave, New York, NY 10001, USA", "hint": null, "geocode": { "latitude": 40.7575505, "longitude": -74.0024691 }, "countryFullname": "United States", "subdivisions": [ { "code": "NY", "name": "New York", "type": "ADMINISTRATIVE_AREA_LEVEL_1", "typeInfo": null }, { "code": "New York County", "name": "New York County", "type": "ADMINISTRATIVE_AREA_LEVEL_2", "typeInfo": null }, { "code": "New York", "name": "New York", "type": "ADMINISTRATIVE_AREA_LEVEL_3", "typeInfo": null }, { "code": "US", "name": "United States", "type": "COUNTRY", "typeInfo": null } ], "subdivisionFullName": null }, "locationTbd": false }, "dateAndTimeSettings": { "dateAndTimeTbd": false, "dateAndTimeTbdMessage": null, "startDate": "2023-10-15T13:00:00Z", "endDate": "2023-10-17T22:00:00Z", "timeZoneId": "America/Toronto", "hideEndDate": false, "showTimeZone": true, "recurrenceStatus": "ONE_TIME", "recurringEvents": { "individualEventDates": [], "categoryId": null }, "formatted": { "dateAndTime": "15 October 2023 at 09:00 – 17 October 2023 at 18:00 GMT-4", "startDate": "15 October 2023", "startTime": "09:00", "endDate": "17 October 2023", "endTime": "18:00" } }, "title": "Cosmic Odyssey: Exploring the Mysteries of the Universe", "shortDescription": "Embark on an extraordinary voyage through the vast expanse of the cosmos!", "description": { "nodes": [ { "type": "PARAGRAPH", "id": "70zrx108", "nodes": [ { "type": "TEXT", "id": "", "textData": { "text": "Embark on an extraordinary journey beyond the stars at " } }, { "type": "TEXT", "id": "", "textData": { "text": "Cosmic Odyssey: Exploring the Mysteries of the Universe", "decorations": [ { "type": "ITALIC", "italicData": true } ] } }, { "type": "TEXT", "id": "", "textData": { "text": ". This immersive event brings together renowned astronomers, astrophysicists, and space enthusiasts to delve into the wonders of the cosmos." } } ] }, { "type": "PARAGRAPH", "id": "bgewn109" } ] }, "mainImage": null, "slug": "cosmic-odyssey-exploring-the-mysteries-of-the-universe", "languageCode": "en", "createdDate": "2023-07-12T10:50:59.287Z", "updatedDate": "2023-07-12T10:58:58Z", "status": "UPCOMING", "registration": { "type": "TICKETING", "status": "OPEN_TICKETS", "rsvp": { "responseType": "YES_ONLY", "limit": null, "waitlistEnabled": false, "startDate": null, "endDate": null }, "tickets": { "guestsAssignedSeparately": false, "ticketLimitPerOrder": 50, "stockManagerAppId": null, "currency": "EUR", "lowestPrice": { "value": "20.50", "currency": "EUR", "formattedValue": "€20.50" }, "highestPrice": { "value": "20.50", "currency": "EUR", "formattedValue": "€20.50" }, "soldOut": false, "taxSettings": null }, "external": null, "allowedGuestTypes": "VISITOR_OR_MEMBER", "initialType": "TICKETING", "registrationPaused": false, "registrationDisabled": false }, "calendarUrls": { "google": "http://calendar.google.com/calendar/render?action=TEMPLATE&text=Cosmic+Odyssey%3A+Exploring+the+Mysteries+of+the+Universe&dates=20231015T130000Z%2F20231017T220000Z&location=429+11th+Ave%2C+New+York%2C+NY+10001%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%0ACosmic+Odyssey%3A+Exploring+the+Mysteries+of+the+Universe%0A15+October+2023+at+09%3A00+%E2%80%93+17+October+2023+at+18%3A00+GMT-4%0AJavits+Center%2C+429+11th+Ave%2C+New+York%2C+NY+10001%2C+USA", "ics": "https://www.wixevents.com/media/v2/calendar?token=JWS.eyJraWQiOiJpb21iOUJ0eSIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiaW5zdGFuY2VJZFwiOlwiMWY2ZGM5MDYtODAzZC00NjUwLTgzZjUtNzJlYTFkODgxMDBiXCIsXCJldmVudElkXCI6e1widmFsdWVcIjpcIjc1ZDY0YjkyLTQwNzgtNDU3YS05MjU5LWZlZjI5NDg0NTlmN1wifSxcIm9jTGlua1wiOm51bGx9IiwiaWF0IjoxNjg5MTU5NTQyfQ.t2whuT7asvgBxaurkIsVm52Bumpj3L8WQxIMdjVfKLo" }, "eventPageUrl": { "base": "https://ievak9.wixsite.com/accessories", "path": "/event-details-registration/cosmic-odyssey-exploring-the-mysteries-of-the-universe" }, "form": { "controls": [ { "type": "NAME", "system": true, "name": "name", "inputs": [ { "name": "firstName", "array": false, "label": "First name", "additionalLabels": {}, "options": [], "mandatory": true, "maxLength": 50, "type": "TEXT", "maxSize": null, "defaultOptionSelection": null, "labels": [] }, { "name": "lastName", "array": false, "label": "Last name", "additionalLabels": {}, "options": [], "mandatory": true, "maxLength": 50, "type": "TEXT", "maxSize": null, "defaultOptionSelection": null, "labels": [] } ], "label": "First name, Last name", "orderIndex": 0, "id": "name" }, { "type": "INPUT", "system": true, "name": "email", "inputs": [ { "name": "email", "array": false, "label": "Email", "additionalLabels": {}, "options": [], "mandatory": true, "maxLength": 255, "type": "TEXT", "maxSize": null, "defaultOptionSelection": null, "labels": [] } ], "label": "Email", "orderIndex": 1, "id": "email" } ], "messages": { "rsvp": { "rsvpYesOption": "I'm Going", "rsvpNoOption": "Not Going", "positiveMessages": { "title": "Add your details", "confirmation": { "title": "Thank you!", "message": "An email with all the event info was sent to you.", "addToCalendarActionLabel": "Add to Calendar", "shareActionLabel": "Share" } }, "waitlistMessages": { "title": "Looks like this event is full. Join the waitlist.", "confirmation": { "title": "Thanks! You've been added to the waitlist.", "message": "We'll update you if additional spots become available.", "addToCalendarActionLabel": "Add to Calendar", "shareActionLabel": "Share" } }, "negativeMessages": { "title": "Add your details", "confirmation": { "title": "Sorry You Can't Make It", "shareActionLabel": "Share" } }, "submitActionLabel": "SUBMIT" }, "checkout": { "title": "Add your details", "submitActionLabel": "Continue" }, "registrationClosed": { "message": "Registration is closed", "exploreEventsActionLabel": "See other events" }, "ticketsUnavailable": { "message": "Tickets are not on sale", "exploreEventsActionLabel": "See other events" } } }, "summaries": null, "instanceId": "1f6dc906-803d-4650-83f5-72ea1d88100b", "guestListSettings": { "displayedPublicly": true }, "userId": "8a8b9b73-4da8-47a5-8268-4396e68a0605", "feed": null, "onlineConferencing": { "enabled": false, "providerId": null, "providerName": "", "type": -1, "session": null }, "seoSettings": null, "contactLabel": "custom.cosmic-odyssey-exploring-the-mysteries-of-the-univ", "agendaSettings": null, "categories": [ { "id": "4a69c13e-eb55-47a8-8ccf-9b55198428a0", "name": "science", "createdDate": "2023-07-12T10:51:00.029Z", "hidden": false, "type": "MANUAL" } ] } }
Did this help?