Client Setup

Common

Following resources are available.

/.well-known/caldav
# CalDAV root
/caldav
# Principal home
/caldav/principal/<user_id>
# Calendar home
/caldav/principal/<user_id>/<calendar_id>
/caldav/principal/<user_id>/_birthdays_<addressbook_id>

# CalDAV root
/caldav-compat
/caldav-compat/principal...

/.well-known/carddav
# CardDAV root
/carddav
# Principal home
/carddav/principal/<user_id>
# Addressbook home
/carddav/principal/<user_id>/<addressbook_id>

Authentication

Authenticate with HTTP Basic authentication using your user id and a generated app token.

`/caldav` vs `/caldav-compat` (relevant for group sharing)

To discover shared calendars the calendar-home-set property is used to list all principals the user has access to. However, some clients don't support calendar-home-set containing multiple paths (e.g. Apple Calendar).

As a workaround /caldav-compat offers the same endpoints as /caldav with the only difference being that it does not return all calendar homes in calendar-home-set. This means that clients under this path will probably not auto-discover group calendars so you can instead add them one-by-one using the principal path /caldav-compat/principal/<principal_id>.

DAVx5

You can set up DAVx5 through the Nextcloud login flow. Collections including group collections will automatically be discovered.

Apple Calendar

You can download a configuration profile from the frontend in the app token section.

Limitation: Group collections are not automatically discovered, for these you need to set up separate CalDAV configurations using the corresponding principal homes (but your own user id).

Evolution

Set up a collection account in the account settings.

Limitation: Group collections are not discovered. It seems as if currently you have to add each group collection manually.

Home Assistant CalDAV integration

As URL specify

https://<your-host>/.well-known/caldav

For goup collections explicitly specify

https://<your-host>/caldav/principal/<principal>

2.0 KiB Raw Blame History