About the Google Calendar category

o.plokha · July 23, 2024, 6:50am

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: Google Calendar API Reference

Connector package documentation

1. Setting up HTTP Client Google Calendar

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select Google Calendar HTTP Client as PlatForm and click next step
Fill in the Base URI, Token URL, Authorize URL, Client ID, Client Secret and Scopes.
(See the Google Calendar Authentication Documentation for more information)
Click on “Grant access to Google Calendar” and you will be redirected to Google Authentication to get the key for the client.
You can optionally enable logging of request to get the log of the authentication.
Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.

2. Subscribing to Entities from Google Calendar

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select “Google Calendar Subscriber” as the subscriber.
Select the Method that you want the subscriber to fetch the data.
Select the entity you want to subscribe to from Google Calendar.
Add any request parameters needed to subscribe to the entity.
Select the Google Calendar HTTP Client to use.
You can optionally add a transformer to transform the request parameters into something you will request from Google Calendar.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

We follow Google Calendar documentation on building this connector, so you can easily use the connector based on Google Calendar API Reference.

Entity

The entity you want to subscribe to Google Calendar. Please refer to the entities from Google Calendar API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the Google Calendar API Reference.

Please look at the example below on how to fill path field when we want retrieve a Calendar by subscribing “Calendar - Get Calendar” entity.

From the end point, we can see that we need to set the calendar id as parameters. That is why we set the “calendarId” inside the path key in the Request Parameters.

Alumio will then make a request to Google Calendar with the URL /calendars/12345

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0
Payload is the data contained within a request.

HTTP Client

The HTTP Client configuration you will use to access Google Calendar.

3. Publishing Entity to Google Calendar

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “Google Calendar Publisher” as the publisher.
Select the Method that you want the publisher to perform with the data.
Select the Google Calendar entity you want the data to be published to.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Method

Currently, we support HTTP Post method and HTTP Delete method on submitting data to Google Calendar.

Entity

We support publishing to most Google Calendar endpoints.
Please refer to Google Calendar API Reference page.

For example, we want to create a calendar. Please select “Create data using POST” as the Method and “Calendar - Create Calendar”.

From the documentation, we can see that we need to set a body parameters. That is why we set the body parameters inside the payload key in the data.

Alumio will send an API request to Google Calendar with URL /calendars

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0
Payload is the data contained within a request.