# Zendesk

This article is a guide to connect your Zendesk account with Checkout Champ.

{% hint style="info" %}
Zendesk Checkout Champ Integration Documentation
{% endhint %}

***

### Step 1: Add an API User for Zendesk <a href="#zendesk-step1-addanapiuserforzendesk" id="zendesk-step1-addanapiuserforzendesk"></a>

Follow the instructions below to add an API User in Checkout Champ.

Take note of the loginId and password for Step 2.

{% hint style="info" %}
The user must have only “ZENDESK” listed in the **IP Whitelist** field. Do not list any other IP addresses.

Please remember to wait about 5 minutes after adjusting any IP Whitelist or Endpoint settings.
{% endhint %}

{% hint style="info" %}

The user must have access to the following endpoints:

* Update Order
* Query Orders
* Refund Order
* Cancel Order
* Query Customers
* Add Customer Note
* Update Customer
* Query Purchase
  {% endhint %}

[Create An API User](/crm/admin-setup/create-a-user/create-an-api-user.md)

### Step 2: Configure Zendesk <a href="#zendesk-step2-configurezendesk" id="zendesk-step2-configurezendesk"></a>

**Login to Zendesk and navigate to Admin → Admin Center → Apps and integrations → Zendesk Support Apps → Marketplace**

Enter the loginId and password for your Checkout Champ API user.

<figure><img src="/files/ahN5sYezL3X1PNQMCmkV" alt=""><figcaption></figcaption></figure>

### Step 3: Test Zendesk <a href="#zendesk-step3-testzendesk" id="zendesk-step3-testzendesk"></a>

Orders and customer information are retrieved from Checkout Champ based on the email address used in the Zendesk ticket. Confirm that a Zendesk ticket populates the correct information by opening a ticket created by a customer that exists within your Checkout Champ account.

<figure><img src="/files/jsYF6xbd13UWvbeUjEL1" alt=""><figcaption></figcaption></figure>


---

# 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://help.checkoutchamp.com/crm/plugins/data-sources/zendesk.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.