Skip to main content

Calendar Feeds Add-on

Teachworks Support avatar
Written by Teachworks Support
Updated today

iCalendar is a standard format used to share calendar data between programs. It's used and supported by a wide range of calendar programs including Google Calendar, Apple Calendar, Microsoft Outlook, Yahoo Calendar, Mozilla Thunderbird and more.

Teachworks allows you to enable Calendar feeds for you and your employees so that you or your employees can subscribe to events from your Teachworks calendar in other calendar programs. Teachworks feeds return events 2 weeks prior to the current date (in UTC) and 12 weeks into the future.

Enabling the Add-on

  1. Click on "Account & Settings and then click on "Integrations & Add-ons".

  2. Use the "Search" field on the right and enter "Calendar Feeds".

  3. Click on the "Enable" link.

Settings

After the add-on has been enabled, click on the "Manage" link to select which feeds you'd like to enable. You can select from the following options:

  • Enable Company Calendar Feed - Enable this option to display the calendar feed for your company. Once enabled, the calendar feed URL will be displayed below the checkbox for the company feed. This Calendar feed is for all of the events in your account.

  • Enable Employee Calendar Feeds - Enable this option to create separate Calendar feeds for each employee. Once enabled, you can retrieve the employee's Calendar feed from their profile.

Feed Filters

You can further control your calendar feeds by adjusting the "Filter" parameter at the end of the feed URL. The available filter parameters can be found below (the default is set to "All"):

  1. All – Displays lessons and other non-teaching events from the calendar.

  2. Lessons – Displays only lessons.

  3. Other – Displays only non-teaching events belonging to the company or employee.

  4. Other Shared - This setting is for employee feeds and will display any non-teaching events from your company that specify "Everyone" or "Employees" as the audience.

  5. Locations - This allows you to display lessons and other events for a single location. See below for instructions.

TIP: You may want to add separate feeds to your calendar program for lessons and other events to make it easier to distinguish between the two feeds.

Adding Calendar Feed to Calendar Programs

You can read the instructions for your calendar program to find out how to subscribe to an Calendar feed. Below are links to instructions for some of the more popular calendar programs:

NOTE: Google Calendar updates calendar subscriptions infrequently and does not support manually refreshing a calendar feed. For this reason, you should not rely on Google Calendar if you require up-to-date events in your calendar.

Filtering by Location

If you are the company administrator or a staff employee, you can filter your calendar feeds by "Location" following the steps below:

  1. Click on "Account & Settings" and then click on "Locations".

  2. Click on "Edit" next to the location you would like to filter by.

  3. Look at the URL displayed in your browser's address bar and note the number
    ​

  4. At the end of your existing calendar feed URL add a slash "/" and put the location number from the previous step after the slash. The URL will look something like this:
    ​

    https://subdomain.teachworks.com/icalendar/account/pQZf7Klpyg/all/1

This calendar feed will now only display lessons for the selected location.

Excluding Cancelled Lessons

By default, calendar feeds will include "Cancelled" lessons with a [Cancelled] tag in the "Summary" field.

If you want to completely exclude cancelled lessons from a feed add "?exclude_cancelled=true" to the end of the feed URL. The URL will look something like this:

https://subdomain.teachworks.com/icalendar/account/pQZf7Klpyg/all?exclude_cancelled=true
Did this answer your question?