Skip to content

Nylas Calendar API Service

Settings / Configurations

  • Nylas ClientID/Client Secret Required to make API calls
  • Google App Authentication Required to authenticate Google users

Usage

Run Nylas Pull Command

Options

  • --account: Specify which accounts to pull nylas data from
  • --truncate-past-events: Specify to truncate all old events from the DB. This is not restrained to any specific account options, but affects all events with an end_time < the current time. Defaults to true

Examples

  • nylas:pull --account=sample-vet1@example.com --account=sample-vet2@example.com: Pull nylas calendar/event data for the provided accounts only.
  • nylas:pull --truncate-past-events=false: Pull nylas calendar/event data for all accounts, without truncating past events.

Notes

Free/Busy vs Calendar Events

  • Free busy API provides all of the information required to store NylasBusyTimeSlot, however it is limited to two providers currently (Gmail/Microsoft(EWS)). Also, Free/Busy apparently has a simpler API for getting busy events within a specific timeframe, for multiple calendars.

  • The Calendar Events API provides more information than needed, but is supported by most providers. Events API appears to only allow one calendar per query, and the API uses paging with a default limit of 100 events.

Stale Tokens

  • Tokens can become stale / revoked, and currently there is no way to alert the user/require them to re-authenticate.