Skip to main content

Nylas

Nylas is a unified communications API that provides programmatic access to email, calendar, and contacts across providers such as Gmail and Outlook. A single set of endpoints lets you read and write messages, events, and contact records without integrating each provider individually.

Nylas icon

Power end-to-end data operations for your Nylas API with Nexla. Our bi-directional Nylas connector is purpose-built for Nylas, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Nylas or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Nylas workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Nylas credential, you need a Nylas API key and the API base URL for your region. Nylas authenticates requests with an API key passed as a Bearer token in the Authorization header.

To obtain your Nylas credentials, follow these steps:

  1. Sign in to the Nylas Dashboard with your Nylas account. If you do not have an account, sign up for one first.

  2. Select the application you want to connect to Nexla, or create a new application.

  3. Open the API Keys section for that application.

  4. Create a new API key (or copy an existing one), and store the key value securely. The API key grants access to all accounts connected to the application, so treat it as a secret.

  5. Note the base URL for your Nylas region. Nylas hosts data in regional data centers, and requests must be sent to the matching region:

    • United States: https://api.us.nylas.com
    • Europe: https://api.eu.nylas.com

The API key authenticates your server-side requests to the Nylas API and grants full access to all connected accounts, so it should be kept confidential. If your API key is compromised, revoke it in the Nylas Dashboard and generate a new one. For detailed information about API keys, regions, and available endpoints, see the Nylas API Reference.

Authenticate

Credentials required

FieldRequiredSecretDescription
API KeyYesYesAPI key used to authenticate requests to the Nylas API.
Base URLYesNoAPI base URL.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your Nylas API key in the API Key field. This key is sent as a Bearer token in the Authorization header for all API requests and must be kept confidential.

  4. Enter your Nylas region base URL in the Base URL field (for example, https://api.us.nylas.com for the US region or https://api.eu.nylas.com for the EU region). This must match the region where your Nylas application data is hosted.

    If your API key is compromised, revoke it in the Nylas Dashboard and generate a new one. The API key grants full access to all accounts connected to your Nylas application and should be treated as sensitive information.

    For detailed information about authentication, regions, and available endpoints, see the Nylas API Reference.

  5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Nylas connector tile, then select the credential that will be used to connect to Nylas, and click Next; or, create a new Nylas credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Nylas endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Contact Groups

This endpoint template retrieves contact groups. Use this template when you need to access contact group information for analysis, reporting, or integration purposes.

For detailed information about response structures, pagination, and available fields, see the Nylas API Reference.

[Rest API] List Contacts

This endpoint template retrieves contacts. Use this template when you need to access contact information for analysis, reporting, or integration purposes.

For detailed information about response structures, pagination, and available fields, see the Nylas API Reference.

[Rest API] List Calendars

This endpoint template retrieves calendars. Use this template when you need to access calendar information for analysis, reporting, or integration purposes.

For detailed information about response structures, pagination, and available fields, see the Nylas API Reference.

[Rest API] List Connectors

This endpoint template retrieves connectors. Use this template when you need to access connector information for analysis, reporting, or integration purposes.

For detailed information about response structures, pagination, and available fields, see the Nylas API Reference.

[Rest API] List Credentials

This endpoint template retrieves credentials. Use this template when you need to access credential information for analysis, reporting, or integration purposes.

For detailed information about response structures, pagination, and available fields, see the Nylas API Reference.

[Rest API] List Drafts

This endpoint template retrieves drafts. Use this template when you need to access draft message information for analysis, reporting, or integration purposes.

For detailed information about response structures, pagination, and available fields, see the Nylas API Reference.

[Rest API] List Events

This endpoint template retrieves events. Use this template when you need to access calendar event information for analysis, reporting, or integration purposes.

For detailed information about response structures, pagination, and available fields, see the Nylas API Reference.

[Rest API] List Folders

This endpoint template retrieves folders. Use this template when you need to access mailbox folder information for analysis, reporting, or integration purposes.

For detailed information about response structures, pagination, and available fields, see the Nylas API Reference.

[Rest API] List Grants

This endpoint template retrieves grants. Use this template when you need to access grant information for the accounts connected to your Nylas application.

For detailed information about response structures, pagination, and available fields, see the Nylas API Reference.

[Rest API] List Messages

This endpoint template retrieves messages. Use this template when you need to access email message information for analysis, reporting, or integration purposes.

For detailed information about response structures, pagination, and available fields, see the Nylas API Reference.

[Rest API] List Scheduled Messages

This endpoint template retrieves scheduled messages. Use this template when you need to access information about messages scheduled for future delivery.

For detailed information about response structures, pagination, and available fields, see the Nylas API Reference.

[Rest API] List Threads

This endpoint template retrieves threads. Use this template when you need to access email thread information for analysis, reporting, or integration purposes.

For detailed information about response structures, pagination, and available fields, see the Nylas API Reference.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Nylas data sources can also be manually configured to ingest data from any valid Nylas API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Nylas data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Nylas destination, and select the Send to Destination option from the menu. Select the Nylas connector from the list of available destination connectors, then select the credential that will be used to connect to Nylas, and click Next; or, create a new Nylas credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Nylas endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create Draft

This endpoint template creates a draft message that has not yet been sent, in a grant's mailbox. Use this template when you need to stage email drafts from records in a Nexset.

Each record from your Nexset is sent as a separate API request. The request body must match the format required by the Nylas API. For detailed information about request body formats and available fields, see the Nylas API Reference.

[Rest API] Send Message

This endpoint template sends an email message immediately or schedules it for future delivery from a grant's mailbox. Use this template when you need to send messages from records in a Nexset.

Each record from your Nexset is sent as a separate API request. The request body must match the format required by the Nylas API. For detailed information about request body formats and available fields, see the Nylas API Reference.

[Rest API] Create Event

This endpoint template creates a calendar event using unified commands across supported providers. Use this template when you need to create calendar events from records in a Nexset.

Each record from your Nexset is sent as a separate API request. The request body must match the format required by the Nylas API. For detailed information about request body formats and available fields, see the Nylas API Reference.

[Rest API] Create Contact

This endpoint template creates a new contact in a grant's address book. Use this template when you need to create contact records from a Nexset.

Each record from your Nexset is sent as a separate API request. The request body must match the format required by the Nylas API. For detailed information about request body formats and available fields, see the Nylas API Reference.

Manual configuration

Nylas destinations can also be manually configured to send data to any valid Nylas API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Nylas APIs typically expect JSON format for write operations. For update operations, include the ID of the object to be updated in the request URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Nylas endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Nylas endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.