Version:
Only show these results:

Scheduler overview

The v3 Nylas Scheduler introduces a robust, flexible, secure scheduling solution that you can build seamlessly into your applications. With the v3 Scheduler API and Scheduler UI Components, you can manage bookings, design complex scheduling flows, customize the UI, and much more.

✨ Check out the Scheduler v3 announcements for the latest releases and changes.

How Scheduler works

The v3 Nylas Scheduler has two parts: the Scheduler Editor and Scheduling Pages.

The Scheduler Editor is where organizers can create and manage their Scheduling Pages. When an organizer creates a Scheduling Page they set the event details, such as the event title, duration, buffer time, and which calendar to use to check availability.

Guests use the Scheduling Page to book a time with the organizer. When a booking is confirmed, Scheduler displays a booking confirmation and sends a confirmation email to all participants.

Organizers can also customize their Scheduling page to include links to reschedule and cancel a booking, include additional fields in the booking form, add their company logo to email notifications, and more.

Scheduler supports one-on-one meetings, collective meetings, and round-robin meetings.

Scheduler roles

There are three types of users in Scheduler: organizers, participants, and guests. Participants and guests are sometimes collectively called "attendees".

  • Organizer: An organizer creates the event. Only one organizer can exist for a Configuration object. Their account is authenticated and connected to Nylas Scheduler.
  • Attendees: People who attend the event. Attendees include the following:
    • Participant(s): A participant is within the organizer’s team or company. All participants are defined in the Configuration object.
    • Guest: A guest is the external user who books the event with participants.
    • Additional guest(s): A guest can bring additional guests to the event that they book. Their attendance is optional.

Scheduler process

When a guest starts the booking process using Scheduler, Nylas goes through the following steps:

🔍 These steps describe a booking process with a private configuration, which requires a session. You can also create public configurations.

  1. The end user's system makes a POST /v3/grants/<NYLAS_GRANT_ID>/scheduling/configurations to create a Configuration object.
  2. Your project's frontend then tells the backed to make a POST /v3/scheduling/sessions request to create a session token. The session token is associated with the Configuration object by ID.
  3. The backend sends the session token to the frontend, which sends it to the Scheduling Component.
  4. The session authorizes the Scheduling Component to make API requests to the /v3/scheduling/availability and /v3/scheduling/bookings endpoints, to check availability and manage bookings.
  5. The session token expires after the Time-to-Live (TTL), or when Nylas receives a DELETE /v3/scheduler/sessions request.

Scheduler UI Components

The Scheduler UI Components are pre-built, composable, extensible web- and React-based components. The Scheduler UI Components interact with the Scheduler API so you can quickly create custom scheduling experiences.

Nylas Scheduler includes the following UI Components:

  • Scheduler Editor Component: Create and customize the Scheduling Editor. Organizers can use the Scheduling Editor to create and edit Scheduling Pages.
  • Scheduling Component: Create and customize the Scheduling Page. Guests can use the Scheduling Page to book meetings with organizers.

The Scheduler UI Components include...

  • Custom event handlers that let you implement specific logic or behavior for end user actions in the Nylas Scheduler.
  • Composable components that allow you to customize how each sub-component is arranged and rendered in the UI.
  • Custom UI stylings that support CSS shadow parts (::part()) for a higher level of UI customization.

For more information, see the Scheduler UI Components reference.

Scheduler configurations

A configuration is a collection of event settings and preferences. Nylas Scheduler stores Configuration objects in the Scheduler database and loads them as Scheduling Pages in the Scheduler UI.

Nylas Scheduler v3 introduces short-lived session tokens that components use to authorize API requests. A configuration can be either public or private, depending on whether it uses a session.

  • Public configurations don't require a session ID (requires_session_auth: false). Anyone can access the Scheduling Page.
  • Private configurations require a valid session ID (requires_session_auth: true) to authenticate requests to the scheduling Availability and Bookings endpoints. When you use a private configuration, you can control who can book from the Scheduling Page.