CalDAV icon

CalDAV

Interact with CalDAV servers for calendar operations

Overview

This node enables interaction with CalDAV servers to perform calendar-related operations. Specifically, the "Get Calendars" operation retrieves a list of calendars available on the CalDAV server under a specified calendar home set path.

Common scenarios where this node is useful include:

  • Synchronizing calendars from a CalDAV server into an automation workflow.
  • Listing all user calendars to allow further event management or reporting.
  • Integrating CalDAV-based calendar data with other systems or services.

For example, you can use this node to fetch all calendars for a user from a CalDAV server and then process or display them in another system.

Properties

Name Meaning
Calendar Home Set Path to the calendar home set on the CalDAV server. Must start with "/". Spaces and special characters are automatically URL-encoded. Default is /calendars/user/.

Output

The node outputs JSON data containing:

  • calendars: An array of calendar objects, each with:

    • href: The decoded server-relative path to the calendar.
    • displayName: The display name of the calendar (if available).
    • description: The calendar description (if available).
  • statusCode: The HTTP status code returned by the CalDAV server for the request.

Example output structure:

{
  "calendars": [
    {
      "href": "/calendars/user/calendar1/",
      "displayName": "Work",
      "description": "Work related events"
    },
    {
      "href": "/calendars/user/calendar2/",
      "displayName": "Personal",
      "description": "Personal appointments"
    }
  ],
  "statusCode": 207
}

No binary data output is produced by this operation.

Dependencies

  • Requires connection to a CalDAV server with valid credentials including a base URL and authentication token/API key.
  • The base URL must include the protocol (http:// or https://) and be correctly configured in the node credentials.
  • The node uses HTTP methods such as PROPFIND to communicate with the CalDAV server.
  • Proper network access to the CalDAV server is necessary.

Troubleshooting

Common Issues

  • Invalid Base URL: If the base URL in credentials is missing or does not start with http:// or https://, the node will throw an error. Ensure the URL includes the protocol and is correct.
  • Connection Errors: Errors like host not found, connection refused, or timeout indicate network issues or incorrect server address.
  • Absolute URLs in Paths: The node expects server-relative paths starting with /. Providing absolute URLs in path parameters will cause errors.

Error Messages and Resolutions

  • "Invalid Base URL in credentials. Include protocol (http:// or https://), e.g. https://your-server/remote.php/dav"
    Fix by adding the correct protocol prefix to the base URL in credentials.

  • "Host not found for CalDAV getCalendars on calendar: ..."
    Check the server hostname and network connectivity.

  • "Connection refused for CalDAV getCalendars on calendar: ..."
    Verify the server is running and accessible on the specified port.

  • "Connection timed out for CalDAV getCalendars on calendar: ..."
    Network latency or firewall issues might be blocking access.

  • "Absolute URLs are not allowed in path fields. Use a server-relative path starting with '/'."
    Change any absolute URL inputs to relative paths starting with /.

Links and References

Discussion