Event Template Variables
Below are the event variables that can be used in the calendar templates.
This list does not include any custom attributes that your calendar app may have.
Variable | Description |
---|---|
{{ event.categories }} |
An array of categories that the event is assigned to.
Format: Array |
{{ event.date }} |
The event date.
Format: String Example: December 16, 2024 |
{{ event.dateIsAfterStartDate }} |
If the event is a multi-day event or is continuous from one date to another, then this value will tell if this particular event is after the start date of the multi-day/continuous event.
Format: Boolean |
{{ event.dateTimestamp }} |
The timestamp value for the event.
Format: Integer Example: 1734344395 |
{{ event.description }} |
The description content for the event.
Format: String |
{{ event.editUrl }} |
The URL to the Edit Event page if editing events are allowed and the user is logged in.
Format: String |
{{ event.endDate }} |
The end date for an event that occurs repeatedly for two or more consecutive days or for an event that spans multiple days.
Format: String Example: December 16, 2024 |
{{ event.endDateTimestamp }} |
The timestamp of the end date of an event that occurs repeatedly for two or more consecutive days or for an event that spans multiple days.
Format: Integer Example: 1734344395 |
{{ event.footer }} |
The content to be placed at the bottom of the event page.
Format: String |
{{ event.header }} |
The content to be placed at the top of the event page.
Format: String |
{{ event.icalUrl }} |
The URL to download the iCal event information.
Format: String |
{{ event.id }} |
The unique ID for the event.
Format: String |
{{ event.isFeatured }} |
Whether or not the event was set to be featured.
Format: Boolean |
{{ event.isMultiDay }} |
Whether or not the event is a multi-day event. This is an event that occurs repeatedly for two or more consecutive days.
Format: Boolean |
{{ event.isPastEvent }} |
If the event date is older than the current date. This usually only happens if the user is viewing past events.
Format: Boolean |
{{ event.isToday }} |
Whether or not the event takes place on the current date.
Format: Boolean |
{{ event.pageTitle }} |
The SEO page title value for the event
Format: String |
{{ event.publishedOnDate }} |
The date that the event was published.
Format: String Example: December 16, 2024 |
{{ event.publishedOnTime }} |
The time that the event was published.
Format: String Example: 05:19 AM |
{{ event.publishedOnTimestamp }} |
The timestamp of the date and time that the event was published.
Format: Integer Example: 1734344395 |
{{ event.registration }} |
An array of registration information for the event.
Format: Array |
{{ event.registration.allow }} |
Whether or not registration is allowed.
Format: Boolean |
{{ event.registration.allowRegistrationPayCreditCard }} |
Whether or not the user can pay by credit card for when registering for an event.
Format: Boolean |
{{ event.registration.allowRegistrationPayLater }} |
Whether or not the user can pay later when registering for an event (i.e. be invoiced).
Format: Boolean |
{{ event.registration.alreadyRegistered }} |
Whether or not the user already registered for the event.
Format: Boolean |
{{ event.registration.closeDateRangeReached }} |
Whether or not the close date on the registration has been reached.
Format: Boolean |
{{ event.registration.count }} |
The number of registrations so far for the event.
Format: Integer |
{{ event.registration.fees }} |
The registration fees for the event.
Format: String |
{{ event.registration.maxRegistrantsReached }} |
Whether or not the maximum registrants for the event has been reached.
Format: Boolean |
{{ event.registration.url }} |
The URL to the event registration form page.
Format: String |
{{ event.repeatData.description }} |
The descriptive text on how the event repeats. Example: "Daily" or "Monthly on the 1st Thursday" Format: String |
{{ event.repeatData.endDate }} |
The date that the event stops repeating.
Format: String Example: December 16, 2024 |
{{ event.repeatData.endDateTimestamp }} |
The timestamp for the date that the event stops repeating.
Format: Integer Example: 1734344395 |
{{ event.repeatData.frequency }} |
The frequency that the event repeats. Example: "daily", "weekly", "monthly", or "yearly" Format: String |
{{ event.repeatData.interval }} |
The interval that the event repeats on. If the event repeats every week then the interval would be "1". If the event repeats every other month then the interval would be "2". If the event repeats every 5 days then the interval would be "5". Format: String |
{{ event.repeatData.isFirst }} |
If this is the first event in the repeat sequence.
Format: Boolean |
{{ event.repeatData.isLast }} |
If this is the last event in the repeat sequence.
Format: Boolean |
{{ event.repeatData.repeatId }} |
The identifier of the repeat sequence.
Format: Integer |
{{ event.repeatData.startDate }} |
The date for the first event in the repeat sequence.
Format: String Example: December 16, 2024 |
{{ event.repeatData.startDateTimestamp }} |
The timestamp for the date of first event in the repeat sequence.
Format: Integer Example: 1734344395 |
{{ event.repeatData.weekdays }} |
If the event repeats daily on specific weekdays then this would hold the array those weekdays.
Format: Array |
{{ event.repeats }} |
Whether or not the event repeats.
Format: Boolean |
{{ event.spansMultipleDays }} |
Whether or not the event spans multiple days. This would be an event that starts on one day and continues into another day. This is not the same as a multi-day event, which is an event that occurs on multiple days.
Format: String |
{{ event.startDate }} |
The start date for an event that occurs repeatedly for two or more consecutive days or for an event that spans multiple days.
Format: String Example: December 16, 2024 |
{{ event.startDateTimestamp }} |
The timestamp for the start date of an event that occurs repeatedly for two or more consecutive days or for an event that spans multiple days.
Format: Integer Example: 1734344395 |
{{ event.tags }} |
An array of tags event is assigned to.
Format: Array |
{{ event.time.end }} |
The time that the event ends. This is only set if the time type is "Starting & Ending Time". Format: String Example: 05:19 AM |
{{ event.time.endTimestamp }} |
The timestamp of the time that the event ends. This is only set if the time type is "Starting & Ending Time". Format: Integer Example: 1734344395 |
{{ event.time.isAllDay }} |
Whether or not the time type is "All Day".
Format: Boolean |
{{ event.time.isNoTime }} |
Whether or not the time type is "No Time".
Format: Boolean |
{{ event.time.isStartEnd }} |
Whether or not the time type is "Starting & Ending Time".
Format: Boolean |
{{ event.time.isStartOnly }} |
Whether or not the time type is "Starting Time Only".
Format: Boolean |
{{ event.time.isTba }} |
Whether or not the time type is "To Be Announced (TBA)".
Format: Boolean |
{{ event.time.start }} |
The time that the event starts. This is only set if the time type is "Starting & Ending Time" or "Starting Time Only". Format: String Example: 05:19 AM |
{{ event.time.startTimestamp }} |
The timestamp for the time that the event starts. This is only set if the time type is "Starting & Ending Time" or "Starting Time Only". Format: Integer Example: 1734344395 |
{{ event.time.type }} |
The time type value. Possible values and their descriptions are: "timed" - Starting & End Time "start" - Starting Time "allday" - All Day "tba" - To Be Announced (TBA) "notime" - No Time Format: String |
{{ event.title }} |
The title or name of the event.
Format: String |
{{ event.url }} |
The URL of the event detail page.
Format: String |