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

# Zendesk

> Connect Zendesk and use available lookups and actions.

Connect Zendesk to let the AI retrieve ticket/user details (lookups) and perform
approved updates (actions).

## On this page

* [Connect](#connect)
* [Supported tools](#supported-tools)
  * [Lookups](#lookups)
  * [Actions](#actions)

## Connect

**1. Log in as an admin and go to the admin section**

You need permissions to access the admin section and create OAuth clients.

**2. Open the OAuth clients page**

Navigate to `Apps and Integrations` → `APIs` → `OAuth clients`

![OAuth clients page](https://mintcdn.com/typewise/ht7a5v6EXYgQrv7K/images/documentation/integrations/zendesk-oauth/zendesk-oauth-clients.webp?fit=max\&auto=format\&n=ht7a5v6EXYgQrv7K\&q=85\&s=3f0ad6e18c9a30e3dbf051b0e6551a19)

**3. Create a new OAuth client**

Click `Add OAuth client` and fill out the details.

> [!NOTE]
>
> Make sure to set **Client kind** to **Confidential**.

<video controls src="https://mintcdn.com/typewise/qdr9SEexkbPGti9V/images/documentation/integrations/zendesk-oauth/step1.mov?fit=max&auto=format&n=qdr9SEexkbPGti9V&q=85&s=0cb4accb025712c19da5fa1cfb245352" />

After you click `Save`, you’ll be shown a secret at the end of the page. It’s only shown once, so copy and store it securely.

**4. Connect Zendesk in Typewise**

In Typewise, go to **Integrations**, find Zendesk, and click **Install**. You’ll need:

![Connect Zendesk](https://mintcdn.com/typewise/ht7a5v6EXYgQrv7K/images/documentation/integrations/zendesk-oauth/zendesk-install-dialog.webp?fit=max\&auto=format\&n=ht7a5v6EXYgQrv7K\&q=85\&s=412efdcbd1c58f37a57ffe686c99ad52)

* **Subdomain:** The first part of your Zendesk URL. For example, for `https://acme.zendesk.com/admin/home`, the subdomain is `acme`.

* **Client ID:** The identifier you set when creating the OAuth client.

  ![Client ID](https://mintcdn.com/typewise/ht7a5v6EXYgQrv7K/images/documentation/integrations/zendesk-oauth/zendesk-identifier.webp?fit=max\&auto=format\&n=ht7a5v6EXYgQrv7K\&q=85\&s=a1384f5d9d76de873095cd3060beb75f)

* **Client Secret:** The secret shown once after saving the OAuth client.

  ![Client Secret](https://mintcdn.com/typewise/ht7a5v6EXYgQrv7K/images/documentation/integrations/zendesk-oauth/zendesk-secret-key.webp?fit=max\&auto=format\&n=ht7a5v6EXYgQrv7K\&q=85\&s=eac4bff99530772f4f60e0d3c31d7288)

After you click `Install`, Zendesk should be connected successfully.

> [!TIP]
>
> To have the AI Agent assess new tickets created in Zendesk, set up [Zendesk
> ticket
> ingestion](https://docs.typewise.app/documentation/integrations/supported/zendesk-ticket-ingestion.md) on
> top of this connection.

## Supported tools

The following is a selection of commonly used tools available through the
Zendesk integration. Additional lookups and actions are available. Contact us if
you need a tool that isn't listed here.

### Lookups

> [accordion] get\_ticket\_by\_id
>
> Retrieve a Zendesk ticket by its ID.
>
> | Parameter | Description | Required | Default |
> | :- | :- | :-: | :- |
> | `ticket_id` | The ID of the ticket to retrieve. | Yes | |

> [accordion] get\_ticket\_comments
>
> Retrieve all comments for a Zendesk ticket.
>
> | Parameter | Description | Required | Default |
> | :- | :- | :-: | :- |
> | `ticket_id` | The ID of the ticket to get comments for. | Yes | |

> [accordion] search\_articles
>
> Search for Zendesk Help Center articles.
>
> | Parameter | Description | Required | Default |
> | :- | :- | :-: | :- |
> | `query` | The search query. | Yes | |
> | `max_results` | Maximum number of results to return. | No | `5` |

> [accordion] get\_user\_info
>
> Get information about a Zendesk user.
>
> | Parameter | Description | Required | Default |
> | :- | :- | :-: | :- |
> | `user_id` | The ID of the user to retrieve information for. | Yes | |

> [accordion] More lookups available
>
> Additional Zendesk lookup tools are available. Contact us to enable lookups not listed here.

### Actions

> [accordion] update\_sender\_email
>
> Update the email address of a Zendesk sender.
>
> | Parameter | Description | Required | Default |
> | :- | :- | :-: | :- |
> | `sender_id` | The ID of the sender to update. | Yes | |
> | `new_email` | The new email to update the sender to. | Yes | |

> [accordion] More actions available
>
> Additional Zendesk action tools are available. Contact us to enable actions not listed here.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.