👋 Welcome to Nylas! This is a guide for helping you get started with using the Nylas API and integrating it with your application. It's packed with best practices and other important tips that will make your integration a breeze.
This guide is currently a work in progress. If you're confused about anything or something is missing, please reach out to us and we can chat!
Important info below!
To make sure your integration goes as smoothly as possible we recommend reading through each of the linked guides below. If you ever have any questions feel free to contact our support team.
To learn about how Nylas works behind the scenes check out our How Nylas Works guide. In this guide we'll cover our API and Sync architecture, data storage policies, and what you can expect from our API performance wise.
Before you can start testing out our API you'll need to create a developer account to get your API keys. Check out this guide to get started.
Need to find emails shared between accounts? What about the best way to send event invites to participants automatically? Check out various examples of common use cases and the best way to approach these challenges in this guide.
There are a couple of ways you can authenticate email accounts to Nylas. In this guide, we'll cover what your options are, as well as some very important information on how you should manage Nylas
access_tokens and some other common authentication issues your application should be ready to handle.
Should you sync mail data using Deltas, Webhooks, or Polling? Check out this guide for tradeoffs around the various ways you can pull mail data into your application. We also include important gotchas about initial sync for accounts.
To build a robust integration with any API you'll need to have solid error handling, rate limiting, and retry policies in place. Check out this guide to make sure you're following industry best practices so that your application is production ready.
To learn about how Nylas determines your monthly usage, how you can manage your paid accounts, and how you can see the health of your paid accounts, check out Accounts and Billing guide.
We officially support and maintain three SDKs to help integration with the Nylas APIs:
There are also unofficial SDKs as well that we do not provide support for and are maintained by our community:
If you ever feel stuck or run into a tricky issue please let us know - we're here to help. Here's our guide on the best way to reach out to our support team.
- EU Privacy Shield