The Calendar APIs allow you to view and manage business
schedules and events. You can use it to build a custom scheduling solution
that supports recurring events, varying time zones, linked resources,
participation management, and customized permissions. You can also extend and
customize Wix Business Solutions that use a calendar, such as Wix Bookings.
Before diving into the Calendar APIs, it's helpful to familiarize yourself with
a few essential terms. The API is structured around schedules, which group
together related events like classes or meetings. Each schedule defines a time frame
based on the start and end dates of its events. You can use event views
to track updates and changes in the schedule over time. Additionally, the
participation object captures details about individuals attending an event,
including their confirmation status and any custom data you need to store.
With the Calendar APIs, you can:
It’s important to note the following points before you start coding:
- The schedule object itself doesn’t store event details. Each event is independently managed.
- An event must belong to exactly one schedule.
- Once a schedule is marked as
CANCELLED, you can't reactivate, update, or associate it with new events.
- Recurring events aren't defined by the schedule itself. Instead, create a
MASTER event to establish the recurrence pattern.
- Event: A calendar entry with details like timing, location, and participants. Each event is associated with exactly 1 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.
- Schedule: Collection of events associated with a specific entity, such as a Bookings service, or Bookings resource. Schedules set default values for the events they manage, like a location.
- Schedule time frame: Information about the start and end dates of the first and last events that belong to a schedule and whether any events follow an unlimited repetition pattern.
- Event view: Subscribing to the event view lets you keep track of a calendar's single-occurrence,
EXCEPTION, and INSTANCE events at least one year into the future.
- Participation: Representation of the relationship between a participant and an event or schedule. It includes details about the participant, whether the participation status is confirmed or pending, which app owns the relevant event or schedule, and allows for custom data extensions.