What can you do with it?
Manage your customer support operations with Zendesk, including retrieving tickets, creating new support tickets, searching for specific tickets, and handling customer service workflows efficiently.
How to use it?
Basic Command Structure
/your-zendesk-connection [action] [required-parameters] [optional-parameters]
Parameters
Required:
action
- The operation to perform (get-tickets, create-ticket, search-ticket)
Optional:
ticket-id
- Zendesk ticket ID for searches
priority
- Ticket priority level (low, normal, high, urgent)
subject
- Ticket subject line
body
- Ticket description content
query
- Search query parameters
Get Tickets
Retrieve a list of all tickets
Parameters:
- No additional parameters required
Example:
/your-zendesk-connection
action: get-tickets
Response:
{
"tickets": [
{
"id": 945,
"url": "https://d3v-pinkfish.zendesk.com/api/v2/tickets/945.json",
"external_id": null,
"created_at": "2024-07-26T02:46:43Z",
"updated_at": "2024-08-24T20:01:10Z",
"type": "question",
"subject": "Subject",
"raw_subject": "Subject",
"description": "Description",
"priority": null,
"status": "closed",
"recipient": null,
"requester_id": 410103033914,
"submitter_id": 410103033914,
"assignee_id": 410103033914,
"organization_id": 370356337994,
"group_id": 360010100594,
"collaborator_ids": [],
"follower_ids": [],
"email_cc_ids": [],
"forum_topic_id": null,
"problem_id": null,
"has_incidents": false,
"is_public": true,
"due_at": null,
"tags": [],
"custom_fields": [],
"satisfaction_rating": {
"score": "unoffered"
},
"sharing_agreement_ids": [],
"custom_status_id": 1500006665241,
"encoded_id": "PG54EL-Y99VD",
"fields": [],
"followup_ids": [],
"ticket_form_id": 360003653613,
"brand_id": 360004648614,
"allow_channelback": false,
"allow_attachments": true,
"from_messaging_channel": false
}
]
}
Create Ticket
Create a new support ticket
Parameters:
subject
(required) - The ticket subject line
body
(required) - The ticket description/body content
priority
(optional) - Priority level (low, normal, high, urgent)
ticket-type
(optional) - Type of ticket (question, incident, problem, task)
Example:
/your-zendesk-connection
action: create-ticket
subject: My printer is on fire!
body: The smoke is very colorful.
priority: urgent
Response:
{
"ticket": {
"id": 946,
"url": "https://d3v-pinkfish.zendesk.com/api/v2/tickets/946.json",
"external_id": null,
"created_at": "2024-07-26T02:46:43Z",
"updated_at": "2024-07-26T02:46:43Z",
"type": "question",
"subject": "My printer is on fire!",
"raw_subject": "My printer is on fire!",
"description": "The smoke is very colorful.",
"priority": "urgent",
"status": "new",
"recipient": null,
"requester_id": 410103033914,
"submitter_id": 410103033914,
"assignee_id": null,
"organization_id": 370356337994,
"group_id": 360010100594,
"collaborator_ids": [],
"follower_ids": [],
"email_cc_ids": [],
"forum_topic_id": null,
"problem_id": null,
"has_incidents": false,
"is_public": true,
"due_at": null,
"tags": [],
"custom_fields": [],
"satisfaction_rating": {
"score": "unoffered"
}
},
"audit": {
"id": 12345,
"ticket_id": 946,
"created_at": "2024-07-26T02:46:43Z",
"author_id": 410103033914,
"metadata": {},
"events": []
}
}
Search Ticket
Search for a specific ticket by ID
Parameters:
ticket-id
(required) - The ticket ID to search for
Example:
/your-zendesk-connection
action: search-ticket
ticket-id: 945
Response:
{
"results": [
{
"id": 945,
"url": "https://d3v-pinkfish.zendesk.com/api/v2/tickets/945.json",
"external_id": null,
"created_at": "2024-07-26T02:46:43Z",
"updated_at": "2024-08-24T20:01:10Z",
"type": "question",
"subject": "Subject",
"raw_subject": "Subject",
"description": "Description",
"priority": null,
"status": "closed",
"recipient": null,
"requester_id": 410103033914,
"submitter_id": 410103033914,
"assignee_id": 410103033914,
"organization_id": 370356337994,
"group_id": 360010100594,
"collaborator_ids": [],
"follower_ids": [],
"email_cc_ids": [],
"forum_topic_id": null,
"problem_id": null,
"has_incidents": false,
"is_public": true,
"due_at": null,
"tags": [],
"custom_fields": [],
"satisfaction_rating": {
"score": "unoffered"
}
}
],
"facets": null,
"next_page": null,
"previous_page": null,
"count": 1
}
Notes
When working with Zendesk API through a proxy, always URL-encode search parameters. For pagination, extract the path from next_page URLs and reconstruct with your proxy base URL rather than using raw URLs directly. Ticket statuses include new, open, pending, hold, solved, and closed. Priority levels are low, normal, high, and urgent.