Skip to content
Docs
Create account
or
Sign In
Create account
Sign In
Getting Started
Overview
API Quickstart
Webhook Quickstart
AI prompts
Notetaker Quickstart
Scheduler Quickstart
Try more APIs
Dev guide
Developer guide
Developing with Nylas
Platform
Overview
What is nyl.as?
Reporting abuse
Data residency
Change data residency region
Rate limits
Nylas static IPs
Nylas domain certificates
File attachment media types
Dashboard
Searching with Nylas
Branding and white-labeling
Error handling
Production checklist
Best practices
Security best practices
Improve email deliverability
Avoiding rate limits
Dealing with spam
Best practices for webhooks
Provider guides
Overview
Google
Use Google accounts & data
Create a Google auth app
Set up service accounts
Set up Pub/Sub
Verification & security assessment
Microsoft
Overview
Create Azure auth app
Microsoft verification guide
Microsoft authentication
Configure admin approval
Suggested Microsoft 365 settings
Troubleshoot Microsoft authentication
Gather Exchange logs
IMAP providers
Overview
Troubleshoot UIDVALIDITY
Passwords & character encoding
Exchange on-prem authentication
iCloud authentication
Yahoo authentication
Zoom Meetings
Authenticating with Zoom Meetings
Troubleshooting Zoom Meetings
App passwords
Supported providers
Metadata
Versioning
Nylas Glossary
API references
API reference docs
Administration APIs ↗
Email, Calendar, & Contacts APIs ↗
Scheduler APIs ↗
Postman collection
Error codes
Overview
200-299
400-499
500-599
700-799
Auth
Auth and Nylas
Create grants with OAuth & API key
Create grants with OAuth & access token
Configure OAuth login prompt
Create grants with Custom auth
Create grants with IMAP auth
Manage grants
Bulk auth grants & Service Accounts
Authentication scopes
Email
Using the Email API
Using the Threads API
Send messages
Schedule messages
Sending errors
Track messages
Working with folders
Attachments & files
Email headers & MIME data
Smart Compose
Clean Conversation
Email scopes
ExtractAI
Using ExtractAI
Using the Order Consolidation API
ExtractAI & Order Consolidation scopes
Merchants & vendors
Calendar
Using the Calendar API
Using the Events API
Using virtual calendars
Check availability
Check free/busy information
Group availability & booking
Add conferencing to events
Recurring events
Calendar & Events scopes
Scheduler
Using Scheduler
Using the Scheduler Editor Component
Using the Scheduling Component
Hosted Scheduling Pages
Customize Scheduler
Scheduler localization
Customize booking flows
Add conferencing to bookings
Set up collective meetings
Set up group meetings
Set up round-robin meetings
Retrieve booking IDs
Redirect v2 Scheduling Pages
Scheduler UI Components ↗
Scheduler scopes
Notetaker
Using Notetaker
Calendar sync
Contacts
Using the Contacts API
Contacts scopes
Notifications
Using webhooks
Using a Pub/Sub channel
Notification scopes
Notification schemas
SDKs
Node.js SDK
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
Python SDK
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
Ruby SDK
Overview
Read messages and threads with Ruby
Send messages with Ruby
Manage contacts with Ruby
Kotlin SDK
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
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
GDPR overview & inquiries
Product lifecycle
What's new
New in Nylas
Product release notes
SDK & tool changelogs
Getting Started
Overview
API Quickstart
Webhook Quickstart
AI prompts
Notetaker Quickstart
Scheduler Quickstart
Try more APIs
Dev guide
Developer guide
Developing with Nylas
Platform
Overview
What is nyl.as?
Reporting abuse
Data residency
Change data residency region
Rate limits
Nylas static IPs
Nylas domain certificates
File attachment media types
Dashboard
Searching with Nylas
Branding and white-labeling
Error handling
Production checklist
Best practices
Security best practices
Improve email deliverability
Avoiding rate limits
Dealing with spam
Best practices for webhooks
Provider guides
Overview
Google
Use Google accounts & data
Create a Google auth app
Set up service accounts
Set up Pub/Sub
Verification & security assessment
Microsoft
Overview
Create Azure auth app
Microsoft verification guide
Microsoft authentication
Configure admin approval
Suggested Microsoft 365 settings
Troubleshoot Microsoft authentication
Gather Exchange logs
IMAP providers
Overview
Troubleshoot UIDVALIDITY
Passwords & character encoding
Exchange on-prem authentication
iCloud authentication
Yahoo authentication
Zoom Meetings
Authenticating with Zoom Meetings
Troubleshooting Zoom Meetings
App passwords
Supported providers
Metadata
Versioning
Nylas Glossary
API references
API reference docs
Administration APIs ↗
Email, Calendar, & Contacts APIs ↗
Scheduler APIs ↗
Postman collection
Error codes
Overview
200-299
400-499
500-599
700-799
Auth
Auth and Nylas
Create grants with OAuth & API key
Create grants with OAuth & access token
Configure OAuth login prompt
Create grants with Custom auth
Create grants with IMAP auth
Manage grants
Bulk auth grants & Service Accounts
Authentication scopes
Email
Using the Email API
Using the Threads API
Send messages
Schedule messages
Sending errors
Track messages
Working with folders
Attachments & files
Email headers & MIME data
Smart Compose
Clean Conversation
Email scopes
ExtractAI
Using ExtractAI
Using the Order Consolidation API
ExtractAI & Order Consolidation scopes
Merchants & vendors
Calendar
Using the Calendar API
Using the Events API
Using virtual calendars
Check availability
Check free/busy information
Group availability & booking
Add conferencing to events
Recurring events
Calendar & Events scopes
Scheduler
Using Scheduler
Using the Scheduler Editor Component
Using the Scheduling Component
Hosted Scheduling Pages
Customize Scheduler
Scheduler localization
Customize booking flows
Add conferencing to bookings
Set up collective meetings
Set up group meetings
Set up round-robin meetings
Retrieve booking IDs
Redirect v2 Scheduling Pages
Scheduler UI Components ↗
Scheduler scopes
Notetaker
Using Notetaker
Calendar sync
Contacts
Using the Contacts API
Contacts scopes
Notifications
Using webhooks
Using a Pub/Sub channel
Notification scopes
Notification schemas
SDKs
Node.js SDK
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
Python SDK
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
Ruby SDK
Overview
Read messages and threads with Ruby
Send messages with Ruby
Manage contacts with Ruby
Kotlin SDK
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
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
GDPR overview & inquiries
Product lifecycle
What's new
New in Nylas
Product release notes
SDK & tool changelogs
Home
/
…
/
Using the Ruby SDK
/
Test webhooks locally with the Ruby SDK
Test webhooks locally with the Ruby SDK
🚀
More information coming soon!
