Introduction to Calendar Events

Calendar events let Rocket.Chat show a user's meetings and remind them before a meeting starts — this is what powers the Outlook calendar integration. The Calendar Events API manages these events for the authenticated user: create or import them, list them by date, and update or delete them.

The calendar event object

Calendar endpoints return event objects. A trimmed example from Get List of Calendar Events:

{
  "data": [
    {
      "_id": "690b02874e7e8bcf6985b27a",
      "uid": "C38WSSzrGd2NCjzqJ",
      "startTime": "2025-03-26T07:17:00Z",
      "endTime": "2025-03-26T07:18:00Z",
      "subject": "Subject8",
      "description": "Description8",
      "meetingUrl": null,
      "reminderMinutesBeforeStart": 10,
      "reminderTime": "2025-03-26T07:07:00Z",
      "notificationSent": false
    }
  ],
  "success": true
}

Fields you use most often:

• _id: The event ID, passed as eventId when reading, updating, or deleting an event.

• uid: The ID of the user the event belongs to.

• startTime and endTime: When the event runs, as ISO 8601 timestamps.

• meetingUrl: The link to join the meeting, when there is one.

• reminderMinutesBeforeStart and reminderTime: When the user is reminded; notificationSent records whether the reminder has fired.

Common workflows

Keep a user's calendar in sync

1. Create an event directly, or import it from an external calendar with its external ID so re-imports update rather than duplicate.

2. List the events for a date (format YYYY-MM-DD), or get one event's info.

3. Update the event when it changes, or delete it when it is cancelled.

Conventions

• Events belong to the authenticated user — these endpoints manage your own calendar, not other users'.

• Listing is by single date: pass date in YYYY-MM-DD format.

• For the end-user feature this API powers, see the Outlook Calendar user guide.