Dashboard v3
The Nylas API v3 is in public beta. It might contain bugs, and might change before it is generally available. See the v3 Beta documentation for more information.
When you first sign up for Nylas using the v3 Dashboard, you are prompted to verify your email address. After you verify it, you can log in and create and manage Nylas applications.
The Nylas v3 Dashboard is where you create and manage Nylas applications, which are the collection of authentication configurations, user Grants, and other settings that connect to the project or application code you are working on.
Note: The v2 Dashboard cannot create v3-compatible Nylas applications, and the v3 Dashboard cannot manage v2 Nylas applications.
To create a new application, click Create new app. Enter an application name and an optional description. You can also choose one of the environment identifiers: development, staging, or production.
You can choose to enable authentication testing for your application from the Dashboard. This option lets you create and test user Grants from the Dashboard without having to make API calls from your code project. This is helpful for testing authentication systems, but should not be enabled for Production applications.
Overview
The Dashboard Overview page gives you a quick view into the health and status of your Nylas project. When you first create an application, the Dashboard displays a helpful production checklist to get you started.
Manage API keys
API keys are new to Nylas in v3, and allow you to access all of an application's objects without a lot of effort managing user token lifecycles. See Authentication in API v3 for more details.
The API Keys page allows you to create and revoke API keys for the application, and view if they are active or have been revoked. When you generate a new API key, the Dashboard displays the key's secret only once. Make sure you store it in a secure place like a secrets manager.
If you lose the API key secret, you cannot use the key. If this happens, you must generate a new API key.
When you generate a new API key, you can set an expiration date. You can choose from one of several default options, or set a custom expiry date. For security purposes, you should not set the expiry date more than a year in the future for API keys for production Nylas applications.
You can also edit existing keys to change their labels and expiration dates. You cannot view the API key secrets for existing keys.
Authentication redirect URIs
Authentication URIs set the path where the authentication provider (for example, Google or Microsoft) directs a user after an authentication attempt. You must have at least one redirect URI configured to complete authentication successfully.
You can specify different URIs for each authentication provider to give your end users a more tailored experience.
Managing Grants
Grants represent users who have granted your application specific access to their data.
From the Grants page, you can view the status of Grants, view their details, and revoke them if needed. Use this page to help diagnose end-user problems and troubleshoot permissions issues.
Integrations
Integrations are connectors between your Nylas application and other systems and services (for example, Google or Microsoft authentication). In v3, all authentication, including Native authentication (bring-your-own authentication), must create an Integration to store the connection details.
In the Nylas v3 Beta, you can create integrations with Google, Microsoft, and IMAP providers. More integrations are coming soon.
Webhooks
Webhooks are how you get alerts from Nylas about activity in your app, including user account changes and changes to user data on the provider. A webhook has two parts in Nylas: the webhook endpoint (sometimes called a destination or callback URL), and the list of triggers to subscribe to.
The webhook endpoint is a socket on your application or infrastructure that receives POST data from the Nylas servers. You can subscribe a webhook endpoint to specific triggers. Nylas sends these POST data payloads when the conditions for these triggers are met.
A small group of users can generate tens of thousands of webhook notifications in a few hours, so you should build your receiving infrastructure for asynchronous processing, and consider creating different webhook endpoints to handle webhooks that you expect to have a high volume of traffic. See the Webhooks developer guide and Webhooks best practices page for more information.
Tip: At minimum, you should subscribe to the Grant webhooks, as they are critical for finding out when new users authenticate with your application, and for getting notified of user authentication issues.