Read and create Zendesk support tickets and look up users via the Zendesk REST API v2.

Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

Zendesk

Read and create Zendesk support tickets and look up users via the Zendesk REST API v2.

Base URL: https://{subdomain}.zendesk.com/api/v2

Operations

operation	method & endpoint	required inputs
`list_tickets`	`GET /api/v2/tickets.json`	—
`get_ticket`	`GET /api/v2/tickets/{ticketId}.json`	`ticketId`
`create_ticket`	`POST /api/v2/tickets.json`	`subject`, `body` (optional `priority`)
`list_users`	`GET /api/v2/users.json`	—
`search_users`	`GET /api/v2/users/search.json?query=...`	`query`

Every operation also requires apiKey, subdomain, and email.

Authentication

Zendesk uses HTTP Basic auth with the credential string:

{email}/token:{apiKey}

base64-encoded into the Authorization: Basic <encoded> header. This tool builds that header for you from the email, subdomain, and apiKey inputs.

Getting an API token

In Zendesk, open Admin Center.
Go to Apps and integrations > APIs > Zendesk API.
On the Settings tab, enable Token access and click Add API token.
Copy the generated token (shown only once) — this is your apiKey.
Use any agent/admin email on your account as email, and your account's subdomain (the part before .zendesk.com) as subdomain.

Inputs

apiKey (required) — Zendesk API token.
operation (required) — one of the operations above.
subdomain (required) — your Zendesk subdomain.
email (required) — agent email for Basic auth.
ticketId — for get_ticket.
subject, body, priority — for create_ticket (priority is one of urgent, high, normal, low).
query — for search_users.

Outputs

result — the raw JSON response body from Zendesk (as a string).
status — the HTTP status code (e.g. 200, 201).

Examples

List the most recent tickets

apiKey:    <your-api-token>
subdomain: acme
email:     [email protected]
operation: list_tickets

Returns the tickets array in result with status 200.

Create a ticket

apiKey:    <your-api-token>
subdomain: acme
email:     [email protected]
operation: create_ticket
subject:   Printer on 3rd floor is offline
body:      The shared printer stopped responding around 9am.
priority:  high

Returns the created ticket JSON in result with status 201.

Find a user by email

apiKey:    <your-api-token>
subdomain: acme
email:     [email protected]
operation: search_users
query:     [email protected]

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

error
result
status

Input Properties

Every property this tool accepts, from its own tool.iml.

Property	Type	Required	Default	Description
`apiKey`	string	yes	—	Zendesk API token. Create one in Zendesk Admin Center > Apps and integrations > APIs > Zendesk API > Settings > Add API token.
`operation`	string	yes	—	One of: list_tickets, get_ticket, create_ticket, list_users, search_users
`subdomain`	string	no	—	Your Zendesk subdomain (the {subdomain} in https://{subdomain}.zendesk.com). Required.
`email`	string	no	—	Agent email used for Basic auth as {email}/token:{apiKey}. Required.
`ticketId`	string	no	—	Ticket id for get_ticket.
`subject`	string	no	—	Subject line for create_ticket.
`priority`	string	no	—	Optional priority for create_ticket: urgent, high, normal, or low.
`query`	string	no	—	Search query for search_users (e.g. an email or name).