The Google Calendar integration allows you to connect your Google Calendar to Home Assistant. The integration adds calendar entities that are shown on the Calendar dashboard, and can be used for automations based on any event, or limited to specific matching criteria.
You need to configure developer credentials to allow Home Assistant to access your Google Account. The current recommended approach is to create Web Auth credentials for Google Calendar since the same credentials work for all Google integrations. Previously, this integration only supported Device Auth and those credentials are no longer recommended. You can continue to use Device Auth credentials but they will only work with Google Calendar.
In this case, all you need to do is enable the API:
- Go the Google Developers Console Google Calendar API .
- Confirm the project and Enable the API.
- Continue with the steps described in the Configuration section.
In this case, you need to generate a client secret first:
This section explains how to generate a client ID and client secret on Google Developers Console.
- First, go to the Google Developers Console to enable Google Calendar API .
- Select Create project, enter a project name and select Create.
- Enable the Google Calendar API.
- Navigate to APIs & Services (left sidebar) > Credentials.
- In the left sidebar, select OAuth consent screen.
- Select External and Create.
- Set the App name (the name of the application asking for consent) to anything you want, e.g., Home Assistant.
- You then need to select a Support email.
- From the dropdown menu, select your email address.
- Under Developer contact information, enter your email address (the same as above is fine).
- Scroll to the bottom and select Save and continue.
- You don’t have to fill out anything else here. Adding other information to this page (like an app logo) may trigger an additional review process from Google and delay setup by days.
- You will then be automatically taken to the Scopes page.
- You do not need to add any scopes here. Select Save and continue to move to the Test users page.
- You do not need to add anything to the Test users page. Select Save and continue, which will take you to the Summary page.
- Select Back to dashboard.
- Select OAuth consent screen again and under Publishing status, select Publish app.
- Otherwise your credentials will expire every 7 days.
- Make sure Publishing status is set to In production.
- In the left sidebar, select Credentials, then select Create credentials (at the top of the screen), then select OAuth client ID.
- Set the Application type to Web application and give this credential set a name (like “Home Assistant Credentials”).
https://my.home-assistant.io/redirect/oauthto Authorized redirect URIs then select Create.
- This is not a placeholder. It is the URI that must be used.
- You will then be presented with a pop-up saying OAuth client created, showing Your client ID and Your client secret.
- Make a note of these (for example, copy and paste them into a text editor), as you will need them shortly.
- Once you have noted these strings, select OK.
- If you need to find these credentials again at any point, then navigate to APIs & Services > Credentials, and you will see Home Assistant Credentials (or whatever you named them in the previous step) under OAuth 2.0 Client IDs.
- To view both the Client ID and Client secret, select the pencil icon. This will take you to the settings page for these credentials, and the information will be on the right-hand side of the page.
- Congratulations! You are now the keeper of a client secret. Guard it in your treasure box. In most cases your new credentials will be active within a few moments. However, Google states that activation may take up to five hours in some circumstances.
To add the Google Calendar integration to your Home Assistant instance, use this My button:
If the above My button doesn’t work, you can also perform the following steps manually:
The integration setup will next give you instructions to enter the Application Credentials (OAuth Client ID and Client Secret) and authorize Home Assistant to connect to Google Calendar.
Continue through the steps of selecting the account you want to authorize.
NOTE: You may get a message telling you that the app has not been verified and you will need to acknowledge that in order to proceed.
You can now see the details of what you are authorizing Home Assistant to access with two options at the bottom. Select Continue.
The page will now display Link account to Home Assistant?, note Your instance URL. If this is not correct, refer to My Home Assistant. If everything looks good, select Link Account.
You may close the window, and return back to Home Assistant where you should see a Success! message from Home Assistant.
If the setup process fails and you see an error message such as Authentication code expired, please try again you may want to try the flow again. You may also check the logs for additional error messages that may indicate a misconfiguration such as an invalid client id or secret.
If you have an error with your credentials, you can delete them in the application credentials user interface.
This video tutorial explains how to set up Google Calendar in Home Assistant and how you can trigger an automation based on a calendar event.
For example, your calendar named Personal is created as entity
calendar.personal. You may rename an entity, or disable any entities which you don’t need.
Individual Calendar Events are what is powering automations such as:
- Turn on a light at the start of the event named Front Yard Light
- Send a notification 5 minutes before the start of any event
- Stop the media player 30 minutes after the end of the event named Exercise.
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
location and more.
The calendar entity has additional attributes related to a single next upcoming event.
Using the entity state and attributes is more error prone and less flexible than using Calendar Automations. The calendar entity itself may only track a single upcoming active event and can’t handle multiple events with the same start time, or overlapping events.
falseif this is an all day event. Will be
falseif there is no event found.
- message: The event summary.
- description: The event description.
- location: The event location.
- start_time: Start time of event.
- end_time: End time of event.
You can use the service
google.create_event to create a new calendar event in a calendar.
This will only be available if you have given Home Assistant
read-write access in configuration options.
target is selected with a Target Selector and the
data payload supports the following fields:
|Service data attribute
|Acts as the title of the event.
|The description of the event.
|The date and time the event should start.
|The date and time the event should end.
|The date the whole day event should start.
|The date the whole day event should end.
|Days or weeks that you want to create the event in.
|The location of the event.
You either use
This is a full example of service call in YAML:
The integration supports additional configuration from a file
google_calendars.yaml which is available for existing users before version
2022.06. This file is no longer automatically populated.
The Google generated unique id for this calendar.
DO NOT CHANGE THE DEFAULT VALUE
Yes, you can have multiple sensors for a calendar!
The name that all your automations/scripts will use to reference this device.
A set of characters that precede a number in the event title for designating a pre-trigger state change on the sensor. This should be in the format of HH:MM or MM.