Skip to main content

Authorization

Follow this guide to create a new Insightly credential that will allow Nexla to authenticate to and exchange data with your Insightly account.
insightly_api_auth.png

Insightly

Prerequisites​

To connect Nexla to Insightly, you need an active Insightly account. Each Insightly user has a personal API key that uniquely identifies them when making API requests. By default, all users in an Insightly account have API access, though account administrators can enable or disable API access on a per-user basis.

Find Your Insightly API Key​

Insightly authenticates API requests using HTTP Basic Authentication, with your personal API key used as the username and the password left blank. Follow these steps to locate your API key in Insightly:

  1. Sign in to your Insightly account at app.insightly.com.

  2. Click your profile icon or your name in the top-right corner of the dashboard to open the user menu.

  3. Select User Settings from the dropdown menu.

  4. On the User Settings page, scroll down to the API section. Your API key is displayed here and is already generated for you. You will also see your API URL (for example, https://api.na1.insightly.com/v3.1), which indicates which regional pod your Insightly account uses.

  5. Click the Copy button next to your API key to copy it to your clipboard.

Your API key is unique to your Insightly user account. Each person who accesses the Insightly API needs their own API key. For complete information about Insightly's API and authentication, visit the Insightly API v3.1 documentation.

Keep Your API Key Secure

Your Insightly API key provides access to your CRM data with the same permissions as your user account. Treat it like a password — do not share it in publicly accessible places such as source code repositories, client-side code, or unencrypted configuration files. If your API key is compromised, you can generate a new one from the same User Settings page.

Identify Your API Pod URL​

Insightly hosts its API across several regional data centers (called "pods"). The correct API base URL depends on where your Insightly account data is hosted. Your pod URL is shown directly beneath your API key in the API section of your User Settings page.

Common pod URLs include:

  • https://api.na1.insightly.com/v3.1 — North America (Pod 1)
  • https://api.na2.insightly.com/v3.1 — North America (Pod 2)
  • https://api.au1.insightly.com/v3.1 — Australia
  • https://api.eu1.insightly.com/v3.1 — Europe

You will need this base URL when manually configuring data source or destination endpoints in Nexla. All Insightly API endpoint URLs are formed by appending the resource path to this base URL (for example, https://api.na1.insightly.com/v3.1/Contacts).

API Access Permissions​

By default, all Insightly users have API access enabled. If you are unable to find an API key in your User Settings, your account's administrator may have restricted API access for your user. Administrators can manage API access per user by navigating to System Settings > Users and editing the user's profile.

Create an Insightly Credential​

  • To create a new Insightly credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

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

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key​

  1. Enter your Insightly API key in the API Key field (also labeled Username depending on the credential form). This key authenticates Nexla's requests to the Insightly API and should be kept secure.

    Insightly uses HTTP Basic Authentication. Your API key serves as the username in Basic Auth requests, and the password is left blank. Nexla sends the API key in the Authorization HTTP header for all requests to the Insightly API, encoded as a Base64 Basic Auth credential.

    The password field should be left blank. Insightly's API uses only the API key as the credential — no password is required. If the credential form includes a password field, leave it empty.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.