Skip to main content

Authorization

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

Customerly

Prerequisites​

To connect Nexla to your Customerly account, you need a Customerly API access token. Customerly uses API key authentication, where your token is transmitted as a Bearer token in the Authentication request header for every API call.

Obtain Your Customerly API Access Token​

  1. Sign in to your Customerly account at app.customerly.io.

  2. Click the Settings icon in the bottom-left sidebar to open the Project Settings.

  3. Navigate to Installation in the settings menu.

  4. Scroll down to the Public API section. Your unique access token is displayed in the field labeled Your Access Token for Customerly.

  5. Copy the token value — you will enter it in the Nexla credential form.

Important

Keep your API access token confidential. Anyone who has access to this token can make API calls on behalf of your Customerly workspace. Do not share it publicly or commit it to source control.

For additional details about the Customerly API access token, refer to the official guide: How to Obtain Your API Access Token in Customerly.

Create a Customerly Credential​

  • To create a new Customerly 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 Customerly API access token in the API Key field. Nexla will include this token as a Bearer token in the Authentication header of all requests sent to the Customerly API (Authentication: Bearer <your_token>).

    This token authenticates Nexla with your Customerly workspace and grants access to all resources available through your account. Nexla stores the token securely and uses it exclusively for API calls made on your behalf.

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.