> ## 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.

# Zendesk App

> Install the official Zendesk app to create or update Zendesk end users for your Dodo Payments customers and add a ticket for each opened dispute.

## What the Zendesk app does

The Zendesk app creates or updates a Zendesk end user for each customer. It also adds a ticket for each dispute that opens. A payment or a refund makes no ticket.

## Before you start

* You are an owner or an admin of the Dodo Payments business.
* You have a Zendesk account. You have the email address of a Zendesk admin and an API token of that admin.

## Install, connect, and configure

**1. Install the app**

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

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

**2. Connect Zendesk**

Select **Connect**. Enter the Zendesk subdomain, for example `acme` for `https://acme.zendesk.com`. Enter the email address of a Zendesk admin. In Zendesk, open **Admin Center**, then **Apps and integrations**, then **Zendesk API**, and make an API token. Paste it in the **API Token** field, then select **Connect**.

![The Connect Zendesk dialog with the Zendesk Domain, Email Address, and API Token fields](https://mintcdn.com/dodopayments/9p5nlYkB8XwTy1ds/images/app-marketplace/merchant/apps/zendesk-3.png?fit=max\&auto=format\&n=9p5nlYkB8XwTy1ds\&q=85\&s=80781933a1cd0a1269564cb8fef2b81d)

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

To use **Write the Dodo user fields**, open **Admin Center**, then **People**, then **User fields** in Zendesk. Make three Text fields with the field keys `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 Zendesk app with the three setting switches and the Products filter](https://mintcdn.com/dodopayments/9p5nlYkB8XwTy1ds/images/app-marketplace/merchant/apps/zendesk-1.png?fit=max\&auto=format\&n=9p5nlYkB8XwTy1ds\&q=85\&s=91a8c2f5be0d3cec440d2cbc0574ca7c)

**5. Pick the filters**

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

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

## Settings

| Setting | What it does | Default |
| - | - | - |
| Add customers as users | Create or update an end user by email for each successful payment and each new or renewed subscription. The app writes the name, the email, and the external ID (the Dodo customer ID). It sends no verification email. | On |
| Write the Dodo user 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 |
| Add a ticket for each opened dispute | Add one ticket for each opened dispute. The customer is the requester. The ticket has one internal note with the amount, the reason, and the Dodo IDs, so the customer gets no email from the note. The app adds no second ticket for the same dispute. | On |
| Products | Send user 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, the name, and the Dodo customer ID of the customer. With **Write the Dodo user fields** on, it also sends the subscription status and the time. A dispute ticket shows the amount, the reason, the dispute status, the payment ID, and the Dodo ID. The app sends no card data and no address.

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

The Zendesk user search can be late for a new user. Then the app can create a second user for the same email. Also, a status update can skip that user. Merge the duplicate users in Zendesk.

## 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 Zendesk**

Open **Tickets** in Zendesk. The ticket for the dispute appears with one internal note. Open **Customers** to see the test customer.

## Troubleshooting

| Problem | What to do |
| - | - |
| The connection fails | Check the subdomain, the admin email address, and the API token. Make a new API token if necessary. Zendesk gives an error for credentials that are not valid. |
| Zendesk refuses the update after you turn on **Write the Dodo user fields** | Make the three Text user fields with the correct field keys in Zendesk. The error is final, and the app does not retry. |
| A status update does not reach a new user | The Zendesk user search was late. This is a known limit. |
| Two users exist for one email | The search was late for a new user. Merge the users in Zendesk. |
| **Connection needs attention** | Zendesk 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 Zendesk 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.