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.
Event ID.
ID of the schedule the event belongs to. After creating an event, you can't assign it to a different schedule.
Schedule name.
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.Additional supported values, if Wix Bookings is installed:
APPOINTMENT: Bookings appointment event.CLASS: Bookings class event.COURSE: Bookings course event.Event status.
Supported values:
CONFIRMED: Event is scheduled to happen or has happened.CANCELLED: Event has been canceled.Default: CONFIRMED
Event title.
Min: 1 character Max: 200 characters
Information about when the event starts.
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).
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.
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.
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.
Information about whether the event is a single occurrence or part of a recurring series.
Supported values:
NONE: The event occurs only once and doesn't repeat.MASTER: Defines the recurrence pattern for a series of recurring events.INSTANCE: A specific occurrence of a recurring event. You can't create an event with {"recurrenceType": "INSTANCE"}, instead it's automatically generated based on the recurrence rule. If you update an INSTANCE event, recurrenceType automatically changes to EXCEPTION.EXCEPTION: A modified instance of a recurring event that differs from the recurrence pattern. For example, an event with a different time or location. You can't create an EXCEPTION event directly, instead it's set automatically when you update an INSTANCE event.Default: NONE
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:00 AM has the following recurrenceRule:
frequency = WEEKLYinterval = 2days = [MONDAY]until = 20260107T08:00:00ZID of the MASTER event the event belongs to. Available only for INSTANCE
and EXCEPTION events.
Specifies whether the event blocks time in the schedule it belongs to.
Supported values:
OPAQUE: The schedule is blocked during the event, preventing other events that involve the same entities (for example, Booking staff members) from being scheduled at the same time.TRANSPARENT: The schedule remains open during the event, allowing other events to be scheduled concurrently.Default: OPAQUE
Event location.
Default: defaultLocation of the schedule the event belongs to
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
Maximum number of participants who can participate in the event.
Default: defaultCapacity of the schedule the event belongs to
Number of participants who can still be added to the event.
Information about the event's participants. Returned only if explicitly requested. For more details, see the permissions article.
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
Additional notes about the event. Returned only if explicitly requested. For more details, see the permissions article.
Min: 1 character Max: 5000 characters
List of fields whose values are inherited.
INSTANCE and EXCEPTION events, values are inherited from the related MASTER event.ID of the app that owns the event. Identical to appId of the
schedule
to which the event belongs.
List of permissions associated with the event. Refer to the permissions article for more information.
Extensions enabling applications or users to save custom data related to the event.
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.
Date the event was created in YYYY-MM-DDThh:mm:ss.sssZ format.
Date the event was last updated in YYYY-MM-DDThh:mm:ss.sssZ format.