Skip to content
Docs
Getting started
Authentication
Email
Calendar
Scheduler
Notetaker
Developer resources
Use cases
✨ What's new
API & UI Reference
Getting started
Getting started with Nylas
Quickstart: Email API
Quickstart: Transactional Send (Beta)
Quickstart: Nylas Inbound (Beta)
Quickstart: Calendar & Events APIs
Quickstart: Scheduler
Quickstart: Notetaker
Quickstart: Nylas Connect
Quickstart: AI prompts
Authentication
Authenticating with Nylas
Setup guides
Hosted OAuth with API key
Hosted OAuth with access token & PKCE
Bring your own authentication
IMAP authentication
Service account
Nylas Connect
Nylas Connect JS
Nylas Connect overview
External IDPs
Overview
Auth0
Clerk
Google
WorkOS
Custom IDP
NylasConnect class
NylasConnect class overview
Authentication methods
connect()
getAuthUrl()
onConnectStateChange()
Callback methods
callback()
handleRedirectCallback()
Grant management methods
getConnectionStatus()
getSession()
logout()
Utility methods
setLogLevel()
Nylas Connect React
Nylas Connect React overview
useNylasConnect
External IDPs (React)
Overview
Auth0
Clerk
Google
WorkOS
NylasConnectButton component
Advanced
Bulk authentication grants
Using multiple provider applications
Customize the login prompt
Troubleshooting
Troubleshoot auth errors
Email
Email API
Using the Messages API
Sending messages
Managing domains
Email Domain Warm Up
Using templates & workflows
Scheduling messages
Sending errors
Parsing messages
Using Smart Compose
Tracking messages
Using the Threads API
Using the Folders API
Using the Attachments API
Using email headers & MIME data
Using the Contacts API
Calendar
Using the Calendar API
Using virtual calendars
Using the Events API
Checking availability
Checking free/busy information
Group availability & booking
Adding conferencing to events
Recurring events and RRULE
Scheduler
Using Scheduler
Using the Scheduler Editor component
Using the Scheduling component
Hosted Scheduling Pages
Customizing Scheduler
Localizing Scheduler
Scheduler & Notetaker Integration
Meeting types
Managing availability
Adding conferencing to bookings
Customizing booking flows
Retrieving booking IDs
Scheduler components & elements references
Scheduler components & elements overview
NylasScheduling component
NylasScheduling elements
nylas-booked-event-card
nylas-booking-form
nylas-cancel-booking-form
nylas-cancelled-event-card
nylas-confirmed-event-card
nylas-date-picker
nylas-feedback-form
nylas-locale-switch
nylas-notification
nylas-organizer-confirmation-card
nylas-selected-event-card
nylas-timeslot-picker
nylas-timezone-picker
NylasSchedulerEditor component
NylasSchedulerEditor elements
nylas-additional-participants
nylas-availability-picker
nylas-availability-settings
nylas-booking-calendar-picker
nylas-booking-confirmation-redirect
nylas-booking-confirmation-type
nylas-booking-form-config
nylas-buffer-time
nylas-calendar-picker
nylas-cancellation-policy
nylas-confirmation-email
nylas-connected-calendars
nylas-custom-booking-flow
nylas-custom-event-slug
nylas-customize-booking-settings
nylas-disable-emails
nylas-editor-tabs
nylas-editor-tabs-group
nylas-event-calendar
nylas-event-capacity
nylas-event-description
nylas-event-duration
nylas-event-info
nylas-event-limits
nylas-event-location
nylas-event-reminders
nylas-event-timeslot
nylas-event-timezone
nylas-event-title
nylas-form-card
nylas-limit-future-bookings
nylas-list-configurations
nylas-min-booking-notice
nylas-min-cancellation-notice
nylas-page-name
nylas-page-styling
nylas-participant-booking-calendars
nylas-participants-custom-availability
nylas-reminder-emails
nylas-reminder-time
nylas-scheduling-method
nylas-select-event-type
nylas-specific-date-availability-picker
nylas-time-window-picker
nylas-timeslot-interval
Form elements
checkbox-component
checkbox-group
input-color-picker
input-component
input-image-url
radio-button-group
select-dropdown
textarea-component
toggle-switch
Notetaker
Using Notetaker
Using calendar sync with Notetaker
Handling Notetaker media files
Scheduler & Notetaker Integration
Developer resources
Dev guide
About Nylas
Developing with Nylas
Platform
The Nylas platform
What is nyl.as?
API & provider rate limits
Data residency
Privacy mode
Field selection
Reporting abuse
Nylas static IP addresses
Nylas domain certificates
Supported attachment media types
Using the Dashboard
Nylas MCP
Best practices
Security best practices
Managing grants
Handling expired grants
Improving email deliverability
Best practices for webhooks
Searching
Avoiding rate limits
Error monitoring & handling
Dealing with spam
Customize Hosted Authentication branding
Using metadata
Using granular scopes
Nylas glossary
Provider guides
Integrating providers
Google
Using Google accounts & data
Creating a Google auth app
Shared GCP App
Verification & security assessment
Working with delegated mailboxes & Groups
Setting up service accounts
Setting up Pub/Sub
Microsoft
Using Microsoft accounts & data
Creating an Azure auth app
Publisher verification guide
Authenticating Microsoft accounts
Configuring admin approval
Suggested Microsoft 365 settings
Shared Outlook folders
Troubleshooting Microsoft configuration
IMAP providers
Using IMAP accounts & data
Troubleshooting IMAP configuration
Authenticating Exchange on-prem accounts
Authenticating iCloud accounts
Authenticating Yahoo accounts
Zoom Meetings
Authenticating Zoom Meetings accounts
Troubleshooting Zoom Meetings
Using app passwords
Notifications
Using webhooks
Using a Pub/Sub channel
Notification schemas
SDKs
Nylas SDKs
Node.js
Overview
Read messages and threads with Node.js
Send messages with Node.js
Manage folders and labels with Node.js
Manage events with Node.js
Manage contacts with Node.js
Ruby
Overview
Read messages and threads with Ruby
Send messages with Ruby
Manage contacts with Ruby
Python
Overview
Read messages and threads with Python
Send messages with Python
Manage folders and labels with Python
Manage events with Python
Manage contacts with Python
Kotlin/Java
Overview
Read messages and threads with Kotlin/Java
Send messages with Kotlin/Java
Manage folders and labels with Kotlin/Java
Manage contacts with Kotlin/Java
Support & troubleshooting
How to get support
GDPR overview & inquiries
Usage calculation & billing
Troubleshooting
Get header content
Changed email account password
Message not received
Nylas link directs to spam
Immediate webhook notifications
Missing notifications for read messages
API & UI Reference
Overview
Authentication APIs
Authentication APIs
Hosted OAuth - Authorization Request
Hosted OAuth - Token exchange
Hosted OAuth - Revoke OAuth token
OAuth Token Info
Manage Grants
Bring Your Own Authentication
Manage Grants
Return all grants
Get a grant
Update a grant
Delete a grant
Get current grant
Messages
Return all Messages
Return a Message
Messages
Update message attributes
Delete a message
Clean messages
Send a Message
Return scheduled messages
Return a scheduled message
Cancel a scheduled message
Threads
Return all threads
Return a thread
Update a thread
Delete a thread
Threads
Drafts
Return all Drafts
Create a Draft
Return a Draft
Send a Draft
Drafts
Update a draft
Delete a Draft
Folders
Return all folders
Create a Folder
Return a Folder
Update a folder
Delete a Folder
Folders
Smart compose
Compose a message
Compose a reply
Smart compose
Attachments
Return Attachment metadata
Download an Attachment
Attachments
Transactional send
Send a transactional email
Transactional send
Calendar
Return all calendars
Create a calendar
Return a calendar
Update a calendar
Delete a calendar
Get availability
Get free/busy schedule
Calendar
Events
Return all events
Create an event
Import events
Return an event
Update an event
Delete an event
Send RSVP
Events
Room resources
Return room resource information
Room resources
Contacts
Return all contacts
Create contact
Return a contact
Update a contact
Delete a contact
Return all Contact Groups
Contacts
Configurations
Return all Configuration objects
Create Configuration
Return a Configuration
Update Configuration
Delete a Configuration
Configurations
Sessions
Create a session
Delete a session
Sessions
Bookings
Book an event
Return a booking
Confirm a booking
Reschedule a booking
Delete a booking
Bookings
Availability
Get availability
Availability
Group Events
Get all group events
Create group event
Update a group event
Delete a group event
Import group events
Validate time slot
Group Events
Notetaker
Return all Notetakers
Invite Notetaker to meeting
Return a Notetaker
Update scheduled Notetaker
Delete a Notetaker
Return Notetaker history
Cancel scheduled Notetaker
Remove Notetaker from meeting
Return Notetaker media links
Notetaker
Standalone Notetaker
Return all standalone Notetakers
Invite standalone Notetaker to meeting
Return a standalone Notetaker
Update standalone Notetaker
Delete a standalone Notetaker
Return standalone Notetaker history
Cancel standalone Notetaker
Remove standalone Notetaker from meeting
Return standalone Notetaker media links
Standalone Notetaker
Webhook Notifications
Get destinations for an application
Create a webhook destination
Get the destinations for an application by webhook ID
Update a webhook destination
Delete a webhook destination
Rotate a webhook secret
Get mock notification payload
Send test event
Webhook Notifications
Pub/Sub Notifications
Get Pub/Sub channels for an application
Create a Pub/Sub channel
Get a specific Pub/Sub channel
Update a Pub/Sub channel
Delete a specific Pub/Sub channel
Pub/Sub Notifications
Application-level templates
Return all templates
Create a template
Return a template
Update a template
Delete a template
Render template as HTML
Render a template
Application-level templates
Grant-level templates
Return all templates
Create a template
Return a template
Update a template
Delete a template
Render a template
Render template as HTML
Grant-level templates
Application-level workflows
Return all workflows
Create a workflow
Return a workflow
Update a workflow
Delete a workflow
Application-level workflows
Grant-level workflows
Return all workflows
Create a workflow
Get a workflow
Update a workflow
Delete a workflow
Grant-level workflows
Applications
Get application
Update an application
Get an application's callback URIs
Add callback URI to application
Return a callback URI
Update a callback URI
Delete a callback URI
Applications
Connectors (Integrations)
List connectors
Create a connector
Get connector
Update a connector
Delete a connector
Detect provider
Connectors (Integrations)
Connector credentials
List credentials
Create a credential
Get credential
Update a connector credential
Delete credential
Connector credentials
Manage API keys
Get all API keys
Create API key
Get API key
Delete API key
Manage API keys
Manage Domains
List domains
Create domain
Get domain
Update domain
Delete domain
Get domain info
Verify domain
Manage Domains
Workspaces
Return all workspaces
Create a workspace
Return a workspace
Update a workspace
Delete a workspace
Automatically group grants into workspace
Update workplace assignments
Workspaces
ExtractAI
Get all e-commerce orders
Get all e-commerce shipments
Get all e-commerce returns
ExtractAI
App migration
Link a v2 app to a v3 app
Import v2 app settings to linked v3 app
Migrate v2 account to v3 grant
Batch clone v2 accounts to v3 grants
Get migration jobs
App migration
Data migration
Translate v2 Nylas ID into v3 Provider ID
Data migration
<nylas-scheduler-editor>
<nylas-scheduling>
Component reference
<nylas-additional-participants>
<nylas-availability-picker>
<nylas-booked-event-card>
<nylas-booking-calendar-picker>
<nylas-booking-confirmation-redirect>
<nylas-booking-confirmation-type>
<nylas-booking-form>
<nylas-booking-form-config>
<nylas-buffer-time>
<nylas-calendar-picker>
<nylas-cancel-booking-form>
<nylas-cancellation-policy>
<nylas-cancelled-event-card>
<nylas-confirmation-email>
<nylas-confirmed-event-card>
<nylas-connected-calendars>
<nylas-custom-booking-flow>
<nylas-custom-event-slug>
<nylas-customize-booking-settings>
<nylas-date-component>
<nylas-date-picker>
<nylas-disable-emails>
<nylas-editor-tabs>
<nylas-editor-tabs-group>
<nylas-event-calendar>
<nylas-event-capacity>
<nylas-event-description>
<nylas-event-duration>
<nylas-event-info>
<nylas-event-limits>
<nylas-event-location>
<nylas-event-timeslot>
<nylas-event-title>
<nylas-feedback-form>
<nylas-form-card>
<nylas-limit-future-bookings>
<nylas-list-configurations>
<nylas-locale-switch>
<nylas-logo>
<nylas-min-booking-notice>
<nylas-min-cancellation-notice>
<nylas-notetaker-config>
<nylas-notification>
<nylas-only-specific-time-availability>
<nylas-organizer-confirmation-card>
<nylas-page-name>
<nylas-page-styling>
<nylas-participant-booking-calendars>
<nylas-participants-custom-availability>
<nylas-reminder-emails>
<nylas-reminder-time>
<nylas-scheduling-method>
<nylas-select-event-type>
<nylas-selected-event-card>
<nylas-specific-time-availability-picker>
<nylas-time-window-picker>
<nylas-timeslot-interval>
<nylas-timeslot-picker>
Error codes
Overview
200-299
400-499
500-599
700-799
Use cases
Use cases
Ingest and process
Monitor inbox for tickets
Parse receipts and orders
Send and schedule
Automate meeting follow-ups
Schedule event reminders
Sync and connect
Sync events to a CRM
Log meeting notes to CRM
Build experiences
Scheduling with notetaking
Interview scheduling pipeline
End-to-end automation
Automate sales pipeline
Automate customer onboarding
Browse by industry
CRM
Sales engagement
Recruiting & ATS
Customer support
Scheduling & booking
E-commerce
✨ What's new
What's new in Nylas
Release notes
SDK & tool changelogs
Home
/
…
/
Code with the Nylas SDKs
/
Using the Ruby SDK
/
Test webhooks locally with the Ruby SDK
Test webhooks locally with the Ruby SDK
Copy as Markdown
Curl Markdown
Open in
🚀
More information coming soon!
