> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # Resource: Events V3 # Type: Event Object # Link: https://dev.wix.com/docs/api-reference/business-solutions/events/event-management/events-v3/event-object.md ## Description: 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. ## Schema: ```json Type: Event Object | type: Event Description: 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. - name: id | type: string | description: Event ID. - name: location | type: Location | description: Event location. - name: name | type: string | description: Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. - name: value | type: string | description: - name: type | type: string | description: Location type. enum: VENUE, ONLINE - name: address | type: Address | description: Exact location address. - name: country | type: string | description: 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. - name: subdivision | type: string | description: Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). - name: city | type: string | description: City name. - name: postalCode | type: string | description: Zip or postal code. - name: addressLine2 | type: string | description: Secondary address information (suite or apartment number and room number). - name: locationTbd | type: boolean | description: Whether the event location is TBD. - name: value | type: boolean | description: - name: dateAndTimeSettings | type: DateAndTimeSettings | description: Event date and time settings. - name: dateAndTimeTbd | type: boolean | description: Whether the event date and time are TBD. - name: dateAndTimeTbdMessage | type: string | description: Message that is displayed when time and date is TBD. **Note:** This field is only used when the `dateAndTimeTbd` field value is `true`. - name: startDate | type: string | description: Event start date. **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`. - name: seconds | type: string | description: - name: nanos | type: number | description: - name: endDate | type: string | description: Event end date. **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`. - name: timeZoneId | type: string | description: Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`. - name: hideEndDate | type: boolean | description: Whether the end date is hidden in the formatted date and time. - name: showTimeZone | type: boolean | description: Whether the time zone is displayed in the formatted schedule. - name: recurrenceStatus | type: string | description: Repeating event status. enum: ONE_TIME, RECURRING, RECURRING_UPCOMING, RECURRING_RECENTLY_ENDED, RECURRING_RECENTLY_CANCELED - name: recurringEvents | type: Recurrences | description: Event repetitions. - name: individualEventDates | type: Array | description: Individual event dates for recurring events. *Note:** Each date must be manually calculated and provided. There is no support for automatic generation using recurrence rules or patterns (for example, "Weekly"). When you create a recurring event: - Each occurrence is created as an independent event with its own unique ID. - All occurrences in the series share the same `categoryId`, which allows you to identify all events in the recurring series. - To retrieve all events in a recurring series, query events by `recurringEvents.categoryId`. - Each event in the series can be independently updated or deleted using its individual event ID. - name: categoryId | type: string | description: Recurring event category ID. This read-only field is automatically generated and shared by all events in a recurring series. Use this ID to query and retrieve all occurrences of a recurring event. - name: formatted | type: Formatted | description: Formatted date and time settings. - name: dateAndTime | type: string | description: Formatted date and time representation.
Example of formatting when an event lasts multiple days and is in the UTC time zone: `September 1, 2015 at 10:20 AM – September 5, 2015 at 12:14 PM`.
Example of formatting when an event lasts 1 day and is in the GMT+2 time zone: `February 1, 2018, 12:10 – 2:50 PM GMT+2`. - name: startDate | type: string | description: Formatted start date of the event. Empty for TBD schedules. - name: startTime | type: string | description: Formatted start time of the event. Empty for TBD schedules. - name: endDate | type: string | description: Formatted end date of the event. Empty for TBD schedules or when the end date is hidden. - name: endTime | type: string | description: Formatted end time of the event. Empty for TBD schedules or when the end date is hidden. - name: title | type: string | description: Event title. - name: shortDescription | type: string | description: Short description that appears under the event title. **Note:** This field is returned only when the `DETAILS` fieldset is included in the request. - name: detailedDescription | type: string | description: Detailed description of an event. This field is deprecated. - name: mainImage | type: Image | description: Main event image.
**Note:** This field is returned only when the `DETAILS` fieldset is included in the request. - name: id | type: string | description: WixMedia image ID. - name: url | type: string | description: Image URL. - name: height | type: number | description: Original image height. **Note:** You have to define height for the image to appear. - name: width | type: number | description: Original image width. **Note:** You have to define width for the image to appear. - name: altText | type: string | description: Image alt text. - name: slug | type: string | description: 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". - name: createdDate | type: string | description: Date and time when the event was created. - name: updatedDate | type: string | description: Date and time when the event was updated. - name: status | type: string | description: Event status. enum: UPCOMING, STARTED, ENDED, CANCELED, DRAFT - name: registration | type: Registration | description: RSVP or ticketing registration details.
**Note:** This field is returned only when the `REGISTRATION` fieldset is included in the request. - name: type | type: string | description: Reflects the current state of the registration. enum: RSVP, TICKETING, EXTERNAL, NONE - name: status | type: string | description: Registration status. enum: UNKNOWN_REGISTRATION_STATUS, CLOSED_AUTOMATICALLY, CLOSED_MANUALLY, OPEN_RSVP, OPEN_RSVP_WAITLIST_ONLY, OPEN_TICKETS, OPEN_EXTERNAL, SCHEDULED_RSVP - name: rsvp | type: RsvpRegistration | description: RSVP registration details. - name: responseType | type: string | description: Available answers for registration to an event. - name: limit | type: number | description: How many guests can RSVP to an event. - name: waitlistEnabled | type: boolean | description: Whether a waitlist is opened when the total guest limit is reached. If `true`, guests can RSVP to an event and are automatically added to the waitlist with the `IN_WAITLIST` status. - name: startDate | type: string | description: Registration start date. - name: endDate | type: string | description: Registration end date. - name: tickets | type: TicketsRegistration | description: Ticket registration details. - name: guestsAssignedSeparately | type: boolean | description: Whether the registration form must be filled out separately for each ticket. - name: ticketLimitPerOrder | type: number | description: Ticket limit per order.
Default: 20 tickets. - name: currency | type: string | description: Ticket price currency. - name: lowestPrice | type: Money | description: Lowest ticket price. - name: highestPrice | type: Money | description: Highest ticket price. - name: soldOut | type: boolean | description: Whether all tickets are sold for the event. - name: taxSettings | type: TaxSettings | description: How tax is applied. - name: reservationDurationInMinutes | type: number | description: Reservation duration in minutes. - name: external | type: ExternalRegistration | description: External registration details. - name: url | type: string | description: External event registration URL. - name: allowedGuestTypes | type: string | description: Types of guests allowed to register. enum: VISITOR_OR_MEMBER, MEMBER - name: initialType | type: string | description: Initial registration type which is set when creating an event. Once set, this value is immutable. To change the type of registration, use the `registration.type` field: - Events with `initialType` of `RSVP` or `TICKETING` can be changed to `EXTERNAL` or `NONE`. - `RSVP` events can't become `TICKETING` events, and vice versa. enum: RSVP, TICKETING - name: registrationPaused | type: boolean | description: Whether the registration is paused. - name: registrationDisabled | type: boolean | description: Whether the registration is disabled. - name: calendarUrls | type: CalendarUrls | description: URLs that allow you to add an event to the Google calendar, or to download an [ICS calendar](https://icscalendar.com/) file.
**Note:** This field is returned only when the `DETAILS` fieldset is included in the request. - name: google | type: string | description: "Add to Google Calendar" URL. - name: ics | type: string | description: "Download ICS calendar file" URL. - name: eventPageUrl | type: PageUrl | description: Event page URL components.
**Note:** This field is returned only when the `URLS` fieldset is included in the request. - name: base | type: string | description: The base URL. For premium sites, the base is the domain. For free sites, the base is the Wix site URL (for example, `https://mysite.wixsite.com/mysite`). - name: path | type: string | description: The path to the page. For example, `/product-page/a-product`. - name: form | type: Form | description: Event registration form.
**Note:** This field is returned only when the `FORM` fieldset is included in the request. - name: controls | type: Array | description: Nested fields as an ordered list. - name: type | type: string | description: Field control type. - name: system | type: boolean | description: Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. - name: name | type: string | description: Deprecated: Use `id` or `_id`. - name: inputs | type: Array | description: Child inputs. - name: label | type: string | description: *Deprecated:** Use `controls.inputs.label`. - name: orderIndex | type: number | description: Field controls are sorted by this value in ascending order. - name: id | type: string | description: Unique control ID. - name: deleted | type: boolean | description: Whether the input control is deleted. - name: messages | type: FormMessages | description: Set of defined form messages displayed in the UI before, during, and after a registration flow. Includes the configuration of form titles, response labels, "thank you" messages, and call-to-action texts. - name: rsvp | type: RsvpFormMessages | description: [RSVP form](https://dev.wix.com/docs/rest/business-solutions/events/rsvp-v2/introduction.md) messages. - name: checkout | type: CheckoutFormMessages | description: Checkout form messages. - name: registrationClosed | type: RegistrationClosedMessages | description: Messages shown when event registration is closed. - name: ticketsUnavailable | type: TicketsUnavailableMessages | description: Messages shown when event tickets are unavailable. - name: summaries | type: Summaries | description: 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. - name: rsvps | type: Rsvps | description: RSVP summary of guests. - name: totalCount | type: number | description: Total number of RSVPs. - name: yesCount | type: number | description: Number of RSVPs with status `YES`. - name: noCount | type: number | description: Number of RSVPs with status `NO`. - name: waitlistCount | type: number | description: Number of RSVPs in a waitlist. - name: tickets | type: Tickets | description: Summary of revenue and sold tickets. Archived orders aren't included. - name: ticketsSold | type: number | description: Number of sold tickets. - name: revenue | type: Money | description: Total revenue. Taxes and payment provider fees aren't deducted. - name: currencyLocked | type: boolean | description: Whether the currency is locked and can't be changed. - name: totalOrders | type: number | description: Number of orders placed. - name: totalSales | type: Money | description: Total balance of confirmed transactions. - name: instanceId | type: string | description: Instance ID of the site where the event is hosted. - name: guestListSettings | type: GuestListSettings | description: Guest list configuration. - name: displayedPublicly | type: boolean | description: Whether the guest list is displayed publicly to all guests. - name: userId | type: string | description: ID of the user who created the event. - name: onlineConferencing | type: OnlineConferencing | description: 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. - name: enabled | type: boolean | description: Whether online conferencing is enabled. Not applicable for events where date and time are TBD. When enabled, links to join the conference are generated and provided to guests. - name: providerId | type: string | description: Conference host ID. - name: type | type: string | description: Conference type. enum: MEETING, WEBINAR - name: session | type: OnlineConferencingSession | description: Online conferencing session information. - name: hostLink | type: string | description: Link for the event host to start the online conference session. - name: guestLink | type: string | description: Link for guests to join the online conference session. - name: password | type: string | description: Password required to join the online conferencing session (when relevant). - name: sessionCreated | type: boolean | description: Whether the session was created successfully on the event host side. - name: sessionId | type: string | description: Unique session ID. - name: seoSettings | type: SeoSettings | description: SEO settings.
**Note:** This field is returned only when the `SEO_SETTINGS` fieldset is included in the request. - name: slug | type: string | description: URL slug. - name: advancedSeoData | type: SeoSchema | description: Advanced SEO data. - name: tags | type: Array | description: SEO tag information. - name: settings | type: Settings | description: SEO general settings. - name: hidden | type: boolean | description: Whether the slug is hidden from the SEO sitemap. - name: contactLabel | type: string | description: Assigned contacts label key. - name: agendaSettings | type: AgendaSettings | description: Event schedule details.
**Note:** This field is returned only when the `AGENDA` fieldset is included in the request. - name: enabled | type: boolean | description: Whether the schedule is enabled for the event. - name: pageUrl | type: PageUrl | description: Schedule page URL. - name: eventDisplaySettings | type: EventDisplaySettings | description: Visual settings for event. - name: hideEventDetailsButton | type: boolean | description: Whether event details button is hidden. Only available for events with no registration. - name: hideEventDetailsPage | type: boolean | description: Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. - name: description | type: RichContent | description: Event description. Fallback Message for SSR and Error - name: nodes | type: Array | description: Node objects representing a rich content document. - name: type | type: string | description: Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. - name: id | type: string | description: Node ID. - name: nodes | type: Array | description: A list of child nodes. - name: style | type: NodeStyle | description: Padding and background color styling for the node. - name: metadata | type: Metadata | description: Object metadata. - name: version | type: number | description: Schema version. - name: createdTimestamp | type: string | description: When the object was created. - name: updatedTimestamp | type: string | description: When the object was most recently updated. - name: id | type: string | description: Object ID. - name: documentStyle | type: DocumentStyle | description: Global styling for header, paragraph, block quote, and code block nodes in the object. - name: headerOne | type: TextNodeStyle | description: Styling for H1 nodes. - name: headerTwo | type: TextNodeStyle | description: Styling for H2 nodes. - name: headerThree | type: TextNodeStyle | description: Styling for H3 nodes. - name: headerFour | type: TextNodeStyle | description: Styling for H4 nodes. - name: headerFive | type: TextNodeStyle | description: Styling for H5 nodes. - name: headerSix | type: TextNodeStyle | description: Styling for H6 nodes. - name: paragraph | type: TextNodeStyle | description: Styling for paragraph nodes. - name: blockquote | type: TextNodeStyle | description: Styling for block quote nodes. - name: codeBlock | type: TextNodeStyle | description: Styling for code block nodes. - name: publishedDate | type: string | description: Event publish timestamp. ```