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

# Zendesk integration

[Back to list of enterprise systems](https://koreai.mintlify.site/agent-platform/integrations/enterprise-systems.md)

Use the Zendesk integration to create and manage support tickets, organizations, and users through Action Tools. It also provides triggers for ticket, organization, and user events.

| Authentication | Actions | Triggers |
| - | - | - |
| OAuth 2.0 or API token | ([13](https://koreai.mintlify.site/agent-platform/integrations/enterprise-systems/zendesk#supported-actions)) | ([8](https://koreai.mintlify.site/agent-platform/integrations/enterprise-systems/zendesk#triggers)) |

## Supported actions

| Action | Use it to |
| - | - |
| [Create Ticket](#create-ticket) | Create a Zendesk ticket. |
| [Update Ticket](#update-ticket) | Update ticket fields or status. |
| [Add Tag to Ticket](#add-tag-to-ticket) | Add one or more tags to a ticket. |
| [Add Comment to Ticket](#add-comment-to-ticket) | Add a public or private comment to a ticket. |
| [Create Organization](#create-organization) | Create an organization. |
| [Update Organization](#update-organization) | Update an organization. |
| [Create User](#create-user) | Create a user. |
| [Delete User](#delete-user) | Delete a user and associated records. |
| [Find Organization(s)](#find-organizations) | Search for organizations. |
| [Find Ticket(s)](#find-tickets) | Search for tickets. |
| [Find User(s)](#find-users) | Search for users. |
| [Update User](#update-user) | Update a user. |
| [Custom API Call](#custom-api-call) | Call a Zendesk API endpoint. |

## Triggers

| Trigger | Fires when |
| - | - |
| New ticket in view | A new ticket is created in the selected view. |
| New Ticket | A ticket is created, optionally filtered by organization. Requires a Zendesk Trigger with **Notify active webhook**. |
| Updated Ticket | An existing ticket is updated. Requires a Zendesk Trigger with **Notify active webhook**. |
| Tag Added to Ticket | A ticket update adds the selected tag, or any tag if no tag is specified. Requires a Zendesk Trigger with **Notify active webhook**. |
| New Organization | An organization is created. Uses a Zendesk event webhook; no Zendesk Trigger is needed. |
| New User | A user is created, optionally filtered by role. Uses a Zendesk event webhook; no Zendesk Trigger is needed. |
| New Suspended Ticket | A ticket is suspended. Suspended tickets are automatically deleted after 14 days. Requires a Zendesk Trigger with **Notify active webhook**. |
| New Action on Ticket | The specified ticket is updated. Requires a Zendesk Trigger with **Notify active webhook**. |

## Prerequisites

* A Zendesk account and its subdomain.
* A Zendesk agent email and API token, or an OAuth 2.0 access token.
* For triggers that require **Notify active webhook**, a Zendesk Trigger configured to send the event to the webhook endpoint used by the integration.

## Set up the integration

**1. Connect Zendesk**

In **Integrations**, select **Zendesk** > **Connect**. On **Project Auth Profiles**, select **New Profile** > **Integration Profile** > **Zendesk** > **Continue**. Configure the profile with your Zendesk subdomain and either OAuth 2.0 credentials or an API token. For an API token, provide the email address of the Zendesk agent it belongs to; leave the email empty for OAuth 2.0. Save the profile.

**2. Create the action tool**

In **Tools**, select **New Tool** > **Action** > **Zendesk** > **Continue**. Select the **Action** and **Auth Profile**, configure the inputs, and select **Create Tool**. Then [assign the tool to an agent](https://koreai.mintlify.site/agent-platform/tools/actions.md#assign-an-action-to-an-agent).

## Action reference

The fields below are the required inputs listed for each action in the connector catalog. Studio may also show optional settings for the selected action; configure those in the tool builder as needed.

> [accordion] Create Ticket
>
> | Required parameter | Type | Description |
> | - | - | - |
> | `organization_id` | string | ID of the organization associated with the ticket. |

> [accordion] Update Ticket
>
> | Required parameter | Type | Description |
> | - | - | - |
> | `ticket_id` | string | ID of the ticket to update. |
> | `organization_id` | string | ID of the organization associated with the ticket. |

> [accordion] Add Tag to Ticket
>
> | Required parameter | Type | Description |
> | - | - | - |
> | `ticket_id` | string | ID of the ticket. |
> | `tags` | array | Tags to add to the ticket. |

> [accordion] Add Comment to Ticket
>
> | Required parameter | Type | Description |
> | - | - | - |
> | `ticket_id` | string | ID of the ticket. |

> [accordion] Create Organization
>
> | Required parameter | Type | Description |
> | - | - | - |
> | `name` | string | Name of the organization. |

> [accordion] Update Organization
>
> | Required parameter | Type | Description |
> | - | - | - |
> | `organization_id` | string | ID of the organization to update. |

> [accordion] Create User
>
> | Required parameter | Type | Description |
> | - | - | - |
> | `name` | string | Name of the user. |
> | `organization_id` | string | ID of the user's organization. |

> [accordion] Delete User
>
> | Required parameter | Type | Description |
> | - | - | - |
> | `user_id` | string | ID of the user to delete. |
> | `confirmation` | boolean | Confirmation to proceed with deleting the user and associated records. |

> [accordion] Find Organization(s)
>
> | Required parameter | Type | Description |
> | - | - | - |
> | `search_type` | enum | Organization search criteria. |

> [accordion] Find Ticket(s)
>
> | Required parameter | Type | Description |
> | - | - | - |
> | `search_type` | enum | Ticket search criteria. |

> [accordion] Find User(s)
>
> | Required parameter | Type | Description |
> | - | - | - |
> | `search_type` | enum | User search criteria. |

> [accordion] Update User
>
> | Required parameter | Type | Description |
> | - | - | - |
> | `user_id` | string | ID of the user to update. |

> [accordion] Custom API Call
>
> | Required parameter | Type | Description |
> | - | - | - |
> | `url` | string | Zendesk API endpoint URL. |
> | `method` | string | HTTP method for the request. |
> | `headers` | object | Request headers. |
> | `queryParams` | object | Query string parameters. |

## Trigger reference

> [accordion] New ticket in view
>
> | Parameter | Type | Required | Description |
> | - | - | - | - |
> | `view_id` | dropdown | Yes | Zendesk view to monitor for new tickets. |

> [accordion] New Ticket
>
> | Parameter | Type | Required | Description |
> | - | - | - | - |
> | `organization_id` | dropdown | No | Filter tickets by organization; leave empty for all organizations. |

> [accordion] Updated Ticket
>
> | Parameter | Type | Required | Description |
> | - | - | - | - |
> | `organization_id` | dropdown | No | Filter tickets by organization; leave empty for all organizations. |

> [accordion] Tag Added to Ticket
>
> | Parameter | Type | Required | Description |
> | - | - | - | - |
> | `specific_tag` | string | No | Only trigger when this tag is added; leave empty for any tag. |

> [accordion] New Organization
>
> No input parameters. Uses a Zendesk event webhook; no Zendesk Trigger is needed.

> [accordion] New User
>
> | Parameter | Type | Required | Description |
> | - | - | - | - |
> | `user_role` | dropdown | No | Filter by **All Roles**, **End User**, **Agent**, or **Admin**. |

> [accordion] New Suspended Ticket
>
> | Parameter | Type | Required | Description |
> | - | - | - | - |
> | `organization_filter` | string | No | Filter by organization ID; leave empty for all organizations. Suspended tickets are automatically deleted after 14 days. |

> [accordion] New Action on Ticket
>
> | Parameter | Type | Required | Description |
> | - | - | - | - |
> | `ticket_id` | number | Yes | ID of the ticket to monitor for updates. |

## Troubleshoot common issues

| Issue | Resolution |
| - | - |
| Authentication fails | Check the Zendesk subdomain and token. For an API token, provide the matching Zendesk agent email; leave it empty for OAuth 2.0. |
| An action can't find a record | Verify the record ID and confirm that the authorized account can access it. |
| A webhook trigger doesn't fire | Confirm that the Zendesk Trigger is active, uses **Notify active webhook**, and targets the integration's webhook endpoint. |
| A ticket trigger returns no events | Check the selected view, organization filter, tag, or ticket ID. Suspended tickets are automatically deleted after 14 days. |

## Related articles

* [Auth profiles](https://koreai.mintlify.site/agent-platform/administration/integrations-settings.md#auth-profiles)
* [Action Tools](https://koreai.mintlify.site/agent-platform/tools/actions.md)
* [Zendesk developer documentation](https://developer.zendesk.com/documentation/)


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