Nylas Docs

The Nylas Developer Hub

Welcome to the Nylas developer hub. You'll find comprehensive guides and documentation to help you start working with Nylas as quickly as possible, as well as support if you get stuck. Let's jump right in!

Developer Guide

Embedding Scheduler

Learn how to embed Nylas Scheduler into your existing application and workflows.

This guide will go over considerations when embedding Scheduler Editor and Scheduler booking pages.

Integrate Into An Existing Application

To integrate Scheduler booking pages, you can use an iframe or mount it as an external component. The booking pages are loaded on a Nylas domain, for example, https://schedule.nylas.com/your-schedule-pages.

You can integrate Scheduler Editor directly into an application so your users can manage their Scheduling pages. Using this method, the Scheduler Editor will use the domain of your application.

We have two sample applications showing this use case:

  • NodeJS Hosted Auth + Scheduling: A NodeJS / TypeScript example that showcases both instant and smart integration types. It also demonstrates how to theme the schedule editor to match your application.

  • Python Hosted Auth + Scheduling: A Python example that showcases both instant and smart integration types. It also demonstrates how to theme the schedule editor to match your application.

Custom Domains

If you are using an iFrame or CNAME to present the schedule editor pages on another domain, Scheduler offers a pageDomain configuration. Page Domain will replace all references to the schedule editor page's public URL with your domain.

🚧

Page Domain Booking Pages

pageDomain does not replace the Booking page URL. Only the editor pages. Email confirmations and booking links will still have Nylas in the URL.

Page Domain automatically adds https. If your service does not support HTTPS, then you must add http.

Custom Domain Example

nylas.scheduler.show({
  pageDomain: 'https://schedule.myco.com/pages',
  auth: {
    accessToken: accessToken,
  },
  ...
})

Custom Redirects

If you want to redirect users to your booking pages during an existing workflow, you'll need to handle this within your application. There is currently not a built-in option.

We do offer:

Handle Reauthentication

When a customer re-authenticates or their account has their tokens and permissions revoked, Nylas's access tokens will be invalid. The invalid tokens mean your user will lose access to their booking pages. To fix this, make a GET request to https://schedule.api.nylas.com/manage/pages, with the account's newest access token after they reauthenticate.

Best Practices

  • Make sure you have Scheduler Webhooks added. Scheduler webhooks let you get notifications about events so you can direct users around the application.
  • Make sure the account is not in a STOPPED or INVALID state. This prevents Nylas from syncing the account.
  • Check if the Future Limit (how far in the future someone can book) is too far. Lower limits mean the application will run smoother.
  • Review our Smart Integration guide using the API to manage events from the backend, instead of the client-side.

hosted, embedding

Updated 10 days ago

Embedding Scheduler


Learn how to embed Nylas Scheduler into your existing application and workflows.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.