> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Zendesk Support Connector with Upsert

## Intro

Zendesk Support Connector with Upsert provides a cloud-based customer service program that includes ticketing, self-service options, and customer support features. It enhances productivity, processes, and pipelines for your sales teams. Use Domo’s Zendesk Support Connector with Upsert to compile reports about tickets, users, and more. To learn more about the Zendesk Support Connector with Upsert API, visit their page ([https://developer.Zendesk Support Connector with Upsert.com/rest\_api/docs/core/introduction](https://developer.zendesk.com/rest_api/docs/core/introduction "https://developer.zendesk.com/rest_api/docs/core/introduction") ).

The Zendesk Support Connector with Upsert is a "Cloud App" Connector, meaning it retrieves data stored in the cloud. In the Data Center, you can access the Connector page for this and other Cloud App Connectors by clicking ****Cloud App**** in the toolbar at the top of the window.

You connect to your Zendesk Support Connector with Upsert account in the Data Center. This topic discusses the fields and menus that are specific to the Zendesk Support Connector with Upsert user interface. To add DataSets, set update schedules, and edit DataSet information, see [Adding a DataSet Using a Connector](https://domo-support.domo.com/s/article/360042926274?language=en_US "Adding a DataSet Using a Connector").

## Prerequisites

To connect to your Zendesk Support Connector with Upsert account and create a DataSet, you must have the following:

* The username for your Zendesk Support Connector with Upsert account
* The API token OR password for your Zendesk Support Connector with Upsert account
* The Zendesk Support Connector with Upsert URL for your company
* The user must be a Zendesk admin.
* You need to verify the primary email address associated with the user account.

To use a password, enable API authentication using an agent's email address and password. This may already be enabled for sign-in to the Zendesk Support Connector with Upsert Support mobile apps.

Zendesk Support Connector with Upsert recommends that you use API tokens to keep your agents' passwords safe. API tokens are managed in the Zendesk Support Connector with Upsert Support Admin interface at ****Admin > Channels > API****. The page lets you view, add, or delete tokens. More than one token can be active at the same time. Deleting a token deactivates it permanently.

## Connecting to Your Zendesk Support Connector with Upsert Account

This section enumerates the options in the **Credentials** and **Details** panes in the Zendesk Support Connector with Upsert page. The components of the other panes in this page, **Scheduling** and **Name & Describe Your DataSet**, are universal across most Connector types and are discussed in great detail in [Adding a DataSet Using a Connector](https://domo-support.domo.com/s/article/360042926274?language=en_US "Adding a DataSet Using a Connector").

### Credentials Pane

This pane contains fields for entering credentials to connect to your Zendesk Support Connector with Upsert account. The following table describes what is needed for each field:

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p><span class="s1"> Field </span></p></th><th colspan="1" rowspan="1"><p><span class="s1"> Description </span></p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"> Username </td><td colspan="1" rowspan="1"> Enter the username you use to log into your Zendesk Support Connector with Upsert account. </td></tr><tr><td colspan="1" rowspan="1"> Authenticated By </td><td colspan="1" rowspan="1"> Specify whether you want to use your Zendesk Support Connector with Upsert API token or password to authenticate. </td></tr><tr><td colspan="1" rowspan="1"> API Token or Password </td><td colspan="1" rowspan="1"> Enter your Zendesk Support Connector with Upsert API token or password. This <em><em> must </em></em> match what you have selected in the <b><b> Authenticate By </b></b> menu. For example, if you selected <b><b> API Token </b></b> for <b><b> Authenticate By </b></b>, you must enter your API token in this field, not your password. </td></tr><tr><td colspan="1" rowspan="1"> Zendesk Support Connector with Upsert URL </td><td colspan="1" rowspan="1"> Enter the URL for your company's Zendesk Support Connector with Upsert instance. </td></tr></tbody></table>

Once you have entered valid Zendesk Support Connector with Upsert credentials, you can use the same account any time to create a new Zendesk Support Connector with Upsert. You can manage Connector accounts in the **Accounts** tab in the Data Center. For more information about this tab, see [Manage Connector/Adapter Accounts](https://domo-support.domo.com/s/article/360042926054?language=en_US "Manage Connector/Adapter Accounts").

### Details Pane

This pane contains a primary **Reports** menu, along with various other menus which may or may not appear depending on the report type you select.

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p> Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Report </p></td><td colspan="1" rowspan="1"><p> Select the Zendesk Support Connector with Upsert report you want to run. The following reports are available: </p><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td colspan="1" rowspan="1"><b> Report Name </b></td><td colspan="1" rowspan="1"><b> Description </b></td></tr><tr><td colspan="1" rowspan="1"><p> Brands </p></td><td colspan="1" rowspan="1"> Retrieves a list of all brands for your account sorted by name. </td></tr><tr><td colspan="1" rowspan="1"> Organizations </td><td colspan="1" rowspan="1"> Retrieves information about the organizations in your Zendesk Support Connector with Upsert instance. </td></tr><tr><td colspan="1" rowspan="1"> Specify Query </td><td colspan="1" rowspan="1"> Allows you to build a customized report by entering your own Zendesk Support Connector with Upsert search query. You can also select from two premade queries— <b> Open Tickets </b> and <b> Closed Tickets </b>. You can use these to return the number of open and closed tickets for your Zendesk Support Connector with Upsert instance. <br /> For more information about entering Zendesk Support Connector with Upsert queries, see <a href="https://support.zendesk.com/hc/en-us/articles/4408886879258" target="_blank" title="Zendesk Support search reference"> Zendesk Support Connector with Upsert Support search reference </a>. </td></tr><tr><td colspan="1" rowspan="1"> Tickets </td><td colspan="1" rowspan="1"> Retrieves information about the created and updated tickets. </td></tr><tr><td colspan="1" rowspan="1"><p> Ticket Activities </p></td><td colspan="1" rowspan="1"> Retrieves Lists ticket activities in the last 30 days, affecting the agent making the request. </td></tr><tr><td colspan="1" rowspan="1"> Ticket Audits </td><td colspan="1" rowspan="1"> Retrieve the list of ticket audits. </td></tr><tr><td colspan="1" rowspan="1"><span> Ticket Fields </span></td><td colspan="1" rowspan="1"><span> Retrieve tickets fields in your Zendesk Support Connector with Upsert instance. </span></td></tr><tr><td colspan="1" rowspan="1"><span> Ticket Forms - Agent Conditions </span></td><td colspan="1" rowspan="1"><span> Retrieve ticket forms in your Zendesk Support Connector with Upsert instance and displays the condition sets for agent workplace. </span></td></tr><tr><td colspan="1" rowspan="1"><span> Ticket Forms - End User Conditions </span></td><td colspan="1" rowspan="1"><span> Retrieve ticket forms in your Zendesk Support Connector with Upsert instance and displays the condition sets for end user products. </span></td></tr><tr><td colspan="1" rowspan="1"> Ticket Comments </td><td colspan="1" rowspan="1"> Retrieves the comments on the tickets. </td></tr><tr><td colspan="1" rowspan="1"> Ticket Metric Events </td><td colspan="1" rowspan="1"> Retrieves the ticket metric events. </td></tr><tr><td colspan="1" rowspan="1"> Users </td><td colspan="1" rowspan="1"> Retrieves the information about the users in your Zendesk Support Connector with Upsert instance. </td></tr></tbody></table></td></tr><tr><td colspan="1" rowspan="1"> Associated Data </td><td colspan="1" rowspan="1"> Select the associated data you want loaded along with the tickets. </td></tr><tr><td colspan="1" rowspan="1"> Include Attachments </td><td colspan="1" rowspan="1"> Specify whether you would like to include the attachments in the results. </td></tr><tr><td colspan="1" rowspan="1"><span> Select the date to start retrieving data on the first run. Subsequent runs will automatically retrieve newly created and updated tickets, users or organizations </span></td><td colspan="1" rowspan="1"><span> Select the date to start retrieving data on the first run. Subsequent runs will automatically retrieve newly created and updated items. If you modify the date after the first run, this date will be used for the next run and the existing data will be replaced. </span></td></tr><tr><td colspan="1" rowspan="1"> Date Selection </td><td colspan="1" rowspan="1"> Select the Date to start retrieving data on the first run. Subsequent runs will automatically retrieve newly created and updated tickets, users, or organizations. </td></tr><tr><td colspan="1" rowspan="1"> Single Date </td><td colspan="1" rowspan="1"> Select whether the report data is for a specific date or for a relative number of days back from today. </td></tr><tr><td colspan="1" rowspan="1"> Specific Date </td><td colspan="1" rowspan="1"> Select the specific date using the date selector. </td></tr><tr><td colspan="1" rowspan="1"> Relative Date </td><td colspan="1" rowspan="1"> Enter the number of days back that you would like to get data for in the <b><b> Days Back </b></b> field. Specify either today or 0, yesterday or 1, or today-7 or 7 to get data for 7 days into the past. </td></tr><tr><td colspan="1" rowspan="1"> Legacy Schema Selection </td><td colspan="1" rowspan="1"> Select this check box to use legacy schema for backward compatibility with the Zendesk Support Connector with Upsert Connector. </td></tr><tr><td colspan="1" rowspan="1"> Exclude Deleted Records </td><td colspan="1" rowspan="1"> Select this check box to exclude the deleted records from the data. </td></tr></tbody></table>

### Other Panes

For information about the remaining sections of the Connector interface, including how to configure schedule, retry, and update options, see [Adding a DataSet Using a Data Connector](https://domo-support.domo.com/s/article/360042926274?language=en_US "Adding a DataSet Using a Data Connector").

## FAQs

<AccordionGroup>
  <Accordion title="What endpoint is the base URL for this connector?">
    The base URL for the Zendesk Support Connector with Upsert Upsert connector is [https://{subdomain}.Zendesk Support Connector with Upsert.com/api/v2](https://%7Bsubdomain%7D.zendesk.com/api/v2 "https://\{subdomain}.zendesk.com/api/v2").
  </Accordion>

  <Accordion title="Which endpoint(s) does each report call in this connector?">
    <table data-aura-rendered-by="33:195;a"><tbody><tr><th colspan="1" rowspan="1" width="30%"> Report Name </th><th colspan="1" rowspan="1" width="70%"> Enpoint URL </th></tr><tr><td colspan="1" rowspan="1"> Brands </td><td colspan="1" rowspan="1"> /api/v2/brands.json </td></tr><tr><td colspan="1" rowspan="1"> Organizations </td><td colspan="1" rowspan="1"> /incremental/organizations.json </td></tr><tr><td colspan="1" rowspan="1"> Specify Query </td><td colspan="1" rowspan="1"> /api/v2/search/export.json </td></tr><tr><td colspan="1" rowspan="1"> Tickets </td><td colspan="1" rowspan="1"> /incremental/tickets.json </td></tr><tr><td colspan="1" rowspan="1"><p> Ticket Activities </p></td><td colspan="1" rowspan="1"> /api/v2/activities.json </td></tr><tr><td colspan="1" rowspan="1"> Ticket Audits </td><td colspan="1" rowspan="1"> /ticket\_audits.json </td></tr><tr><td colspan="1" rowspan="1"> Ticket Fields </td><td colspan="1" rowspan="1"> /ticket\_fields.json </td></tr><tr><td colspan="1" rowspan="1"> Ticket Forms - Agent Conditions </td><td colspan="1" rowspan="1"> /ticket\_forms.json </td></tr><tr><td colspan="1" rowspan="1"> Ticket Forms - End User Conditions </td><td colspan="1" rowspan="1"> /ticket\_forms.json </td></tr><tr><td colspan="1" rowspan="1"> Ticket Comments </td><td colspan="1" rowspan="1"> /tickets/{currentTicketId}/comments.json </td></tr><tr><td colspan="1" rowspan="1"> Ticket Metric Events </td><td colspan="1" rowspan="1"> /incremental/ticket\_metric\_events.json </td></tr><tr><td colspan="1" rowspan="1"> Users </td><td colspan="1" rowspan="1"> /incremental/users.json </td></tr></tbody></table>
  </Accordion>

  <Accordion title="What kind of credentials do I need to power up the this connector?">
    You need the Zendesk Support Connector with Upsert username, password or API token, and the Zendesk Support Connector with Upsert instance URL. The Zendesk Support Connector with Upsert user account used for this connector must be an Admin within Zendesk Support Connector with Upsert.
  </Accordion>

  <Accordion title="How frequently will my data update?">
    As often as needed.
  </Accordion>

  <Accordion title="Are there any API limits that I need to be aware of?">
    No
  </Accordion>

  <Accordion title="Can I use the same Zendesk Support Connector with Upsert account to create multiple datasets?">
    Yes
  </Accordion>

  <Accordion title="What's the difference between the Zendesk Support Connector with Upsert and Zendesk Support Connector with Upsert Upsert connectors?">
    The Zendesk Support Connector with Upsert supports a Merge mode along with the Append and Replace modes to update your dataset. The Merge mode replaces all updated rows, while any new rows are appended. Thus, it avoids duplicate entries.

    The Zendesk Support Connector with Upsert supports the Append and Replace modes to update your datasets.
  </Accordion>
</AccordionGroup>
