Only show these results:

Smart Integration

Smart Scheduler allows you to find availability between multiple users at once. This is helpful for when these users don't have access to one another's calendars. Meetings book on one calendar in a [round robin] rotation when passing multiple calendars. Choose between maximizing fairness or availability when applying the [round robin] approach to a calendar rotation.

In comparison, Instant Integration focuses on users freely creating and managing scheduling pages for their own calendars. To create Scheduling Pages with more than one Nylas <ACCESS_TOKEN>, book meetings via round robin rotations or manage pages programmatically. If you cannot place the Nylas API token in the client application, then Smart Scheduler integration works best for you.

Smart Integration Setup

With Smart Integration, API requests come from your backend server rather than your front-end client to create Scheduling Pages. This protects the Nylas <ACCESS_TOKEN> client side. It also allows you to pass multiple access tokens when creating a Scheduling Page and enables round robin booking between accounts.

Once you've created a Scheduling Page, retrieve then pass the edit_token to the client to bring about the Schedule Editor. From here, users to edit their own Scheduling Pages in app without having to expose their <ACCESS_TOKEN>.

Scheduling Pages API
See the full API reference for managing your Scheduling Pages.

Step 1 API Request

Make an API request to create a Scheduling Page from your server. Pass one or more Nylas API tokens or optionally pass a page name, page slug, and initial configuration.

curl -X POST https://api.schedule.nylas.com/manage/pages -H "Content-Type: application/json" -d '
{
"name":"Team Scheduling Page",
"slug": "team-1234",
"access_tokens": ["xFl3gbNgR0MDAM4DysONfkekDcy3Co"],
"config": {
"timezone": "America/Los_Angeles",
"event": {
"duration": 45,
"location": "Sightglass Coffee, SOMA",
"title": "Intro Meeting"
},
"appearance": {
"color": "#ff0000"
},
"booking": {
"opening_hours": [{
"days": ["M", "T", "W", "R", "F"],
"start": "09:00",
"end": "17:00"
}]
},
"reminders": []
}
}'

Step 2 Save edit_token

Store the new page's edit_token in your database. Allow users to edit the Scheduling Page's configuration in the pre-built UI by passing the edit_token to your front-end application. This also functions in place of a Nylas API token to authenticate API requests to update or delete the page.

Step 3 Allow Users to Edit

When your application's user wants to manage their Scheduling Pages, retrieve the edit_tokens of one or more pages from your database and open the management embed from your JavaScript code.

var btn = document.getElementById('schedule-editor');
btn.addEventListener('click', function() {
nylas.scheduler.show({
auth: {
pageEditToken: "<SCHEDULING_PAGE_EDIT_TOKEN>",
},
style: {
tintColor: '#32325d',
backgroundColor: 'white',
},
});
});

Step 4 Include Webhooks

Visit the Nylas API Dashboard and navigate to Webhooks > Create a Webhook. Register the following so that changes to calendars-made events update the corresponding bookings.

  • URL: https://api.schedule.nylas.com/webhook
  • Triggers:
    • event.created
    • event.updated
    • event.deleted

Round Robin Modes

  • Round Robin - Maximize Fairness: Books events evenly across the provided calendars even without availability in the configured time window for the calendar up next. This maximizes booking fairness between the Organizers' calendars to account for all and follow strict order.
  • Round Robin - Maximize Availability: If the Organizer next up in booking isn't available, this mode shows other Organizers' availability to maximize bookings for attendees. Here, meetings may not be evenly distributed between Organizers if one is less available than the others.

Set the scheduling_method parameter to round-robin-maximize-fairness or round-robin-maximize-availability within the booking object. See the reference for more info.

{
"booking": {
"min_buffer": 30,
"additional_fields": [],
"min_booking_notice": 120,
"confirmation_method": "automatic",
"opening_hours": [
{
"start": "09:00",
"end": "11:30",
"days": ["M", "T", "W", "R", "F"]
}
],
"available_days_in_future": 14,
"min_cancellation_notice": 180,
"scheduling_method": "round-robin-maximize-fairness"
}
}

What's Next

  • View in-depth Python and Node example applications.
  • Refer to the Customization guide for the full collection of configurable options to pass to the Schedule Editor.