Skip to main content

Authorization

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

ClientSuccess

Prerequisites​

Before creating a ClientSuccess credential in Nexla, ensure that you have the following:

A ClientSuccess Account with API Access​

Access to the ClientSuccess API requires an active ClientSuccess account with permission to manage API keys. API access is configured from the ClientSuccess application settings, so you must be able to sign in to your ClientSuccess instance with sufficient permissions.

ClientSuccess recommends creating a dedicated user account named API Access to be used exclusively for API integrations. Using a dedicated account isolates integration activity from individual user accounts, making API usage easier to audit and manage. When naming this account, include "API Access" in the name so that it is not counted as a billable user seat.

A ClientSuccess API Key​

Authentication to the ClientSuccess API is performed using an API key, which Nexla sends in the X-API-Key request header on every call. Generate your API key from within the ClientSuccess application:

  1. Sign in to your ClientSuccess instance.

  2. Navigate to the Settings area and open the API Keys section.

  3. Create a new API key, and provide a descriptive name that identifies its intended use (for example, "Nexla Integration").

  4. Copy the generated API key value and store it securely.

    Important

    Copy and securely store your API key immediately after generating it. Treat the key like a password—it grants programmatic access to your ClientSuccess data, and it may not be retrievable in full after the initial creation.

Your ClientSuccess API Base URL​

ClientSuccess API requests are issued against a base URL for your environment. The default base URL is https://api.clientsuccess.com/api. Some accounts use an instance-specific host in the form https://your-company.clientsuccess.com/api. Confirm the correct base URL for your account before configuring the credential.

For complete information about the ClientSuccess API, refer to the official ClientSuccess API documentation.

Create a ClientSuccess Credential​

  • To create a new ClientSuccess 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 provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Authentication Settings​

ClientSuccess uses API key authentication. Enter the connection details that Nexla will use to authenticate with the ClientSuccess API.

  1. Enter your ClientSuccess API base URL in the API Base URL field. This is the root URL against which all API requests are made. The default value is https://api.clientsuccess.com/api. If your account uses an instance-specific host, enter it in the form https://your-company.clientsuccess.com/api.

  2. Enter your ClientSuccess API key in the API Key field. Nexla sends this value in the X-API-Key header to authenticate each request. This value is stored securely and should be kept confidential.

    Nexla validates the credential against the ClientSuccess health endpoint when you save it. A successful validation confirms that the base URL and API key are correct and that Nexla can reach your ClientSuccess account.

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.