Skip to main content

Authorization

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

Freshdesk

Prerequisites​

Freshdesk authenticates API requests using HTTP Basic Auth, where your personal API key serves as the username. Before creating a Freshdesk credential in Nexla, gather the following:

  • A Freshdesk account on the Growth plan or higher (API access is not available on the free Sprout plan).

  • Your Freshdesk subdomain. This is the prefix in your Freshdesk account URL — for example, if you access Freshdesk at https://acme.freshdesk.com, your subdomain is acme.

Locate Your Freshdesk API Key​

Each agent on a Freshdesk account has a unique personal API key. To find yours:

  1. Log in to your Freshdesk account at https://yourdomain.freshdesk.com.

  2. Click your profile picture or avatar in the upper-right corner of the page to open the account menu.

  3. Select Profile Settings from the dropdown menu.

  4. On the Profile Settings page, locate the Your API Key section in the right-hand panel.

  5. Click View API Key and complete the CAPTCHA verification when prompted.

  6. Copy the displayed API key. Store it in a secure location such as a password manager, because Freshdesk does not display the key again without re-authenticating.

Each Freshdesk agent has their own unique API key. The key inherits the permissions of the agent whose profile it belongs to. For Nexla integrations that need to read or write across all tickets and contacts, use the API key of an account administrator.

Important

Resetting your Freshdesk API key immediately revokes access for all applications currently using that key, including any existing Nexla integrations. Rotate keys only when necessary, and update all dependent credentials promptly.

For additional details, see the Freshdesk API key documentation.

Create a Freshdesk Credential​

  • To create a new Freshdesk 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.

Authentication Settings​

Freshdesk uses HTTP Basic Auth. Your API key is provided as the username, and any non-empty string is used as the password — Freshdesk ignores the password value entirely when API key authentication is used.

  1. Enter your Freshdesk subdomain in the Domain field. This is the portion of your Freshdesk account URL that precedes .freshdesk.com — for example, enter acme for an account URL of https://acme.freshdesk.com.

    Nexla uses your subdomain to construct the Freshdesk API base URL in the format https://{'{domain}'}.freshdesk.com/api/v2. Entering the full URL instead of just the subdomain will cause connection failures.

  2. Enter your Freshdesk API key in the API Key field. This is the key you retrieved from your Freshdesk Profile Settings page. The API key authenticates all requests Nexla makes to the Freshdesk API 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.