# Freshdesk

## Overview

The Freshdesk Integration enables seamless synchronization between your platform and Freshdesk, allowing efficient management of customer support tickets, CRM data, and content workflows. By leveraging this integration, organizations can centralize operations, improve visibility into customer interactions, and enhance overall service efficiency across **Helpdesk**, **CRM**, and **Content Management** capabilities.

### Prerequisites

Ensure the following requirements are fulfilled before initiating the integration:

* An active **Freshdesk Admin account** with appropriate permissions.
* Valid **Freshdesk domain URL** and API token.
* Access to **TheLoops** platform with **Admin role** privileges.

### Capability notes

* **Helpdesk:** Requires full configuration using the API token for authentication.
* **CRM & Content Management:** Configuration remains the same as Helpdesk.
  * The only difference is selecting **CRM** or **Content Management** as the capability in the **Configuration** tab based on the requirement.

### Best practices

* **Secure API Token Management:**\
  Store and manage the Freshdesk API token securely. Avoid sharing it across unauthorized users or systems.
* **Ensure Correct Token Usage:**\
  Always use a valid and active API token generated from the Freshdesk Admin account to prevent authentication failures.
* **Regularly Validate Integration:**\
  Periodically perform a **Test Connection** to ensure the integration remains active and functional.
* **Monitor Access Permissions:**\
  Ensure the Freshdesk account associated with the API token has sufficient permissions to access required data.
* **Maintain Token Lifecycle:**\
  If the API token is regenerated or updated in Freshdesk, ensure it is also updated in the integration to avoid service disruptions.

## Setup instructions <a href="#setup-instructions" id="setup-instructions"></a>

### Initiate Integration <a href="#step-1-initiate-integration" id="step-1-initiate-integration"></a>

{% stepper %}
{% step %}
Log in to TheLoops platform using an **Admin** account.
{% endstep %}

{% step %}
Navigate to **Settings → Integrations** module.
{% endstep %}

{% step %}
Click on the **“+ Add Integration”** button to view available integrations.
{% endstep %}

{% step %}
Search for **Freshdesk** and open the integration setup.
{% endstep %}
{% endstepper %}

### Configuration

{% stepper %}
{% step %}
In the **Configuration** tab, enter a suitable name for the integration.
{% endstep %}

{% step %}
Select the required **Capability** based on your use case:

* **Helpdesk**
* **CRM**
* **Content Management**
  {% endstep %}

{% step %}
Click **Next** to proceed.
{% endstep %}
{% endstepper %}

### Authentication <a href="#authentication-setup" id="authentication-setup"></a>

{% stepper %}
{% step %}
You will be redirected to the **Authentication** tab.
{% endstep %}

{% step %}
Enter your **Freshdesk API Token** in the designated field.
{% endstep %}

{% step %}
Enter your **Freshdesk Domain URL** in the Domain URL field, and click on **Connect** Button.
{% endstep %}
{% endstepper %}

### Validation & verification <a href="#validation-and-verification" id="validation-and-verification"></a>

{% stepper %}
{% step %}
Upon entering the valid token and domain URL:

1. The integration will be added successfully.
2. A confirmation (success message) will be displayed.
   {% endstep %}

{% step %}
Navigate back to the **Integrations** tab and verify that the newly added integration appears at the top of the list.
{% endstep %}

{% step %}
Click on the **Test Connection** icon (next to the delete option):

* If successful, a confirmation message will appear.
* This confirms that the integration is configured correctly.
  {% endstep %}
  {% endstepper %}

## Webhook Setup <a href="#webhook-setup-freshdesk" id="webhook-setup-freshdesk"></a>

### Overview

Webhooks in Freshdesk enable real-time synchronization of ticket events between Freshdesk and the platform. They ensure that ticket **creation** and **updates** are instantly reflected, improving data accuracy and eliminating delays associated with periodic data syncing. **TheLoops** platform automatically creates the required webhooks via backend APIs during integration setup; however, verification is recommended to ensure proper configuration.

### Verification Steps <a href="#verification-steps" id="verification-steps"></a>

{% stepper %}
{% step %}
Log in to your Freshdesk domain using **Admin credentials**.
{% endstep %}

{% step %}
Click on the **three dots (⋯)** in the left-side panel and select **Admin**.
{% endstep %}

{% step %}
Navigate to the **Workflows** section.
{% endstep %}

{% step %}
Open the **Automations** tab.
{% endstep %}

{% step %}
Under Automations, verify that two webhook-based events are created for your organization:

1. Ticket Creation
2. Ticket Updates
   {% endstep %}

{% step %}
Open each event (Ticket Creation / Ticket Updates) and verify the following:

* The **Webhook URL** is configured.
  {% endstep %}

{% step %}
The same webhook URL is present in the integration’s **Configuration tab** within **TheLoops** platform.
{% endstep %}

{% step %}
If both events exist with the correct webhook URL, it confirms that the webhook is successfully created and configured for real-time synchronization.
{% endstep %}
{% endstepper %}

## API Key Management & Update Process <a href="#api-key-management-and-update-process" id="api-key-management-and-update-process"></a>

### Overview <a href="#overview.2" id="overview.2"></a>

Unlike OAuth-based integrations, the Freshdesk connector uses an **API Key (Token-based authentication)**. If the API key is manually reset in Freshdesk, the existing integration will stop working, and the **Test Connection** will fail. In such cases, the updated API key must be reconfigured in the integration to restore connectivity.

### Steps to Update API Key <a href="#steps-to-update-api-key" id="steps-to-update-api-key"></a>

{% stepper %}
{% step %}
Log in to your Freshdesk domain using **Admin credentials**.
{% endstep %}

{% step %}
Navigate to your **Profile** (top-right corner).
{% endstep %}

{% step %}
Click on **Profile Settings**.
{% endstep %}

{% step %}
Locate and click on **View API Key** to retrieve the new API key.
{% endstep %}

{% step %}
Go to the platform → **Settings → Integrations** module.
{% endstep %}

{% step %}
Locate the relevant Freshdesk integration check the **Test Connection** before updating the **Token,** It will show the failed error message.
{% endstep %}

{% step %}
Click on the **Edit** icon (beside the delete icon) to update the token.
{% endstep %}

{% step %}
Navigate to the **Authentication** tab.
{% endstep %}

{% step %}
Enter the new API key in the **Token** field and click on **Update**.
{% endstep %}

{% step %}
A success message will confirm that the API key has been updated.
{% endstep %}

{% step %}
Return to the **Integrations** list and click on **Test Connection**:

1. A successful response confirms that the API key update is completed and the integration is functioning correctly.
   {% endstep %}
   {% endstepper %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://kb.theloops.io/cxplatform/ifs-loops-cx-platform/integrations/freshdesk.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.