ICS Event Calendar Feed
Having all of your events in the Platform is great! But what if you could also add them to iCal, Outlook, or Google Calendar? That way, you can see all your events in one place and make them visible to people who aren't in the Platform as often. You can do that with an ICS Event Calendar Feed!
All you need is a feed URL. This URL supports a query string to filter the results that you see in your external calendar. For more information on filter options, see Filtering Events to Display on Your Calendar. Regardless of the options you use, canceled events are never uploaded.
Once you have your feed URL, you can add it to your calendar application. Consult your application's help files for information on how to do this. If you use Google Calendar, see Add Events to Google Calendar.
Filtering Events to Display on Your Calendar
A query string contains parameters and values separated by an equal sign (=). The first parameter starts with a question mark (?) and additional parameters begin with an ampersand (&). You can use multiple parameters in your query string. For example, this query string filters by featured events for a single congregation:
https://{feed-url}/EventsICS?GetFeaturedEventsOnly=true&CongregationID=1
Use the parameters below to build the query string based on your needs and preferences. Remember to replace "{feed-url}" with the URL you received from Support.
- startDate
- Selects the top 1,000 events starting on or after this date/time, up to 12 months. If not specified, the default value is one month in the past (today minus one month).
https://{feed-url}/EventsICS?startDate=12%2F31%2F2020 - endDate
- Selects the top 1,000 events ending before this date/time. When not specified, the default value is 12 months in the future (today plus 12 months).Note: You must use endDate in conjunction with startDate.
https://{feed-url}/EventsICS?startDate=12-31-2023&endDate=1-31-2024 - GetFeaturedEventsOnly
- When set to true, only events set with Featured On Calendar display. The default is false.
- GetRegistrationEventsOnly
- When set to true, only events with active registrations display. The default is false.
https://{feed-url}/EventsICS?GetRegistrationEventsOnly=true - MinistryID
- When set to anything but null, only events for the specified Ministry ID display.
https://{feed-url}/EventsICS?MinistryID=107 - CongregationID
- When set to anything but null, only events for the specified Congregation ID display. Tip: Diocesan SPoCs: You can use this parameter to filter your base calendar feed per parish.
https://{feed-url}/EventsICS?CongregationID=10 - ProgramID
- When set to anything but null, only events for the specified Program ID display.
https://{feed-url}/EventsICS?ProgramID=36 - RoomID
- When set to anything but null, only events for the specified Room ID display.
https://{feed-url}/EventsICS?RoomID=276 - LocationID
- When set to anything but null, only events for the specified Location ID display.
https://{feed-url}/EventsICS?LocationID=48 - VisibilityLevel
- Use a single or comma-separated list of Visibility Level IDs, 1 through 5. The default is 4- Public.Note: If you use anything other than 4, you may have to set OnlyApprovedEvents to false.
https://{feed-url}/EventsICS?VisibilityLevel=2&OnlyApprovedEvents=false - OnlyApprovedEvents
- When set to true, this only displays events where the Approved and Web Approved fields are set to Yes. When set to false, ignore both fields. The default is true.
https://{feed-url}/EventsICS?VisibilityLevel=2&OnlyApprovedEvents=false - ShowExtendedData
- Show extended event information in details (Rooms, Servicing, Resource, Links, and so on). The default is false.
https://{feed-url}/EventsICS?ShowExtendedData=true - EventID
- Show a specific event based on the EventID.
https://{feed-url}EventsICS?EventID=[EventID]
Notes on Date Parameter Options
- If you don't specify dates, the results limit to one month in the past (today minus 1 month) to 12 months in the future (today plus 12 months).
- The following are valid date formats:
- M/D/YYYY
- MM/DD/YYYY - Use leading zeros where appropriate.
- M-D-YYYY
- MM-DD-YYYY - Use leading zeros where appropriate.
- The ICS spec has two types of dates: UTC or "floating time". We use "floating time", which means the date parameters don't contain any time zone information. That is determined at the website level.