Calendar invites in providers such as Gmail and Outlook are simply email messages.
If all you need to do is grab calendar information that can be extracted from the calendar invite email message, our API can do that.
There are several ways you could pull calendar data:
- In the 2.0 version of our API, perform a GET messages call and use the param "file_name" to filter by files. You could then pass in "*.ics,*.ical" (or whichever calendar extension you're looking for). The "file_name" filter takes regular expressions and wildcards, so you can fine tune your search.
- Using webhooks in both 2.0 and Lite, you can filter by "filter_file_name". This filter behaves the same as "file_name" described above and supports regular expressions and wildcards, so you can use this to filter by calendar invites, and receive a webhook callback whenever a calendar invite is received by the user.
There are limits to these options:
- This method of interacting with calendar invites would not work for invites sent by the user, only invites received.
- You would need to parse the content of the invites on your end, as we treat invites as a regular message and do not do any special parsing for them.
If you require any other type of parsing or functionality, we recommend you use a calendar specific API, like Chronofy.