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

Scheduler Quickstart

Get up and running with the Nylas Scheduler

Nylas Scheduler Quickstart Guide

Welcome to the Nylas Scheduler quickstart guide! We're going to dive right into setting up Nylas Scheduler. By the end, you'll be able to create an example scheduling page that you can share with people to book a time with you.

An example scheduling page that has been customized with a company logo and color scheme.

An example scheduling page that has been customized with a company logo and color scheme.

The following HTML contains a full example of what it takes to get started using the Schedule Editor. See the steps below to try it out.

<!DOCTYPE html>
<html lang="en-US">
  <head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Nylas Scheduler Simple Example</title>

    <!-- Import the Nylas Schedule Editor script --> 
    <script src="https://schedule.nylas.com/schedule-editor/v1.0/schedule-editor.js" type="text/javascript"></script>
    
  </head>

  <body>
    <!-- Create a button and give it an ID that we'll reference later --> 
    <button type="button" id="schedule-editor">Open Schedule Editor</button>

    <script>
      var btn = document.getElementById('schedule-editor');
      btn.addEventListener('click', function() {
        // Invoke the schedule editor when a user clicks on the button
        nylas.scheduler.show({
          auth: {
            // Account access_token with active calendar scope
            accessToken: "ACCESS_TOKEN", 
          },
          style: {
            // Style the schedule editor
            tintColor: '#32325d',
            backgroundColor: 'white',
          },
          defaults: {
            event: {
              title: '30-min Coffee Meeting',
              duration: 30,
            },
          },
        });
      });
    </script>

  </body>

</html>

Setup Steps

  1. Sign up for your Nylas developer account, and follow our guide to get your API keys and authorize your first account. When you complete this guide, you will get an access token that you need later.
  2. Save the code above as an HTML file, for example: scheduler-example.html.
  3. Replace ACCESS_TOKEN in the HTML file with the access token you retrieved in step 1.
  4. Open the HTML file in your web browser.
  5. Click the button "Open Schedule Editor".

That's it! Now you have access to the schedule editor and can create your own scheduling page.

To learn more about the Nylas Scheduler, its features, and how you can customize both the schedule editor and scheduling pages, see the full Nylas Scheduler guide.

Ready to use Nylas Scheduler?

Next Steps

How Nylas Works - Take a look at the Nylas architecture to see how we sync billions of events.

Quickstart Guides - Get up to speed quickly with our SDKs using our quickstart guides for Python and Node.js, or explore the Nylas Email, Calendar, or Contacts API.

Tutorials - Check out our plethora of tutorials to learn how to carry out common functionality, like creating new events, sending email invitations, RSVPing to events, and checking for calendar availability.

Integration Guides - Ready to start building your integration? Our integration guides cover what it takes to incorporate calendar functionality into your app. They cover best practices for using the Nylas Communications Platform and provider-specific advice for Google, Microsoft, and more.

Set up Postman - Postman makes it easy to explore the Nylas Calendar API.

API Reference - Our API reference provides all the detail you need to know to use the Nylas Communications Platform.

Ready to Build Your Calendar Integration?

Scheduler Quickstart


Get up and running with the Nylas Scheduler

Suggested Edits are limited on API Reference Pages

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