Nylas v3 Dashboard overview
The v3 Nylas Dashboard is a web app where you can create and manage Nylas applications. In v3, applications are the collections of authentication configurations, user grants, and other settings that connect to the project or application code you're developing.
📝 Note: The v2 Dashboard cannot create v3-compatible Nylas applications, and the v3 Dashboard cannot manage v2 Nylas applications.
When you first sign up for Nylas using the v3 Dashboard, you're prompted to verify your email address. After you verify it, you can log in to the Dashboard, and create and manage Nylas applications.
The v3 Nylas Dashboard is comprised of several pages that allow you to manage your Nylas applications and their configuration settings, including authentication and end user grants. The following sections describe some of the pages you'll work with often.
The Dashboard Overview page gives you a quick look at the health and completion status of your Nylas project. When you first create an application, the Dashboard displays a helpful production checklist to get you started.
API keys are new in Nylas v3. They allow you to access all objects associated with an application without a lot of effort managing user token lifecycles. For more information, see Authentication and Nylas.
The API Keys page displays a list of your application's API keys, and shows if they're active or if they've been revoked. You can also create and revoke API keys from this page, and edit existing keys to change their labels and expiration dates.
When you generate an API key, you can set its expiration date. You can choose from one of several default options, or set a custom date. For security purposes, Nylas recommends you do not set the expiration date more than a year in the future for API keys associated with production Nylas applications.
⚠️ The Nylas Dashboard displays a new API key's secret only once. Make sure you store it in a secure place, like a secrets manager. If you lose an API key's secret, you cannot use the key and you must generate a new API key.
The Hosted Authentication page is where you manage branding settings and callback URIs (sometimes called "redirect URIs") for your Nylas applications.
Callback URIs set the path where the authentication provider (for example, Google or Microsoft) directs an end user after an auth attempt. These are used for Hosted auth requests only, and you must have at least one callback URI configured to complete the Hosted auth flow. Callback URIs must use HTTPS, unless you're using
localhost for development.
You can specify different callback URIs for each Nylas application based on its environment tag (for example, you can have a different callback URI for production than the one for development). You can also specify different URIs for each platform, so you can give your end users a more tailored experience.
In Nylas v3, grants represent end users who have granted your application specific access to their email account data.
From the Grants page, you can view the status of your end users' grants, see their details, and revoke them if needed. You can use this page to help diagnose end user problems and troubleshoot permissions issues. You can also create a test grant, which allows you to test your authentication configuration settings. You'll still need to have a correctly configured connector before you can authenticate a test account to create a grant.
For more information about grants and how to manage them, see Managing grants.
Connectors (previously called "integrations") store data that your Nylas application uses to communicate with other systems or services, like Google or Microsoft authentication flows. In Nylas v3, all authentication, including Custom auth (previously called "Native auth") requires a connector to store these details.
🚀 You can create connectors for Google, Microsoft, Yahoo OAuth, and IMAP providers in Nylas v3. More connectors are coming soon.
Webhooks enable you to get alerts from Nylas about activity in your application, including account changes and updates to end users' data on the provider. A Nylas webhook has two parts: the webhook endpoint (sometimes called a "destination" or "callback URL"), and the list of triggers that you can 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, and Nylas sends
POST data payloads when the conditions for the triggers are met.
💡 At minimum, Nylas recommends you subscribe to
grant.* webhook triggers. They're critical for finding out when end users authenticate with your application, and for getting notified of auth issues.
A small group of end users can generate tens of thousands of webhook notifications in just a few hours. Nylas recommends you build your receiving infrastructure for asynchronous processing, and consider creating different webhook endpoints to handle triggers that you expect to have a high volume of traffic. For more information, see the Webhooks documentation and Webhooks best practices guide.
🔍 If you're new to Nylas and on the free tier, you might only be able to create a Sandbox application. If you want to create an application that you can move to production, check out the Nylas subscription options to find the plan that's right for you.
Follow these steps to create a Nylas application in the v3 Dashboard:
- Log in to the Dashboard and click Create new application.
- Enter the application's name and an optional description. You can also choose one of the environment identifiers:
- (Optional) Choose a data residency location. These settings change where your application and end user data is stored. For GDPR compliance purposes, all organization and Dashboard-user information is stored in the Nylas E.U. data center.
- You cannot change an existing Nylas application's data residency location.
- Click Create app.
The v3 Nylas Dashboard offers two users roles which grant different levels of access to the Dashboard and its contents:
- Member: Allows access to development, staging, and sandbox applications only. Members can view the organization membership list, but cannot change or invite new users.
- Admin: Allows access to see and edit all applications, regardless of their environment tag, and to view and modifiy the organization membership list, including changing users' roles and inviting new users.
Roles are set per organization, and apply to all applications that belong to an organization.