Skip to main content

Authorization

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

Freshchat

Prerequisites​

Freshchat uses API token (Bearer) authentication for all API requests. Before creating a Freshchat credential in Nexla, you must generate an API token from your Freshchat account and note your account's subdomain.

Generate a Freshchat API Token​

Only a Freshchat account administrator can generate or regenerate API tokens. Note that Freshchat allows only one active API token at a time — generating a new token invalidates any previously issued token.

  1. Sign in to your Freshchat account at https://{your-subdomain}.freshchat.com using administrator credentials.

  2. Click the Admin Settings gear icon in the left sidebar to open the administration panel.

  3. Navigate to Settings > Website Tracking and APIs (in some account versions, this appears as Configure > API Tokens).

  4. Locate the API Token section. If a token has already been generated, it will be displayed here. To generate a new token, click Generate Token.

Important

Generating a new API token immediately invalidates any previously issued token. Existing integrations using the old token will stop working. Update all connected systems with the new token before proceeding.

  1. Copy the token displayed in the Your API Key field. Store this value securely — it is equivalent to a password and grants full access to your Freshchat account data via the API.

Identify Your Freshchat Account Subdomain​

The Freshchat REST API base URL is https://{account-subdomain}.freshchat.com/v2. Your account subdomain is the portion of your Freshchat URL before .freshchat.com.

For example, if your Freshchat account URL is https://acme.freshchat.com, your subdomain is acme.

For complete information about Freshchat API authentication and token management, refer to the Freshchat Developer Documentation and the Freshchat API Tokens support article.

Create a Freshchat Credential​

  • To create a new Freshchat 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 Token Authentication​

Freshchat authenticates API requests using a Bearer token sent in the Authorization request header. All API calls to the Freshchat v2 API must include this token.

  1. Enter your Freshchat API token in the API Token field. This is the token generated in your Freshchat Admin Settings. It will be transmitted as a Bearer token in the Authorization header of every API request Nexla makes to your Freshchat account.

  2. Enter your Freshchat account subdomain in the Account Subdomain field (or Domain field, depending on your Nexla version). Enter only the subdomain portion — for example, acme if your Freshchat URL is https://acme.freshchat.com. Nexla uses this value to construct the API base URL https://{subdomain}.freshchat.com/v2 for all requests.

    Do not include the protocol (https://) or the .freshchat.com domain suffix in the subdomain field. Enter only the subdomain identifier, such as acme or mycompany.

Important

Keep your API token secure and never share it publicly. The Freshchat API token grants access to all conversation, contact, and agent data in your account. Treat it with the same care as a password.

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.