Zendesk
The Zendesk toolkit connects Arcade to the Zendesk support platform, enabling agents and apps to manage tickets, retrieve comments, search knowledge base articles, and inspect account identity.
Capabilities
- Ticket management — list tickets with offset-based pagination, add comments (public or internal), and mark tickets as solved with an optional closing comment.
- Conversation history — fetch all comments on a ticket in order, including the original description, author IDs, timestamps, visibility flags, and file attachments.
- Knowledge base search — search published Help Center articles by query, labels, or date filters; all filters can be combined in a single call with offset-based pagination.
- Account introspection — retrieve the authenticated user's profile, role, organization, and full Zendesk account context.
OAuth
This toolkit uses OAuth 2.0 via the Zendesk Arcade auth provider. See the provider docs for authorization details: Arcade Zendesk Auth Provider.
Secrets
ZENDESK_SUBDOMAIN — Your Zendesk subdomain, which identifies your specific Zendesk account. It is the prefix in your Zendesk URL: for https://yourcompany.zendesk.com, the subdomain is yourcompany. You can confirm it by logging into your Zendesk account and inspecting the URL. This value is not a credential but is required so the toolkit knows which Zendesk instance to target.
Configure secrets in the Arcade dashboard or via the API: Arcade Tool Secrets Guide. You can manage secret values directly at https://api.arcade.dev/dashboard/auth/secrets.
Available tools(6)
| Tool name | Description | Secrets | |
|---|---|---|---|
Add a comment to an existing Zendesk ticket.
The returned ticket object includes an 'html_url' field with the direct link
to view the ticket in Zendesk. | 1 | ||
Get all comments for a specific Zendesk ticket, including the original description.
The first comment is always the ticket's original description/content.
Subsequent comments show the conversation history.
Each comment includes:
- author_id: ID of the comment author
- body: The comment text
- created_at: Timestamp when comment was created
- public: Whether the comment is public or internal
- attachments: List of file attachments (if any) with file_name, content_url, size, etc. | 1 | ||
List tickets from your Zendesk account with offset-based pagination.
By default, returns tickets sorted by ID with newest tickets first (desc).
Each ticket in the response includes an 'html_url' field with the direct link
to view the ticket in Zendesk.
PAGINATION:
- The response includes 'next_offset' when more results are available
- To fetch the next batch, simply pass the 'next_offset' value as the 'offset' parameter
- If 'next_offset' is not present, you've reached the end of available results | 1 | ||
Mark a Zendesk ticket as solved, optionally with a final comment.
The returned ticket object includes an 'html_url' field with the direct link
to view the ticket in Zendesk. | 1 | ||
Search for Help Center articles in your Zendesk knowledge base.
This tool searches specifically for published knowledge base articles that provide
solutions and guidance to users. At least one search parameter (query or label_names)
must be provided.
PAGINATION:
- The response includes 'next_offset' when more results are available
- To fetch the next batch, simply pass the 'next_offset' value as the 'offset' parameter
- If 'next_offset' is not present, you've reached the end of available results
- The tool automatically handles fetching from the correct page based on your offset
IMPORTANT: ALL FILTERS CAN BE COMBINED IN A SINGLE CALL
You can combine multiple filters (query, labels, dates) in one search request.
Do NOT make separate tool calls - combine all relevant filters together. | 1 | ||
Get comprehensive user profile and Zendesk account information.
This tool provides detailed information about the authenticated user including
their name, email, role, organization details, and Zendesk account context. | 1 |