> For the complete documentation index, see [llms.txt](https://www.cakewalk.security/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.cakewalk.security/docs/connections-and-integrations/integration-guides/zendesk.md).

# Zendesk

### :sparkles: Auto Provisioning

| **Authentication method** | API key. See details [here](#where-can-i-create-an-api-key).          |
| ------------------------- | --------------------------------------------------------------------- |
| **Required permissions**  | `Admin`                                                               |
| **Required metadata**     | `Workspace`. See details [here](#where-can-i-find-my-workspace-name). |

<details>

<summary><strong>Where can I create an API Key?</strong></summary>

1. Navigate to your Zendesk console

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/e95de52c-af49-4cc8-bedf-dc9f1e7ccd9a/ascreenshot.jpeg?tl_px=0,0\&br_px=1376,769\&force_format=jpeg\&q=100\&width=1120.0)

2. Click the settings icon

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/e95de52c-af49-4cc8-bedf-dc9f1e7ccd9a/ascreenshot.jpeg?tl_px=0,1\&br_px=1376,770\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=-8,277)

3. Click on `Apps and integrations`.

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/5605e4eb-bad4-4974-a4b3-c28bb9792fdd/ascreenshot.jpeg?tl_px=0,218\&br_px=1376,987\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=146,277)

4. Click `API tokens`

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/1dc101b5-98ce-4ab6-b653-4dadf0640080/ascreenshot.jpeg?tl_px=0,625\&br_px=1376,1395\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=61,277)

5. If you don't have API keys enabled then click here.

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/1b7c92b1-81a2-42a4-b09d-a447ca26ad6f/ascreenshot.jpeg?tl_px=422,139\&br_px=1798,908\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=524,277)

6. Click `Get started`

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/61963013-1e97-4a27-a797-801d6a18996f/ascreenshot.jpeg?tl_px=666,219\&br_px=2042,988\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=524,276)

7. Click `View token access configuration`

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/1f9f7bc2-0348-4075-aedf-a7588b4e3d45/ascreenshot.jpeg?tl_px=81,0\&br_px=1457,769\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=524,171)

8. Click `Allow API token access`

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/b1f31531-8acf-4963-a44b-eb6468cbc4cc/ascreenshot.jpeg?tl_px=0,0\&br_px=1376,769\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=204,117)

9. Click `Save`

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/5e341570-4eb1-48af-a696-2390b2364984/ascreenshot.jpeg?tl_px=1164,625\&br_px=2540,1395\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=1027,558)

10. Return to `API tokens`

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/e06fca4c-945a-4a18-8375-2ac8676c389c/ascreenshot.jpeg?tl_px=0,620\&br_px=1376,1389\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=36,277)

11. Click `Add API token`

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/02331449-257e-4559-8077-533a23178fee/ascreenshot.jpeg?tl_px=704,120\&br_px=2080,889\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=524,277)

12. Add a description

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/d58e073c-3432-4a03-980e-92ab439fe389/ascreenshot.jpeg?tl_px=0,0\&br_px=1376,769\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=389,161)

14. Click `Save`

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/6afd3770-4e0a-4190-8cd1-f188af03b912/ascreenshot.jpeg?tl_px=1164,625\&br_px=2540,1395\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=1022,565)

15. Click `Copy`

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/869c1e17-24fb-4ab1-ad43-c7e1e8fee051/user_cropped_screenshot.webp?tl_px=0,0\&br_px=2540,1395\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=356,122)

16. Return to Cakewalk and add your Zendesk admin email and paste in your `API Secret`

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/86b0b5d3-1ea5-47ad-b13b-88dff459e052/ascreenshot.jpeg?tl_px=1164,0\&br_px=2540,769\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=718,204)

17. Click `Save & Enable`

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/f2c9717d-076d-47a0-92aa-8fcaa5fa0bb3/ascreenshot.jpeg?tl_px=1164,625\&br_px=2540,1395\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=843,555)

</details>

<details>

<summary><strong>Where can I find my <code>Workspace</code> name?</strong></summary>

1. Navigate to your Zendesk console and click the settings icon

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/97d65884-a8fa-4726-b3d6-72737e3fd4d4/ascreenshot.jpeg?tl_px=0,2\&br_px=1376,771\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=-7,277)

2. Click here and copy your workspace name

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/008000a1-6d0c-4e09-be02-ab59ca3fe7ed/ascreenshot.jpeg?tl_px=0,0\&br_px=1376,769\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=253,-13)

3. Return to Cakewalk and paste it to the corresponding field

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/ac1149c4-37bb-488e-94cf-e12c49a6d883/ascreenshot.jpeg?tl_px=1164,0\&br_px=2540,769\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=664,167)

4. Click "Continue"

![](https://ajeuwbhvhr.cloudimg.io/https://colony-recorder.s3.amazonaws.com/files/2025-07-16/27cfc64f-f961-4234-a400-f65efe446344/ascreenshot.jpeg?tl_px=1164,625\&br_px=2540,1395\&force_format=jpeg\&q=100\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=885,544)

</details>

***

### :arrows\_counterclockwise: Access Sync

Access Sync for Zendesk allows you to automatically synchronize user data with Cakewalk.

| **Authentication method** | OAuth |
| ------------------------- | ----- |

## Quick Setup

1. Navigate to **App Governance** → **Zendesk** → **Users table** → **Sync Users**
2. Grant Cakewalk OAuth access to your Zendesk account
3. Users will sync automatically


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://www.cakewalk.security/docs/connections-and-integrations/integration-guides/zendesk.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.