Team Calendar Macro

Add the Team Calendar macro to a page to display a calendar on a Confluence page, making it easy to track and manage events. 

This macro is great for:

  • displaying team events, project timelines, and milestones in project and team spaces
  • sharing Jira issue due dates and sprint dates on sprint planning or retrospective pages
  • publishing schedules and on-call rotations where everyone can see them.

On this page:

Screenshot: The Team Calendar macro showing important project dates.


For general information about creating calendars, or subscribing to existing calendars, see Team Calendars.

Add the Team Calendar macro to your page

To add the Team Calendar macro to a page:

  1. From the editor toolbar, choose Insert > Other Macros.
  2. Select Team Calendar from the Reporting category.
  3. Select Add Existing Calendar.
  4. Search for the calendar name 
  5. Select Add

You can then publish your page to see the macro in action. 

Screenshot: configuring the Team Calendar macro in the macro browser.

Change the macro parameters

Macro parameters are used to change the behaviour of a macro.

To change the macro parameters:

  1. In the editor, click the macro placeholder and choose Edit.
  2. Update the parameters as required then choose Insert.

Here's a list of the parameters available in this macro. 

Parameter

Required

Default

Description

CalendarYesblankThe name of the calendar to display. 

View
(defaultView)

Nomonth

Format to display the calendar. Available values:

  • month
  • week
  • list
  • timeline

Width
(width)

NononeWidth of the calendar in pixels. Leave blank, and the calendar will fill the available space.
HeightNononeMaximum height of the calendar in pixels. Only applies to the timeline view. 
Calendar legendNonone

Location of the calendar legend in the month and week views. The legend shows the event types present in the selected calendar. Available values:

  • Right
  • Bottom
  • None

Calendar ID
(id)

Yes (Wiki markup only)blank

One or more calendar IDs, separated by commas. This parameter is only required when adding the macro using wiki markup.

To find out the ID for a calendar:

  1. Choose Calendars from the Confluence header or space sidebar
  2. Click
    More options
    next to a calendar and choose Embed
    A dialog appears with the link to the calendar.

The last part of the link contains the ID of the calendar. For example:


http://<your_site_url>/calendar/previewcalendar.action?subCalendarId=890143d3-5c7d-4f17-ad4b-70d8a4a4d345

Other ways to add this macro

Add this macro as you type

Type followed by the start of the macro name, to see a list of macros. 

Add this macro using wiki markup

This is useful when you want to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.

Macro name:  calendar

Macro body: None.

{calendar:id=4f5f9524-f588-468e-a48c-668ea480a77c,49221951-cca9-424f-b1ee-42ec44452bcc|defaultView=month|width=400}

Last modified on Oct 5, 2022

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.