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.
If your company administrator has enabled Calendar Feeds for your company, employees can subscribe to events from their Teachworks calendars in other calendar programs.
NOTE: Teachworks calendar feeds include events 2 weeks prior to the current date and 3 months into the future.
Retrieving Your Calendar Feed
Employee calendar feeds are displayed on employee profiles under the Calendar Settings section. The feed URL can be added to other calendar programs, enabling them to retrieve the employee's events.
Feed Filters
You can further control the calendar feeds by adjusting the filter parameter on the end of the feed URL. The available filter parameters can be seen below:
All – displays lessons and other non-teaching events from the calendar (excludes "other_shared").
Lessons – displays only lessons.
Other – displays only non-teaching events belonging to the company or employee.
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.
NOTE: The default is set to "all".
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 of choice to find out how you can subscribe to a Calendar feed. Below are some 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.
Staff Employee - Filter by Location
If you are the admin or a staff employee, you can filter your feeds by location by following the steps belows:
Click on "Account & Settings" and then click on "Locations".
Click on the "Edit" option for the location that you would like to filter by.
Look at the URL that is displayed in your browser's address bar and note the Location ID, as shown in the image below:
At the end of your existing calendar feed URL, add a slash "/" and add the Location ID from the previous step after the slash. The URL will look something like this:
https://subdomain.teachworks.com/icalendar/account/pQZf7Klpyg/all/1
Your calendar feed will now only display lessons for the selected location.
Excluding Cancelled Lessons
By default, the calendar feed 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