Only show these results:
private-preview

Scheduler overview

This feature is a private preview release and should be used with caution. Its features and implementation will likely change before it is generally available.

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.

The v3 Scheduler API

You can use the v3 Scheduler API to develop customer-hosted scheduling solutions that offer significant extensibility and customizability. Some key features of the Scheduler API are...

  • Speed and reliability: Scheduler is built on top of Nylas v3 and provides high speed and reliable performance.
  • Session tokens: To support customer-hosted solutions, Nylas Scheduler v3 introduces short-lived session tokens that components use to authorize API requests. Session tokens provide increased security, so you can load a specific view for each user.
  • A comprehensive set of endpoints: The v3 Scheduler API includes a set of endpoints that can support highly customized booking flows.

For more information, see the v3 Scheduler API reference documentation.

Scheduler UI Components

🔍 Only the Scheduling Component is available during the private preview release. The Scheduler Editor component is coming soon!

You can use the v3 Scheduler UI Components to extend and customize your implementation.

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

The Scheduling Component

The Scheduling Component is made from pre-built, composable, extensible web components that let you extend your Nylas Scheduler beyond its out-of-the box capabilities. The Scheduling Component includes the following features:

  • Easy implementation: The Scheduling Component is ready to go, saving you the time and effort of developing custom solutions. Embed the default components and you're off!
  • Custom event handlers: You can customize the default event handlers to implement logic or behavior for specific end user actions in Scheduler.
  • Composable components: The composable mode allows you to customize how each sub-component is arranged and rendered in the UI.
  • Custom UI styling: The Scheduling Component supports CSS shadow parts (::part()) for a higher level of UI customization.

The Scheduling Component (nylas-scheduling) can include sub-components, such as the date picker (nylas-date-picker) and the booking form (nylas-booking-form). For more information on each component, see the Scheduler UI Components reference documentation.

How Scheduler works

When an end user starts the booking process using Scheduler, Nylas goes through the following steps:

  1. The end user's system makes a POST /v3/scheduling/configurations request to create a configuration object.
  2. The front end then makes a request to their back end to create a session token with a POST /v3/scheduling/sessions request. The session token is associated with the configuration object by ID.
  3. The back end sends the session token to the front end, which sends it to the Scheduling Component.
  4. The Scheduling Component is authorized 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 request.

Scheduler roles

The v3 Scheduler offers the following roles for individuals included on bookings:

  • Organizer: An organizer is a person who 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 a person 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.