Calendar

Events list JSON

For customers looking to tailor their events list to their church branding, or to do something a bit different, we also offer a JSON feed of events data. The JSON feed is still controlled by an Embed Configuration, so will need setting up in ChurchSuite before use, but can then be found at

https://<your-church-subdomain>.churchsuite.com/-/calendar/<embed-configuration-uuid>/json

To easily find this URL, preview the Embed Configuration from within ChurchSuite, and add "/json" to the end of the URL! The data is paginated: the first page of data has extra keys for related models such as Sites and Categories, and then subsequent pages (accessed with a ?page=x query) only contain extra events data.

The full OpenAPI specification for this endpoint can be found here.

While we migrate users over to the new JSON data format, you must include an "X-ChurchSuite-Version: 5.0.0" header in requests to this endpoint to receive the updated (v5) format; once migration is complete, the previous v4 format will be removed, and the v5 format will become the default.

In order to make life as easy as possible, we have written a Javascript script (based on AlpineJS) that handles all the complexity of getting multiple pages of data from the JSON endpoint, and accessing it conveniently, letting you concentrate on designing your website. Simply import AlpineJS, import our script, give it your ChurchSuite URL and Embed Configuration UUID, and get designing!

These are the properties that are available on the Event model within our Javascript package, which you can use in your website:

• event.allDay
  • A boolean that is true if the Event lasts all day.
• event.allSites
  • A boolean that is true if the Event belongs to all Sites.
• event.categoryId
  • The integer ID of the Category this Event belongs to.
• event.description
  • The full HTML description of the event - use x-html instead of x-text.
• event.end
  • A day.js instance representing the end date/time. See https://day.js.org/ for more information about formatting.
• event.id
  • The unique integer ID for the Event.
• event.identifier
  • The unique string identifier for the Event.
• event.image
  • An object containing various sized image URLs, or null for an event with no image.
  • event.image.thumbnail - The thumbnail image URL.
  • event.image.small - The small image URL.
  • event.image.medium - The medium image URL.
  • event.image.large - The large image URL.
• event.latitude
  • The Event latitude, as a float, or null for an online event.
• event.link
  • The URL of the ChurchSuite Event page.
• event.location
  • The Event location name.
• event.longitude
  • The Event longitude, as a float, or null for an online event.
• event.meetingUrl
  • The meeting URL, or null for an in-person Event.
• event.mergeIdentifier
  • A merge identifier generated by the strategy set on the Embed Configuration, that allows you to identify Events that would be merged.
• event.name
  • The name of the Event.
• event.online
  • A boolean as to whether the Event is online, as opposed to in-person.
• event.postcode
  • The postcode of the Event.
• event.sequenceId
  • The Event sequence identifier.
• event.signupEnabled
  • A boolean for whether this Event has signup enabled.
• event.siteIds
  • An array of integer Site IDs the Event belongs to. For an All Sites Event, this will contain all the Site IDs.
• event.start
  • A day.js instance representing the start date/time. See https://day.js.org/ for more information about formatting.
• event.status
  • The status of the Event.

Other models that are available for use are:

• categories - an array of Categories (see our dropdown example)
• sites - an array of Sites (see our dropdown example)
• brand - the Brand
• configuration - the Embed Configuration

Calendar Support Articles

Create events, take online payments, subscribe to iCal feeds and manage staff leave.

• Take a tour of the Calendar module
  Explore all the benefits ChurchSuite Calendar has to offer.

• Read our Calendar module support page
  A how-to guite to creating events, taking online payments and managing staff leave