Zendesk
0.3.1
Arcade's Zendesk toolkit enables seamless integration with Zendesk's customer service platform, allowing developers to interact with tickets and knowledge base articles efficiently.
Capabilities
- Retrieve and manage ticket comments and statuses.
- List and paginate through tickets for dynamic retrieval.
- Search for Help Center articles using various parameters.
- Fetch comprehensive user profiles and account information.
OAuth
- Auth Type: OAuth2
- Provider: Unknown
- Scopes: read, tickets:write
Secrets
- Secret types: unknown, api_key
- Example: ZENDESK_SUBDOMAIN
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 |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
Zendesk.AddTicketComment
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ticket_id | integer | Required | The ID of the ticket to comment on |
comment_body | string | Required | The text of the comment |
public | boolean | Optional | Whether the comment is public (visible to requester) or internal. Defaults to True |
Requirements
Output
json— A dictionary containing the result of the comment operation and ticket URLZendesk.GetTicketComments
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ticket_id | integer | Required | The ID of the ticket to get comments for |
Requirements
Output
json— A dictionary containing the ticket comments, metadata, and ticket URLZendesk.ListTickets
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
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
status | string | Optional | The status of tickets to filter by. Defaults to 'open'newopenpendingsolvedclosed |
limit | integer | Optional | Number of tickets to return. Defaults to 30 |
offset | integer | Optional | Number of tickets to skip before returning results. Defaults to 0 |
sort_order | string | Optional | Sort order for tickets by ID. 'asc' returns oldest first, 'desc' returns newest first. Defaults to 'desc'ascdesc |
Requirements
Output
json— A dictionary containing tickets list (each with html_url), count, and pagination metadata. Includes 'next_offset' when more results are availableZendesk.MarkTicketSolved
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ticket_id | integer | Required | The ID of the ticket to mark as solved |
comment_body | string | Optional | Optional final comment to add when solving the ticket |
comment_public | boolean | Optional | Whether the comment is visible to the requester. Defaults to False |
Requirements
Output
json— A dictionary containing the result of the solve operationZendesk.SearchArticles
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
query | string | Optional | Search text to match against articles. Supports quoted expressions for exact matching |
label_names | array<string> | Optional | List of label names to filter by (case-insensitive). Article must have at least one matching label. Available on Professional/Enterprise plans only |
created_after | string | Optional | Filter articles created after this date (format: YYYY-MM-DD) |
created_before | string | Optional | Filter articles created before this date (format: YYYY-MM-DD) |
created_at | string | Optional | Filter articles created on this exact date (format: YYYY-MM-DD) |
sort_by | string | Optional | Field to sort articles by. Defaults to relevance according to the search querycreated_atrelevance |
sort_order | string | Optional | Sort order direction. Defaults to descendingascdesc |
limit | integer | Optional | Number of articles to return. Defaults to 30 |
offset | integer | Optional | Number of articles to skip before returning results. Defaults to 0 |
include_body | boolean | Optional | Include article body content in results. Bodies will be cleaned of HTML and truncated |
max_article_length | integer | Optional | Maximum length for article body content in characters. Set to None for no limit. Defaults to 500 |
Requirements
Output
json— Article search results with pagination metadata. Includes 'next_offset' when more results are available. Simply use this value as the 'offset' parameter in your next call to fetch the next batchZendesk.WhoAmI
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.
Parameters
No parameters required.
Requirements
Output
json— Get comprehensive user profile and Zendesk account information.