Event Object


An event is a scheduled entry on a calendar that includes details like timing, location, and participants. Each event is associated with a schedule, from which it may inherit default values. Events can either be standalone, part of a recurring series, or define a recurrence pattern. You can also specify whether events block time on the schedule or allow other events to be scheduled concurrently.

Properties
adjustedEndZonedDateRead-only

Information about when the event ends adjusted to the timeZone of the business site properties or a different timeZone you provide in the call's request.


adjustedStartZonedDateRead-only

Information about when the event starts adjusted to the timeZone of the business site properties or a different timeZone you provide in the call's request.


allDayboolean

Whether the event spans one or more full days.

When true, start and end represent full-day boundaries:

  • start.localDate: First day at 00:00:00.
  • end.localDate: Day after the last day at 00:00:00 (exclusive). Midnight boundaries are interpreted in the event's timeZone.

Default: false


appIdstringRead-onlyformat GUID

ID of the app that owns the event. Identical to appId of the schedule to which the event belongs. For events from Wix apps, the following values apply:

  • Wix Bookings: "13d21c63-b5ec-5912-8397-c3a5ddb27a97"
  • Wix Services: "cc552162-24a4-45e0-9695-230c4931ef40"
  • Wix Meetings: "6646a75c-2027-4f49-976c-58f3d713ed0f". Full list of apps created by Wix.

conferencingDetailsConferencingDetails

Information about the event's online conferencing. Returned only if explicitly requested. For more details, see the permissions article.

Default: defaultConferencingDetails of the schedule the event belongs to


_createdDateDateRead-only

Date the event was created in YYYY-MM-DDThh:mm:ss.sssZ format.


endZonedDate

Information about when the event ends.

Maximum allowed date: Year 2100, or up to 100 years from the event's start date (whichever comes first).


extendedFieldsExtendedFields

Extensions enabling applications or users to save custom data related to the event.


externalScheduleIdstringRead-onlyformat GUID

ID of the external schedule the event belongs to.

For example, if the event belongs to a Bookings staff member, identical to the ID of the resource. If the schedule belongs to a Bookings service, identical to the ID of the service.


_idstringRead-onlyminLength 36maxLength 250

Event ID.


inheritedFieldsArray <string>Read-only

locationLocation

Event location.

Default: defaultLocation of the schedule the event belongs to


notesstringminLength 1maxLength 5000

Additional notes about the event. Returned only if explicitly requested. For more details, see the permissions article.

Min: 1 character Max: 5000 characters


participantsParticipantsRead-only

Information about the event's participants. Returned only if explicitly requested. For more details, see the permissions article.


permissionsArray <Permission>Read-only

List of permissions associated with the event. Refer to the permissions article for more information.


recurrenceRuleRecurrenceRule

Recurrence pattern for a series of events. This field is required when creating a MASTER event and isn't available for non-recurring events. You can't update the recurrence rule for INSTANCE or EXCEPTION events.

For example, an event that repeats every second Monday until January 7, 2026, at 8

AM has the following recurrenceRule:

  • frequency = WEEKLY
  • interval = 2
  • days = [MONDAY]
  • until = 20260107T08:00:00Z

recurrenceTypestringRead-only

recurringEventIdstringRead-onlyminLength 64maxLength 64

ID of the MASTER event the event belongs to. Available only for INSTANCE and EXCEPTION events.


remainingCapacityintegerRead-onlyformat int32

Number of participants who can still be added to the event.


resourcesArray <Resource>maxItems 100

List of Wix Bookings resources affected by the event. This could include, for example, the Wix Bookings staff member providing the service or the room where the appointment takes place.

Max: 100 resources


revisionstringRead-onlyformat int64

Revision number, which increments each time the event is updated. To prevent conflicting changes, the current revision must be passed when updating the event. Ignored when creating an event.


scheduleIdstringformat GUIDimmutable

ID of the schedule the event belongs to. After creating an event, you can't assign it to a different schedule.


scheduleNamestringRead-only

Schedule name.


startZonedDate

Information about when the event starts.


statusstringRead-only

timeZonestring

Time zone the event is associated with in IANA tz database format. Only regional time zones and UTC are supported. For example, America/New_York or UTC.

Default: timeZone of the schedule.


titlestringminLength 1maxLength 200

Event title.

Min: 1 character Max: 200 characters


totalCapacityintegerminimum 0format int32

Maximum number of participants who can participate in the event.

Default: defaultCapacity of the schedule the event belongs to


transparencystring

typestringimmutable

Event type. You can set the event type but you can't update it.

Supported values:

  • DEFAULT: A standard event that's not further specified.
  • WORKING_HOURS: The event adds working hours to a schedule. By default not returned in Query Events. To retrieve working hour events, specify "type": "WORKING_HOURS" in the query filter. Additional supported values, if Wix Bookings is installed:
  • APPOINTMENT: Bookings appointment event.
  • CLASS: Bookings class event.
  • COURSE: Bookings course event.

_updatedDateDateRead-only

Date the event was last updated in YYYY-MM-DDThh:mm:ss.sssZ format.

Did this help?