> For the complete documentation index, see [llms.txt](https://docs.elimity.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.elimity.com/reference-manual/v3.46.6/built-in-connectors/zendesk.md).

# Zendesk

The Zendesk connector for Elimity Insights fetches users and groups from Zendesk so you can keep in control of your environment. Follow the instructions below to set up the connector for your environment.

## 1. Setting up a dedicated user in Zendesk

As usual, we recommend creating a dedicated user in Zendesk for this connector. [The official documentation](https://support.zendesk.com/hc/en-us/articles/4408886939930-Adding-agents-and-admins#topic_h43_2k2_yg) contains detailed instructions.

## 2. Generating an OAuth access token for the dedicated user

Now that we have created a dedicated user in Zendesk, we need to generate an OAuth token for authentication. Refer to [the official documentation](https://developer.zendesk.com/documentation/ticketing/working-with-oauth/creating-and-using-oauth-tokens-with-the-api) for additional information on how to do this. This connector only requires the `read` scope. Note down the resulting token for later use.

## 3. Creating a source in Elimity Insights

In Elimity Insights you can now create a new Zendesk source providing the following configuration options:

<table data-full-width="true"><thead><tr><th>Configuration option</th><th>Description</th></tr></thead><tbody><tr><td>Subdomain</td><td>Subdomain of your Zendesk tenant (e.g. <code>example</code> if your Zendesk domain is <code>example.zendesk.com</code>).</td></tr><tr><td>OAuth token</td><td>OAuth token you noted down in step 1.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.elimity.com/reference-manual/v3.46.6/built-in-connectors/zendesk.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
