# Discourse Events
**URL:** https://meta.discourse.org/t/discourse-events/97376
**Category:** Plugin
**Tags:** official, events, included-in-core
**Created:** [September 17, 2018, 3:50pm UTC](https://meta.discourse.org/t/discourse-events/97376 "2018-09-17T15:50:24Z")
**Posts on this page:** 20
**Page:** 1
### Author:  [@Discourse](https://meta.discourse.org/u/Discourse)
#### Post date: [September 17, 2018, 3:50pm UTC](https://meta.discourse.org/t/discourse-events/97376/1 "2018-09-17T15:50:24Z")
| | | |
| --- | --- | --- |
| :discourse2: | **Summary** | **Discourse Events** adds dynamic and interactive calendar and event features to your Discourse site. |
| đ | **Install Guide** | **This plugin is bundled with Discourse core**. There is no need to install the plugin separately. |
> [@](#):
>
> :discourse2: As this is an #official plugin maintained by the Discourse team, #Support, #Contribute > Bug, #Contribute > UX, and #Contribute > Feature requests can be made in the respective categories here on Meta, and tagged with the appropriate plugin tag. Click on a link below to get one started. đ
>
> [â **Support**](https://meta.discourse.org/new-topic?category_id=6&body=%3E%20Before%20asking,%20did%20you%20search%20first%3F%20Press%20%F0%9F%94%8D%20at%20the%20upper%20right%20to%20search.&tags=events "Ask for support on configuring and using Discourse Calendar") [đ **Bug**](https://meta.discourse.org/new-topic?category_id=1&tags=events "A bug report means something is broken, preventing normal/typical use of the plugin") [đ **UX**](https://meta.discourse.org/new-topic?category_id=9&tags=events "Discussion about the user interface of Discourse Calendar, and how features are presented (including language and UI elements)") [đĄ **Feature**](https://meta.discourse.org/new-topic?category_id=2&tags=events "Discussion about how existing Discourse Calendar features can be improved or enhanced, and how proposed new features could work")
### Enabling Events
The Events plugin can be enabled either by the toggle or from its settings, both accessible from your `admin/plugins` page:
> :discourse2: Hosted by us? This plugin is available on our Business and Enterprise tiers [https://www.discourse.org/plugins/calendar.html](https://www.discourse.org/plugins/calendar.html)
### Features
Somewhat unsurprisingly, **Discourse Events** adds both the calendar and event features to your Discourse site. With these, you can create individual topic calendars to track important occasions or timelines, display calendars in categories, add a holiday calendar to mark vacations, absences, or sick days, create interactive event topics, as well as show an easy-access calendar summary of all of your upcoming events.
### Calendars
Bespoke calendars can be created in multiple topics, and ones you wish to give higher visibility to can be displayed above a categoryâs topic list.
You can find more detailed information on how to create and use calendars in:
> [@Creating and managing calendars](https://meta.discourse.org/t/create-calendars/283773):
>
> bookmark This guide explains how to create and manage calendars in Discourse using the Calendar (and Event) plugin. person_raising_hand Required user level: All users Calendars are a powerful feature in Discourse that allow you to organize and display events within your community. This guide will walk you through the process of creating calendars, adding events, and managing them effectively. Summary Enable the Calendar plugin Create a calendar in a topic or category Add events to youâŠ
### Events
The Event feature allows interactive elements to be inserted into topics which your members can use to sign up to attend or participate in your communityâs activities. These are all summarised in a dedicated site-wide calendar, with the option to add an easy-access link to your navigation menu. You can find more information on how to create and use this feature in:
> [@Creating and managing events](https://meta.discourse.org/t/create-events/149964):
>
> bookmark This guide explains how to create and manage events using the Calendar and Event plugin in Discourse. It covers how to create events, set event options, interact with events, and view the upcoming events calendar. person_raising_hand Required user level: All users (with appropriate permissions) Enabling events Events are a feature of the [Calendar and Events plugin](https://meta.discourse.org/t/discourse-calendar-and-event/97376). To use this feature: Enable the Calendar and Events plugin Configure related settings For detailed instructionsâŠ
> â This should not be confused with Pavilionâs [Events plugin](https://meta.discourse.org/t/events-plugin/69776) (note the plural)
### Calendar Settings
| Name | Description |
| --- | --- |
| calendar enabled | Enable the discourse-calendar plugin. This will add support for a [calendar][/calendar] tag in the first post of a topic. |
| holiday calendar topic id | Topic ID of staffs holiday / absence calendar. |
| holiday status emoji | Defines the emoji used for the holiday status. |
| delete expired event posts after | Posts with expired events will be automatically deleted after (n) hours. Set to -1 to disable deletion. |
| all day event start time | Events that do not have a start time specified will start at this time. Format is HH:mm. For 6:00 am, enter 06:00 |
| all day event end time | Events that do not have a end time specified will end at this time. Format is HH:mm. For 6:00 pm, enter 18:00 |
| calendar categories | Display a calendar at the top of a category. Mandatory settings are categoryId and postId. eg: categoryId=6;postId=453\[1\] Other valid settings: tzPicker\[2\], weekends\[3\] and defaultView\[4\]. |
| calendar categories outlet | Allows to change which outlet should show the category calendar. |
| working days | Set working days. You can display the availability of a group using the `timezones` tag in a post, eg: `[timezones group=admins][timezones]` |
| working day start hour | Start time of the working day hours. |
| working day end hour | End time of the working day hours. |
| close to working day hours extension | Set extension time in working day hours to highlight the timezones. |
| calendar automatic holidays enabled | Automatically set holiday status based on a users region (note: you can disable specific automatic holidays in plugin settings) |
| map events title | Maps title of the sidebar calendar based on category. Defaults to âUpcoming eventsâ |
### Event Settings
| Name | Description |
| --- | --- |
| discourse post event enabled | Enables the Event features. Note: also needs `calendar enabled` to be enabled. |
| discourse post event allowed on groups | Groups that are allowed to create events. |
| displayed invitees limit | Limits the numbers of invitees displayed on an event. |
| display post event date on topic title | Displays the date of the event after the topic title. |
| use local event date | Use local date after topic title instead of relative time. |
| discourse post event edit notifications time extension | Extends (in minutes) the period after the end of an event when `going` invitees are still being notified from edit in the original post. |
| discourse post event allowed custom fields | Allows to let each event to set the value of custom fields. |
| events calendar categories | Display an events calendar at the top of a category. |
| sort categories by event start date enabled | Enable the sorting of category topics by event start date. |
| disable resorting on categories enabled | Allow categories to disable the ability for users to sort on the event category. |
| sidebar show upcoming events | Show upcoming events link in the sidebar under âMoreâ. Requires `post event enabled` |
| map events to color | Assigns an event color to a specified tag or category |
> âč đ„ The `discourse-post-event/events.json` endpoint now has an added parameter to switch between simple and detailed response. To get the detailed response you can add `?include_details=true`:
>
> `/discourse-post-event/events.json?include_details=true`
## Creating Events via the API
You can create events via `POST /posts.json` with `[event][/event]` BBCode in the `raw` field. Here are the details on how to setup your API request:
- Use `POST /posts.json` with the `raw` parameter
- Event syntax: `[event start="2024-05-10 20:00" status="public" timezone="America/Vancouver" end="2024-05-10 21:30" allowedGroups="trust_level_0"]\n[/event]`
- A literal `\n` newline is **required** between opening and closing tags
- Double quotes must be escaped when using JSON (`\"`)
- The API user account **must have permission to create events** (admin or a group with event creation rights)
- Set the category via the `category` parameter, passing in the categoryâs id as the value.
## Livestream events
For live events, use the livestream functionality to let members watch an event and participate in chat at the same time.
A livestream event includes:
- A video stream (using YouTube, for example)
- A calendar event using [Discourse Events](https://meta.discourse.org/t/discourse-calendar-and-event/97376)
- An accompanying [chat](https://meta.discourse.org/t/discourse-chat/230881) channel automatically created for the event
### Prerequisites for livestream events
To use livestream events, you must have `chat enabled`, since livestream creates a chat channel to accompany your event, in addition to `discourse post event enabled` and `calendar enabled`.
> **If you want to use livestream, but don't want chat elsewhere...**
>
> - Set `chat allowed groups` to the default configuration, or include `trust_level_0` to let brand new users participate in livestream chat
> - Remove groups from the `direct message enabled groups` setting to prevent user-to-user DMs
> - Donât create other chat channels
### Creating a livestream event
To create a livestream event:
1. Open a new topic.
2. Select the **+** icon in the composer toolbar and click Create Event (if the event was not already added to your topic).
3. Paste the link to the event video (e.g., a YouTube URL) in the location/URL field.
4. Toggle on âlivestreamâ
You will then see that the event and livestream has been created, along with an accompanying chat channel on the right side.
Once any user hits Going on the event, they will automatically join the chat channel, allowing them to participate in the conversation!
### Livestreaming Zoom webinars
You can use livestream to host Zoom webinars directly in Discourse, so that members can watch the event and participate in the accompanying chat channel without leaving your community.
#### Prerequisites for Zoom webinars
In addition to the [livestream prerequisites](#p-473517-prerequisites-for-livestream-events-8), you will also need to configure the following settings:
- Turn on `livestream zoom enabled`
- Enter your Zoom Meeting SDK key in the `livestream zoom sdk key` setting
- Enter your Zoom Meeting SDK secret in the `livestream zoom sdk secret` setting
#### To obtain the Zoom Meeting SDK key and secret:
1. Go to [marketplace.zoom.us](https://marketplace.zoom.us), click **Develop** , and click **Build app**.
2. When asked what type of app youâre creating, choose **General App** and click **Create**.
3. From the appâs **App Credentials** page, copy the **Client ID** (SDK Key) and **Client Secret** (SDK Secret).
4. Under **Embed** , enable the **Meeting SDK** permission.
5. In your Discourse, go to **Admin â All site settings** and enter the values from step 3 in `livestream zoom sdk key` and `livestream zoom sdk secret`.
For the Zoom webinar to work correctly in Discourse:
- The webinar **should not require registration or a passcode** to join.
- **Disable Zoomâs built-in webinar** **chat** to ensure all discussion happens in the single Discourse chat channel to keep all chat in one place and ensure the conversation can continue after the webinar ends.
#### Creating a Zoom webinar livestream event
To create a livestream event for your Zoom webinar:
1. Open a new topic, select the **+** icon, and click **Create Event**.
2. Paste your Zoom webinar link (e.g., `https://zoom.us/``...`) in the **URL** / **Location** field.
3. Toggle **Livestream** on.
4. Set the event name, start time, end time, and other event details as desired.
5. Post the topic.
Like other livestream events, this event will be created with an accompanying Discourse chat channel that members auto-join after they RSVP as âGoingâ.
#### Member experience
Hereâs how your members will experience the webinar:
**Before the event**
A Join Zoom button is shown from 30 minutes before the event starts. Outside that window, the button is disabled with a message indicating when it will become available.
**During the event**
Once members click Join Zoom, the webinar will load into the topic page (or, if the host hasnât yet started the event, the member will need to wait until they do so to see the video).
Audio **does not** automatically connect when joining the webinar; attendees need to click or tap the audio icon in the Zoom toolbar to connect. This is a Zoom SDK limitation and canât be changed.
On mobile, the webinar opens in a full-screen Zoom view (which is also accessible on desktop by adding `/zoom` to the end of the event topic URL) with a floating **Chat** button that they can tap to open a chat overlay panel during the event.
**After the event**
The Join Zoom button is hidden 10 minutes after the event end time. The chat channel remains accessible to attendees until you close it.
### Integrations with Other Plugins
You can use a component from this plugin with [Right Sidebar Blocks](https://github.com/discourse/discourse-right-sidebar-blocks). Youâll want to ensure the desired route is enabled in the Right Sidebar Blocks component. The block name will be `upcoming-events-list`. Historically, there were additional settings required in the Calendar plugin itself, but this has been streamlined.
This is how the sidebar calendar will appear by default.
If you donât want the time, you can add an empty `timeFormat` value in the componentâs block setting.
* * *
1. categoryId is the category the calendar will be displayed on top of.
postId is the post in which you put the calendar in with [calendar][/calendar]
2. it can display a time zone picker on the upper right of the calendar. False by default, you can enable it with tzPicker=true
3. it can hide Saturdays and Sundays from the calendar. True by default. You can set it to false with weekends=false.
4. defaultView will set the calendarâs view (day, week, etc;). It can be set as:
defaultView=agendaDay
defaultView=agendaWeek
defaultView=month (default)
defaultView=listNextYear
> Last edited by @Moin 2026-08-26T14:37:57Z
>
> > **Check document**
> >
> > Perform check on document:
---
### Author:  [@martyn\_thomas](https://meta.discourse.org/u/martyn_thomas)
#### Post date: [December 10, 2023, 6:43am UTC](https://meta.discourse.org/t/discourse-events/97376/412 "2023-12-10T06:43:50Z")
This plugin is promising - but thereâs some features that are missing that prevents us from jumping from Pavilionâs plugin
- Display non-all-day events with the start time on the calendar, currently every event looks like an all day event.
- âAdd Eventâ button in the composer next to the tag selector (not hidden in the cog)
- Limit which categories can have events, and if a events are compulsory in a category
Nice to haves:
- Event meta data in the topic only appears/is entered at the top of the topic (instead of where ever the curser is
- ability to limit which groups can make events in a category (for example - only âEventPlannersâ group can create events in the âDiscussionâ category, but all users can create non-event topics (or edit topics if the topic is set to Wiki)
- change URL of /upcoming-events to /calendar
---
### Author:  [@JammyDodger](https://meta.discourse.org/u/JammyDodger)
#### Post date: [April 23, 2024, 9:00am UTC](https://meta.discourse.org/t/discourse-events/97376/439 "2024-04-23T09:00:44Z")
2 posts were split to a new topic: [Holiday status being incorrectly applied](https://meta.discourse.org/t/holiday-status-being-incorrectly-applied/305042)
---
### Author:  [@pokapow](https://meta.discourse.org/u/pokapow)
#### Post date: [April 15, 2024, 10:02am UTC](https://meta.discourse.org/t/discourse-events/97376/441 "2024-04-15T10:02:29Z")
Hello there,
Thank you for this work.
I have 2 UX questions:
- Is it possible to display âAdd eventâ button next to âAdd locationâ button in topic editor ? Like it was the case with pavillion plugin ?
- Is there a possibility to add Calendar top menu entry ? I donât find it in settings
---
### Author:  [@AstonJ](https://meta.discourse.org/u/AstonJ)
#### Post date: [April 17, 2024, 1:46pm UTC](https://meta.discourse.org/t/discourse-events/97376/442 "2024-04-17T13:46:18Z")
This looks great! Some thoughts/questions:
Am I correct in assuming that to create a calendar you simply create a new thread/topic, and paste the following into it:
```plaintext
Name Of Calendar
[calendar]
[/calendar]
```
Then to add entries to the calendar you simply make a new post in the sam thread with something like the following (by clicking on the `insert time/date` icon in the post options):
```plaintext
Name of Event/Entry
[date-range from=2024-04-18 to=2024-04-19 timezone="Europe/London"]
```
This adds the entry to the calendar which is great, however:
- Is there any way to add entries to a calendar but let those entires have a dedicated thread/topic as well? (I see you can add events in new threads, but there doesnât appear to be any way to add those events to a calendar).
- Is there any way to feature âUpcoming Eventsâ from a specific calendar in the digest emails? Or maybe the left hand column, and with each entry linking to the dedicated thread for that entry?
If this is not currently possible do you have any plans to add it?
---
### Author:  [@haozi](https://meta.discourse.org/u/haozi)
#### Post date: [April 30, 2024, 9:35am UTC](https://meta.discourse.org/t/discourse-events/97376/443 "2024-04-30T09:35:09Z")
@vinothkannans Could you help me review this pr?
[https://github.com/discourse/discourse-calendar/pull/561](https://github.com/discourse/discourse-calendar/pull/561)
---
### Author:  [@putty](https://meta.discourse.org/u/putty)
#### Post date: [May 10, 2024, 6:49pm UTC](https://meta.discourse.org/t/discourse-events/97376/445 "2024-05-10T18:49:22Z")
Are there plans to add a URL feed that users can subscribe to? Iâm sure it would be tricky for all events vs the ones they have RSVPâd to.
Secondly, an additional layer would be amazing if it could recognize private events (or maybe thatâs just a different URL feed per group).
---
### Author:  [@jordan-violet](https://meta.discourse.org/u/jordan-violet)
#### Post date: [May 10, 2024, 7:31pm UTC](https://meta.discourse.org/t/discourse-events/97376/446 "2024-05-10T19:31:12Z")
> [@putty](#):
>
> Are there plans to add a URL feed that users can subscribe to? Iâm sure it would be tricky for all events vs the ones they have RSVPâd to.
> [@Finding Discourse RSS feeds](https://meta.discourse.org/t/discourse-rss-feeds-list/264134):
>
> bookmark A reference list of all the RSS feeds available in Discourse. person_raising_hand Required user level: All users Hereâs a list of most of the available RSS feeds in Discourse. [RSS](https://en.wikipedia.org/wiki/RSS) is a standardised, computer-readable format for content that allows it to be shared between sites and platforms easily. information_source RSS links that contain an ID (categories, topics, badges, etc.) are defined by their ID. The links wonât break if the slug part of the URL changes, but the slugâŠ
There is no rss feed for the /upcoming-events url thoughâthat would be a nice addition!
---
### Author:  [@pokapow](https://meta.discourse.org/u/pokapow)
#### Post date: [May 17, 2024, 11:31pm UTC](https://meta.discourse.org/t/discourse-events/97376/449 "2024-05-17T23:31:56Z")
What about caldav sync ?
---
### Author:  [@Matthias\_Schuster](https://meta.discourse.org/u/Matthias_Schuster)
#### Post date: [June 2, 2024, 4:22pm UTC](https://meta.discourse.org/t/discourse-events/97376/450 "2024-06-02T16:22:18Z")
That would also for me be a reason to switch, indeed.
---
### Author:  [@Heliosurge](https://meta.discourse.org/u/Heliosurge)
#### Post date: [June 8, 2024, 5:47am UTC](https://meta.discourse.org/t/discourse-events/97376/451 "2024-06-08T05:47:24Z")
This needs more updating as it mentions a. Event Insert in composer and adding event details not as pictured. Unless Event was an add on?
---
### Author:  [@Isambard](https://meta.discourse.org/u/Isambard)
#### Post date: [June 8, 2024, 4:54pm UTC](https://meta.discourse.org/t/discourse-events/97376/452 "2024-06-08T16:54:41Z")
Iâve installed the plug-in and the calendar tag works in the first post of a topic. But I donât see any event or calendar options in the gear menu:
Can someone please explain what I need to do to get the event option in the gear menu?
---
### Author:  [@JammyDodger](https://meta.discourse.org/u/JammyDodger)
#### Post date: [June 8, 2024, 4:58pm UTC](https://meta.discourse.org/t/discourse-events/97376/453 "2024-06-08T16:58:28Z")
You need to enable the Event portion of the plugin `discourse post event enabled`
---
### Author:  [@Isambard](https://meta.discourse.org/u/Isambard)
#### Post date: [June 8, 2024, 5:57pm UTC](https://meta.discourse.org/t/discourse-events/97376/454 "2024-06-08T17:57:24Z")
Thanks. I somehow missed this setting.
---
### Author:  [@Heliosurge](https://meta.discourse.org/u/Heliosurge)
#### Post date: [June 9, 2024, 12:25am UTC](https://meta.discourse.org/t/discourse-events/97376/455 "2024-06-09T00:25:15Z")
How do you get create event to show in a Category topic with replies being events?
I see the create event works on creating new topics. But looking to have a Calender in a topic with replies adding events. It works partially with insert date but not as good as create event has more options.
---
### Author:  [@eve](https://meta.discourse.org/u/eve)
#### Post date: [June 12, 2024, 10:46am UTC](https://meta.discourse.org/t/discourse-events/97376/456 "2024-06-12T10:46:06Z")
Currently users can set the region in their profile preferences.
Iâd like to let them set their region during signup by showing this field in the registration form. Is that feasible?
---
### Author:  [@joo](https://meta.discourse.org/u/joo)
#### Post date: [July 29, 2024, 10:13am UTC](https://meta.discourse.org/t/discourse-events/97376/458 "2024-07-29T10:13:31Z")
Will a deleted reply still appear on the calendar?
---
### Author:  [@tonninseteli](https://meta.discourse.org/u/tonninseteli)
#### Post date: [August 8, 2024, 1:51pm UTC](https://meta.discourse.org/t/discourse-events/97376/460 "2024-08-08T13:51:14Z")
I canât find any setting for changing first day of week to monday, is this trivial to implement if missing? đ€
Another issue is that that time & date entry is broken, if itâs an all day event there should be an option to select it before the time entry fields mess up the dates, and the dates seem to change randomly when editing.
Also noticed that itâs possible to enter 00:00 in both time & date, (which sometimes works, sometimes doesnât) leading to calendar giving an error which will then cause some conflict with drafts leading to a repeated 422 error until the page is rolled back to an earlier revision, then re-edited etc.
---
### Author:  [@joo](https://meta.discourse.org/u/joo)
#### Post date: [August 8, 2024, 2:31pm UTC](https://meta.discourse.org/t/discourse-events/97376/461 "2024-08-08T14:31:03Z")
> [@Setting up the âAppend last edited byâ automation](https://meta.discourse.org/t/setting-up-the-append-last-edited-by-automation/277113/10):
>
> When activating this automation, the âLast edited byâ content is automatically added to Calendar. Iâm seeking advice on whether this is a bug or if itâs an issue with my settings. Could anyone help clarify?
>
> 
>
> 
Please refer here
---
### Author:  [@Jagster](https://meta.discourse.org/u/Jagster)
#### Post date: [August 8, 2024, 4:36pm UTC](https://meta.discourse.org/t/discourse-events/97376/462 "2024-08-08T16:36:13Z")
> [@tonninseteli](#):
>
> I canât find any setting for changing first day of week to monday, is this trivial to implement if missing?
There isnât such setting and thatâs why I donât use it. And I bet the team would fix that error if it would be trivial trick.
[Next page](https://meta.discourse.org/t/discourse-events/97376.md?page=2)