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

# Zendesk Support

The Zendesk-Zuper integration helps the user connect the Zendesk support tickets with Zuper. The bi-directional data flow based on the settings allows the user to update the ticket details on both Zendesk and Zuper.

We are going to see two different setups:

**Zendesk – Zuper Integration**

**Zuper – Zendesk Integration**

## Pre-Requisites:

API Keys. Click [here](https://docs.zuper.co/Settings/Developer_Hub/API_Keys#api-keys) to know how to create and use API keys

## A. Zendesk-Zuper Integration:

You need to land on the Zendesk support page and integrate the Zuper with Zendesk by following the steps:

1. Select the “**Settings**” module from the left panel.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen1.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=8c51c1913177f1555ee73c8a709ec4dc" alt="Zen1 Pn" width="1097" height="506" data-path="images/Zen1.png" />

2. Select the “**Go to Admin Centre**” option.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen2.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=6e6c88c3e96fa90600e227fa554f8a7e" alt="Zen2 Pn" width="1097" height="512" data-path="images/Zen2.png" />

3. Choose the “**Apps and Integrations**” subsection under the “**Admin Center**” section.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen3.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=39c8a5eab78fbd13e69d5ce50257497a" alt="Zen3 Pn" width="1084" height="518" data-path="images/Zen3.png" />

4. Select the “**Market Place**” option present at the top of the page.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen4.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=f716a1dafa799eb6b0e3f97c8098462b" alt="Zen4 Pn" width="901" height="570" data-path="images/Zen4.png" />

5. Search for the "**Zuper**" app under the filters option.

<img src="https://mintcdn.com/zuperinc/Z-m5BGzpsCSPztiA/images/Zen31.png?fit=max&auto=format&n=Z-m5BGzpsCSPztiA&q=85&s=4dee654bee2f568bfc3a30c7c534052a" alt="Zen31 Pn" width="1920" height="827" data-path="images/Zen31.png" />

6. Select the “**Zuper**” app from the list.

<img src="https://mintcdn.com/zuperinc/Z-m5BGzpsCSPztiA/images/Zen30.png?fit=max&auto=format&n=Z-m5BGzpsCSPztiA&q=85&s=bf8b0de4ccddca4e66c2f7847df554d1" alt="Zen30 Pn" width="1920" height="827" data-path="images/Zen30.png" />

7. Select the “**Install**” option to set up the Zuper integration.

<img src="https://mintcdn.com/zuperinc/Z-m5BGzpsCSPztiA/images/Zen32.png?fit=max&auto=format&n=Z-m5BGzpsCSPztiA&q=85&s=e903e208785f2497b55e2b92c3dafad7" alt="Zen32 Pn" width="1920" height="827" data-path="images/Zen32.png" />

8. Enter the Mandatory fields: “**Title**” and “**API Key**” (Zuper’s API key), and if required, fill in the Optional fields: “**Zendesk Ticket Type**,” “**Zuper Default Job Category**,” “**Push Comments to Zuper Automatically**,” “**Enable Role Restrictions**,” “**Enable Group Restrictions**.”

<img src="https://mintcdn.com/zuperinc/Z-m5BGzpsCSPztiA/images/Zen33.png?fit=max&auto=format&n=Z-m5BGzpsCSPztiA&q=85&s=d0363c8573fe364d516799c143fb86ab" alt="Zen33 Pn" width="1092" height="542" data-path="images/Zen33.png" />

9. Select the “**Update**” button to save the preferences.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen9.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=4a3e07144ba5d905831a5c33878fa0ef" alt="Zen9 Pn" width="1101" height="503" data-path="images/Zen9.png" />

By following the steps above, you can easily integrate Zuper with Zendesk.

## B. Zuper – Zendesk Integration:

To get the API keys for Zuper-Zendesk Integration, follow the steps below:

1. Click on “**Go to Admin Center**” under “**Settings**” from the left panel.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen10.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=75f0478b3a415e9aa60b075ce54624b3" alt="Zen10 Pn" width="974" height="453" data-path="images/Zen10.png" />

2. Now select “**Apps and Integrations**” and click on “**Zendesk API**.”

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen11.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=82c10cb6b800e0b5292152ad2bb9ac35" alt="Zen11 Pn" width="978" height="445" data-path="images/Zen11.png" />

3. Select “**Add API Token**” to create the new API key.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen12.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=ac5ffdfe6a99916d75b64e5bf0cfab31" alt="Zen12 Pn" width="988" height="446" data-path="images/Zen12.png" />

4. Type the API Token Description name as “**Zuper**” and copy the “**API Key**.”

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen13.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=14dd41b7163ec619c6ac5bba9fd81067" alt="Zen13 Pn" width="974" height="446" data-path="images/Zen13.png" />

<Note>
  **Note**: Make sure to copy and store this API token. Zendesk will not display it again after clicking Save or leaving this page.
</Note>

## How to Install?

You need to land on the Zuper web app and integrate Zendesk with Zuper by following the steps:

1. Click on your profile picture on the top right corner of the page, which will open the list of options. Next, click on the “**App Store**” link.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen14.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=15457247ce905f51281d6da09ca4dbfb" alt="Zen14 Pn" width="1920" height="878" data-path="images/Zen14.png" />

2. You will be redirected to the “**App Store**.” Click on “**CRM**” under “**Browse by Category**” on your left and click “**Zendesk**.”

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen15.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=ea9edd270b950c546d43ec4fcada0a35" alt="Zen15 Pn" width="1920" height="878" data-path="images/Zen15.png" />

3. In the dialog box, enter the **Zendesk subdomain** of the account you want to connect to Zuper.

<Frame>
  <img src="https://mintcdn.com/zuperinc/7iWkwLvM43FrnjHc/images/zdeskma6.png?fit=max&auto=format&n=7iWkwLvM43FrnjHc&q=85&s=9c421ce424bb79f3543ec46ffd5d3bdf" alt="Zdeskma6" width="1920" height="827" data-path="images/zdeskma6.png" />
</Frame>

4. Zendesk displays a dialog box **“Allow Zuper to access your Zendesk account?”**

<Frame>
  <img src="https://mintcdn.com/zuperinc/7iWkwLvM43FrnjHc/images/zdeskma5.png?fit=max&auto=format&n=7iWkwLvM43FrnjHc&q=85&s=f528bee2cde79aa46a8ba3db643b4f74" alt="Zdeskma5" width="1920" height="827" data-path="images/zdeskma5.png" />
</Frame>

5. Enter the Email and Password.

<Frame>
  <img src="https://mintcdn.com/zuperinc/7iWkwLvM43FrnjHc/images/zdeskma4.png?fit=max&auto=format&n=7iWkwLvM43FrnjHc&q=85&s=dd80c75c5e353557198b288ca64d6925" alt="Zdeskma4" width="1920" height="827" data-path="images/zdeskma4.png" />
</Frame>

6. Enter the Mandatory Fields: Zuper API Key, Zendesk API Token, Zendesk Agent Email, Sync Zuper Status Updates, Sync Zuper Job Status, Zendesk Status Field Name.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen16.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=23680d22241173e5b14cab046f871bcc" alt="Zen16 Pn" width="1912" height="876" data-path="images/Zen16.png" />

7. Enter the Optional Fields on the Zuper from the field details taken from the

Zendesk support page: **Zendesk Assignees Field Name, Zendesk Start Date**

Field Name. Zendesk End Date Field Name, Zendesk Customer Signature Field Name, Zendesk Ticket Closure Statuses.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen17.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=e5a40f46f7247f05c0baab41f5f8a25b" alt="Zen17 Pn" width="1887" height="857" data-path="images/Zen17.png" />

Select the “**Update**” button to save the preferences.

**What Happens After Authorization**

After successful authorization:

* Map Zuper jobs to Zendesk tickets.
* Automatically update ticket custom fields with job status, assigned technician, scheduled date, and customer signatures.
* Job notes sync as Zendesk ticket comments, including any attachments.
* Tickets can automatically resolve or close based on mapped job statuses.

**Best Practices**

* Authorize the integration using a Zendesk admin account to avoid permission issues.
* Configure the required Zendesk custom fields for job mapping before connecting.
* Do not disconnect the OAuth authorization unless you need to reset the integration.

## C. Zuper - Zendesk Sell/ Support Field Equivalents:

Deal ID / Zendesk ID - The deal ID / Zendesk ID is a unique ID of Zendesk Sell / Support that is getting pushed to the Custom Field of Zuper for identification purposes.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen18.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=452724cd65eb1e51730f17efe60ca584" alt="Zen18 Pn" width="599" height="462" data-path="images/Zen18.png" />

## D. How does Job creation work in Zendesk?

1. From the right panel of Zendesk, Choose “**Create Job**” to create a new job. You need to fill the following tabs :

**Customer Details Tab** - Enter the client’s details.

\*\*Job Details Tab \*\*- Enter the work order details.

**Assign Employees** - Assign the field technicians using assisted scheduling option.

2. Asset Picker helps you to select the resources from Zuper’s Jobs module of Zendesk.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen19.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=da3684bc12a5258ac5d7781028e53ce2" alt="Zen19 Pn" width="1920" height="939" data-path="images/Zen19.png" />

3. Parts Picker helps you select the parts from the Zuper’s Jobs module of Zendesk.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen20.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=07a4e4061ce02b2d9ecc5b19dca3918b" alt="Zen20 Pn" width="1905" height="939" data-path="images/Zen20.png" />

4. Contract Picker helps you select the agreements from Zuper’s Jobs module of Zendesk.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen21.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=a76a60a5dff9160a99b27e555ffd58c1" alt="Zen21 Pn" width="1905" height="939" data-path="images/Zen21.png" />

5. By default, the timezone is displayed according to the organization’s or customer’s preferences set in Zuper. Now, users can create a new job based on their preferred time zone or switch to a different one.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen22.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=02093ed906cf59c690aadca96c19c958" alt="Zen22 Pn" width="1915" height="805" data-path="images/Zen22.png" />

<Note>
  **Note**: If both the organization and customer have preferred time zones, the customer's preferred time zone would be pre-filled.
</Note>

### Assisted Scheduling:

Assisted Scheduling helps you choose the time slots based on the Slot View or Resource View.

**Slot View** - Based on the chosen category, time slots are displayed.

**Resource View** - Based on the users availability.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen23.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=aecb9979ca06bedefea5cc8111d9c301" alt="Zen23 Pn" width="980" height="526" data-path="images/Zen23.png" />

6. Live Tracking: Live tracking of field executives can be performed from the Jobs module in Zendesk.

You can use the assisted scheduling feature from Zuper while creating a Job in Zendesk.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen24.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=cd126de066eb998369c12aa0c46b6cb5" alt="Zen24 Pn" width="1920" height="939" data-path="images/Zen24.png" />

## E. Overall Flow

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen25.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=5f959d4c5359b2f2d28843d233b026f1" alt="Zen25 Pn" width="984" height="589" data-path="images/Zen25.png" />

## How to Uninstall?

1. Open a new tab in your browser and once you are logged in to your Zuper Account, click on your Profile Picture on the top right corner of the screen and click on “**App Store**.”

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen26.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=8eef5a21b5976486f94d108173d02168" alt="Zen26 Pn" width="1904" height="872" data-path="images/Zen26.png" />

2. You will be redirected to the “**App Store**.” Click on “**CRM**” under “**Browse by Category**” on your left and click “**Zendesk**.”

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen27.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=5ff2fdedd0873e546807de9d08bed7ab" alt="Zen27 Pn" width="1912" height="876" data-path="images/Zen27.png" />

3. Click “**Uninstall App**” button.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen28.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=d25ac2541dfaa6496d394485ca10929b" alt="Zen28 Pn" width="1912" height="876" data-path="images/Zen28.png" />

4. The uninstall is successful.

<img src="https://mintcdn.com/zuperinc/19_UW2yMUVV3uouV/images/Zen29.png?fit=max&auto=format&n=19_UW2yMUVV3uouV&q=85&s=8fa7fbc30ea0fe89af5b691a924c8ace" alt="Zen29 Pn" width="1886" height="737" data-path="images/Zen29.png" />

By following the above steps, you can now easily integrate Zendesk with Zuper.
