Remote Calendar

The Remote calendar integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows you to read a calendar in Home Assistant for powering automations.

Known limitations

The integration supports HTTP Basic Authentication but does not provide the ability to connect to a resource that requires other special headers.

Installation instructions

Configuration

To add the Remote Calendar service to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select Remote Calendar.

  • Follow the instructions on screen to complete the setup.

Please provide the following information to the config flow.

Calendar Name

A name for your calendar, you can choose a name you want. Example: Home Assistant Events

Calendar URL

The URL of the remote calendar. Example: https://calendar.google.com/calendar/ical/p07n98go11onamd08d0kmq6jhs%40group.calendar.google.com/public/basic.ics

Verify SSL certificate

Enable SSL certificate verification when connecting via HTTPS.

If the calendar URL requires authentication, you will be prompted for a username and password in an additional setup step.

Username

The username for HTTP Basic Authentication.

Password

The password for HTTP Basic Authentication.

Data updates

At the start of the integration, we fetch data from the remote. If the update fails, the integration tries again to fetch the data. After that, the update interval of the calendar is set to every 24 hours.

Defining a custom polling interval

If you want to define a specific interval at which your device is being polled for data, you can disable the default polling interval and create your own polling automation.

To turn off the default polling and create your own polling automation, follow these steps:

  1. Go to Settings > Devices & services, and select your integration.
  2. On the integration entry, select the three dots menu, and then select System options.
  3. Turn off Enable polling for changes, and then select Update.
    • If Home Assistant asks you to restart, restart it.
  4. Go to Settings > Automations & scenes, and select Create automation > Create new automation.
  5. Add the triggers and conditions for when you want to poll for data.
  6. Select Add action, select By type, select Perform action, and then select + next to Perform action.
  7. Under Action, search for and select the Update entity action.
  8. Under Entities to update, select the entities you want to poll.
    • You can only select entities. Areas, devices, and labels aren’t supported.
  9. Select Save.

Many integrations update their data at most once every 10 seconds. If you poll more often, Home Assistant waits until the 10 seconds have passed before it updates the data again.

Supported functionality

The integration only supports reading a calendar. A calendar entity has a state and attributes that represent the next upcoming event (only). All the events of the calendar can be displayed in the Calendar dashboard.

Canceled events

A calendar can keep a canceled event instead of deleting it. Home Assistant leaves it out: it doesn’t appear in the calendar, doesn’t change the state of the calendar entity, and doesn’t trigger calendar automations.

Calendar Event Automations

Individual Calendar Events are what powers automations such as:

  • Notify me 12 hours before the start of the event named Garbage collection.

See Calendar Automations for an overview, and read more about Calendar Trigger Variables for the available information you can use in a condition or action such as the event summary, description, location and more.

Removing the integration

This integration follows standard integration removal. No extra steps are required.

To remove an integration instance from Home Assistant

  1. Go to Settings > Devices & services and select the integration card.
  2. Next to the entry you want to remove, select the three dots menu. Then, select Delete.
    • Depending on the integration, the entries are listed under one of the following headings:
      • Devices
      • Hubs
      • Services
      • Integration entries
  3. To confirm, select Delete.
    • Home Assistant also deletes the devices and entities of the entry.
  4. If Home Assistant asks you to restart, restart Home Assistant.
  5. If Home Assistant asks whether to also delete the application credentials, select Remove or Keep.