Calendaring Extensions to WebDAV (CalDAV) Overview

CalDAV (or Calendaring Extensions to WebDAV) is an Internet standard that allows sharing of calendar information from a remote server. CalDAV extends WebDAV, which is an HTTP-based protocol for data manipulation. CalDAV uses the iCalendar .ics format to share data and provides a unified way of communication between a client and a server for managing calendars or creating and scheduling events and tasks.

CalDAV feature for Team Calendars

Starting from Confluence Team Calendar versions 5.5 - 6.0 and higher, users can apply CalDAV protocol to sync their favorite calendar applications with Confluence Team Calendars. After a team calendar is integrated with a supported application, users can add and modify events in one place and see the changes reflected in the other (if the application supports two-way sync).

The following applications support CalDav integration with Team Calendars:

• Microsoft Outlook (Windows only)

• Apple Calendar (MacOS and iOS)

• Google Calendar (Browser and Android)

• Thunderbird on MacOS

• Other calendar applications supporting the CalDAV protocol can also be integrated with Team Calendars

Some applications don’t support a two-way integration. For these integrations, users can still view Team Calendar events in the integrated calendar application, but can’t modify them.

Team Calendar as client or server

Supporting this protocol allows Confluence Team Calendars to act as a server as well as a client.

Team Calendars as server

This setup provides external client applications like Apple Calendar, Google Calendar, Microsoft Outlook, and any custom application supporting CalDAV to act as a client and to read, create, and update events stored in Team Calendars. Depending on the application, the following integrations can be supported:

• One-way sync — client application can read events from Team Calendars but can’t edit them.

• Two-way sync — client can read, create, and update events in Team Calendars.

Team Calendars as client

In this setup, Team Calendars subscribes to a calendar from an external application that supports CalDAV. As a result, Team Calendars can read, create, and update events stored in that external system. Depending on the external application, the following integrations can be supported:

• One-way sync — Team Calendars can read events from the external application but can’t edit them.

• Two-way sync — Team Calendars can read, create, and update events in the external application

We may support a one-way or two-way sync depending on the limits of external applications.

Integrate external application with Team Calendars

1. Go to Confluence, then Calendars, and then Subscribe.

2. In the Subscribe to calendar dialog:

   1. From Calendar, select the calendar you want to integrate with.

   2. From Calendar app, select CalDAV.

   3. After you select CalDAV, a Team Calendars URL is generated. You can use this link in your calendar application to subscribe to the Team Calendars calendar.

  4. In the external application, find the option to subscribe to an external calendar. Use the Teams Calendar URL you generated to sync the application with your calendar.

    5. After you complete the sync, depending on the type of integration, users will be able to view or view and edit events from both calendars.

CalDAV API usage and examples

CalDAV APIs implement the RFC Spec that uses HTTP methods for communication between client and server. You can find some samples for these calls : Use CalDAV API to sync calendars