The External Calendars API allows you to connect and sync external calendars
with a Wix site. By default, you can connect and sync Google, Microsoft, and
Apple calendars with any Wix site. Additionally, site owners can install apps
to support even more external calendar providers.
With the External Calendars API, you can:
- List supported external calendar providers for a Wix site.
- Connect an external calendar account to a Wix site.
- Import events from a connected external calendar to the Wix site.
- Export events from a Wix schedule
to connected external calendars.
- Retrieve information about a site's connections to external calendar accounts.
It’s important to note the following points before starting to code:
- Authentication Requirements: External calendar providers have varying
requirements for authentication. You can call List Providers
to determine if you can call Connect By OAuth
or Connect By Credentials
for a specific provider.
- Connection Configuration: You can configure whether a connection allows
importing to Wix, exporting to external calendars, or both. Check
syncConfig for each new connection, and call Update Sync Config
as necessary.
- Ownership Changes: If the Wix schedule's ownership changes, the connection
to the external calendar is automatically disconnected.
- Event Notifications: The External Calendars API doesn't include events
and doesn't provide real-time notifications about changes to connections or
providers.
- External calendar provider: A service or platform that offers calendar
functionalities. For example, Google Calendar, Microsoft Outlook, Microsoft
365, or Apple Calendar. These providers can be connected to and synced with
all Wix sites. Site owners can install apps that enable support for additional
external calendar providers.
- Account owner: The individual or entity that manages an external calendar
account. This person is responsible for authorizing connections from
the Wix site to their calendar account.
- Connection: An established link between a Wix site and 1 or more external
calendar accounts, allowing for data synchronization.
For a comprehensive glossary of Wix Bookings terms, see Terminology.