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

Virtual Calendars Overview

Virtual Calendars work like any other calendar and make it easy to embed customized scheduling functionality into your application. They're ideal for situations where you need to schedule events for people or objects that aren’t associated with an existing calendar account. Virtual Calendars allow you to provide scheduling functionality to your users without requiring them to connect a third-party service provider like Google, Exchange, or Office 365. There are two major scheduling use cases for virtual calendars:

  • Users who have sensitive data in their personal calendar that they don't want to expose to do their task.
  • People or resources that don't have an account on a third party service provider

Virtual calendars behave much like any other user calendar and they can be used for most scheduling scenarios. Let's take a look at how they work.

How Virtual Calendars Work

When you create a Virtual Calendar the email field becomes the Virtual Account unique ID. Nylas uses the email field to manage the calendar account. The email cannot be used as a regular email account. You should not use an existing email account.

    {
    "client_id": "3",
    "provider": "nylas",
    "scopes": "calendar", 
    "email": "virtual_account_unique_id", 
    "name": "Virtual Calendar",
    "settings": {}
    }

Virtual Accounts can be leveraged as a part of any new or existing Nylas app. They are only available with Native Auth, and you need to provide the Nylas app’s client_id to authenticate them. Each application can have multiple virtual accounts with the associated virtual calendar. Once you create the Virtual Account and Virtual Calendar you can treat them like any other user calendar.

📘

Invitations

Virtual Calendars do not send out invitations.

In your dashboard it will appear as an account with the Provider: Nylas.

📘

Virtual Calendar Limit

Each virtual account is limited to one virtual calendar.

Webhooks

Virtual Calendars supports the following webhooks:

  • calendar_created
  • event_created
  • event_updated

Keep in Mind

  • Scheduler supports Virtual Calendars.
  • Virtual Calendars use Native Authentication only.
  • Virtual Calendars do not support notifications.
  • Virtual Calendars only works with /account, /calendar, and /event endpoints.
  • Each Virtual Account is limited to one Virtual Calendar.

Updated about a month ago


What's Next

Learn how to use Virtual Calendars

How to Use Virtual Calendars

Virtual Calendars Overview


Suggested Edits are limited on API Reference Pages

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