Subscribe to calendar link

Sunday, 7 January 2024

Outlook, Google Calendar, Apple Calendar have functionality that allow you to subscribe to calendar feeds; add the URL of the feed, and then it will appear (and update) automatically in your calendar. There is a standardised format called ical [1], and it contains as you would expect – events on a calendar. This is useful to subscribing to public holiday calendar feeds, key dates within shared within your company, etc.

I’m currently using an iCal feed to power The Globe Church public calendar. Behind the scenes the events are stored in Microsoft365 which exposes an iCal feed, this is then imported to the website (via Eleventy, obviously… have a look at the code if you want), and then from there the feed is parsed, reformatted, and turned into a beautiful page.

This is all fine and wonderfully technical, but what happens when you want to allow a non-technical user to subscribe this calendar in their calendar software of choice (eg on their iPhone Apple Calendar, or the Android Google Calendar, or in their work’s Outlook calendar) so they don’t have to keep on coming back to the website… That sent me down a rabbit hole.

Webcal URIs

WebCal allows you to create and maintain an interactive events calendar or scheduling system on a Web site or app… The Webcal protocol prefix is used to trigger an external protocol handler which is passed the URL of the .ics file rather than being passed the downloaded contents of the file, in much the same way feed is sometimes used to trigger external RSS readers
Webcal on Wikipedia

So, this means that prefixing a link to an ics file with webcal:// should work for alot of things… (Apple Calendar, Outlook, etc)[2].

If your file is hosted at https://example.com/calendarFeed.ics, this becomes webcal://example.com/calendarFeed.ics. Whack that in an anchor tag (<a href="webcal://…") and test it.

So that’s Outlook, Apple Calendar, etc sorted… what about calendars that are in the browser such as Google Calendar?

Google Calendar has an URL that you can use to add one-off events… and Simon pointed out that you can do something similar with a webcal link:

https://calendar.google.com/calendar/r?cid=webcal://example.com/calendar.ics

Finally, a bit of digging later there is a similar link for Microsoft365:

https://outlook.office.com/calendar/0/addfromweb?url=webcal://example.com/calendar.ics

Put that all together and you have a set a links that you can create to enable people to click and automatically subscribe to a calendar feed.

Something to copy and paste

This is what you’re here for…

<ul>
  <li>
    <a href="webcal://example.com/calendar.ics">Apple Calendar or Outlook</a>
  </li>
  <li>
    <a href="https://calendar.google.com/calendar/r?cid=webcal://example.com/calendar.ics">Google Calendar</a>
  </li>
  <li>
    <a href="https://outlook.office.com/calendar/0/addfromweb?url=webcal://example.com/calendar.ics">Microsoft365</a>
  </li>
  <li>
    <a href="https://example.com/calendar.ics">iCal Feed</a>
  </li>
</ul>

The final implementation can be seen on the calendar page, and the code is in GitHub.


Thanks to Simon Willison’s blog post Providing a “subscribe in Google Calendar” link for an ics feed which got me a long way towards an answer for this.

Footnotes

  1. Short for iCalendar… which is short for internet calendar. ↩︎

  2. Simon says that “I believe this only works if you are serving your ICS feed over HTTPS”. Worth keeping in mind, but you’re hosting over HTTPS already… right? ↩︎

Post changelog

Back to all posts