> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Freshdesk App

> Install the official Freshdesk app to create or update Freshdesk contacts for your Dodo Payments customers and create a ticket for each opened dispute.

## What the Freshdesk app does

The Freshdesk app creates or updates a Freshdesk contact for each customer. It also creates a ticket for each dispute that opens. The app sets no ticket type, group, or agent.

## Before you start

* You are an owner or an admin of the Dodo Payments business.
* You have a Freshdesk account. You have the API key of an agent that can see and edit all contacts and tickets.

## Install, connect, and configure

**1. Install the app**

Open **Apps**, then **Explore**. Open **Freshdesk** (publisher **Dodo Payments**) and select **Install app**.

![The Installed tab of Apps with Freshdesk in the list and the status Active](https://mintcdn.com/dodopayments/9p5nlYkB8XwTy1ds/images/app-marketplace/merchant/apps/freshdesk-4.png?fit=max\&auto=format\&n=9p5nlYkB8XwTy1ds\&q=85\&s=cdf141bb045b7bc3fb7035ac2996ce32)

**2. Connect Freshdesk**

Select **Connect**. In Freshdesk, open your profile, then **Profile settings**, then **View API key**. Paste the key in the **FreshDesk API Key** field. Enter the Freshdesk domain, for example `acme` for `https://acme.freshdesk.com`, then select **Connect**. Freshdesk does not check the domain at connect. Check that the domain is correct.

![The Connect Freshdesk dialog with the FreshDesk API Key and FreshDesk Domain fields](https://mintcdn.com/dodopayments/9p5nlYkB8XwTy1ds/images/app-marketplace/merchant/apps/freshdesk-3.png?fit=max\&auto=format\&n=9p5nlYkB8XwTy1ds\&q=85\&s=9d62dea9b51ace00b3ac5950d89792ff)

**3. Make the contact fields (optional)**

To use **Write the Dodo contact fields**, open **Admin**, then **Customer fields** in Freshdesk. Make three single-line text contact fields: `dodo_customer_id`, `dodo_subscription_status`, and `dodo_status_updated_at`. The app refuses the write when a field does not exist.

**4. Choose the settings**

Open the **Configure** tab, set the options, and select **Save**.

![The Configure tab of the Freshdesk app with the setting switches, the Ticket priority, and the Products filter](https://mintcdn.com/dodopayments/9p5nlYkB8XwTy1ds/images/app-marketplace/merchant/apps/freshdesk-1.png?fit=max\&auto=format\&n=9p5nlYkB8XwTy1ds\&q=85\&s=1b848f7e0dc875c2ad9ad1bd94756244)

**5. Pick the filters**

Pick the products and currencies, then select **Save**.

![The Freshdesk Configure tab with the Products and Currencies filters](https://mintcdn.com/dodopayments/9p5nlYkB8XwTy1ds/images/app-marketplace/merchant/apps/freshdesk-2.png?fit=max\&auto=format\&n=9p5nlYkB8XwTy1ds\&q=85\&s=7e4f54b5f8a042e8a18685fd2f3a7558)

## Settings

| Setting | What it does | Default |
| - | - | - |
| Add customers as contacts | Create or update a contact by email for each successful payment and each new or renewed subscription. The app writes the name and the email. | On |
| Write the Dodo contact fields | Also write `dodo_customer_id`, `dodo_subscription_status`, and `dodo_status_updated_at`. The app writes the status when a subscription goes on hold, is cancelled, or expires. | Off |
| Create a ticket for each opened dispute | Create one ticket for each opened dispute. The subject has a marker, for example `[Dodo ID: dsp_123]`. | On |
| Ticket priority | The priority of each dispute ticket: Low, Medium, High, or Urgent. | High |
| Products | Send contact data only for the products that you pick. The dispute tickets do not use this filter. | All |
| Currencies | Send data only for the currencies that you pick. | All |

## What is sent and when

Dodo Payments sends data after the Dodo Payments event happens. The app sends the email address and the name of the customer. With **Write the Dodo contact fields** on, it also sends the customer ID, the subscription status, and the time. A dispute ticket shows the amount, the payment ID, the reason, and the Dodo ID. The app sends no card data and no address.

The app updates the name of an existing contact at each payment. A name that you changed in Freshdesk changes back to the name in Dodo Payments.

The subject of each dispute ticket has a marker, for example `[Dodo ID: dsp_123]`. The app uses the marker to find the ticket again.

Do not remove the marker from the subject of a ticket. If an agent removes the marker, a retry of the same dispute can create a second ticket.

## Test the app

**1. Use test mode**

Install and connect the app in test mode.

**2. Make a test dispute**

Open a test dispute for a test payment with a test customer email.

**3. Check Freshdesk**

Open **Tickets** in Freshdesk. The ticket for the dispute appears with the priority that you set. Open **Contacts** to see the test customer.

## Troubleshooting

| Problem | What to do |
| - | - |
| The connection fails | Copy the API key again in Freshdesk. Freshdesk gives an error for a key that is not valid. |
| Deliveries fail after the connection is saved | Freshdesk does not check the domain at connect. A wrong domain shows as failed deliveries later. Reconnect with the correct domain. |
| Freshdesk refuses the update after you turn on **Write the Dodo contact fields** | Make the three single-line text contact fields in Freshdesk. |
| A dispute has two tickets | An agent removed the `[Dodo ID: ...]` marker from the subject of the first ticket. Keep the marker. |
| **Connection needs attention** | Freshdesk stopped accepting the credentials. Select **Reconnect** and enter new credentials. |
| No data arrives | Check that the setting switch is on and that the product and currency filters do not skip the event. Check that the customer has an email address. |

## Disconnect and uninstall

Turn off the settings on the **Configure** tab to stop sending data. Uninstall the app to delete the Freshdesk connection. See [Manage and uninstall](https://docs.dodopayments.com/features/app-marketplace/manage-and-uninstall.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.