Zendesk

Zendesk Support: list, search, read, create and update tickets, add comments, look up users and organizations.

10 actions API key 7 read3 write Calls zendesk.com

Connect

TypeScript

const conn = await setu.connections.initiate({ userId: "user_1", toolkit: "zendesk" });
console.log(conn.connectUrl); // show this to your user
await conn.waitUntilActive();

Permissions requested

This toolkit uses a single credential and requests no scopes.

Actions

Add ticket commentwritezendesk.add_ticket_commentAdd a comment to a ticket: a public reply to the requester (public true, the default) or an internal note (public false).

Input	Type		Description
`ticket_id`	integer	Required	Ticket ID
`body`	string	Required	Comment text
`public`	boolean	Optional	True for a public reply, false for an internal note

TypeScript

await setu.execute({
  userId: "user_1",
  action: "zendesk.add_ticket_comment",
  input: {
    "ticket_id": 1,
    "body": "<body>"
  },
});

Create ticketwritezendesk.create_ticketCreate a Zendesk ticket with a subject and a first comment. The first comment becomes the ticket description.

Input	Type		Description
`subject`	string	Required	Ticket subject
`comment`	string	Required	Text of the first comment
`priority`	string	Optional	Ticket priority
`requester_id`	integer	Optional	User ID of the requester (defaults to the agent who owns the token)

TypeScript

await setu.execute({
  userId: "user_1",
  action: "zendesk.create_ticket",
  input: {
    "subject": "<subject>",
    "comment": "<comment>"
  },
});

Get organizationreadzendesk.get_organizationGet one Zendesk organization by ID, including its domains, notes and tags.

Input	Type		Description
`organization_id`	integer	Required	Organization ID

TypeScript

await setu.execute({
  userId: "user_1",
  action: "zendesk.get_organization",
  input: {
    "organization_id": 1
  },
});

Get ticketreadzendesk.get_ticketGet one ticket's properties by its numeric ID. The comment thread is not included: use list_ticket_comments for that.

Input	Type		Description
`ticket_id`	integer	Required	Ticket ID

TypeScript

await setu.execute({
  userId: "user_1",
  action: "zendesk.get_ticket",
  input: {
    "ticket_id": 1
  },
});

List organizationsreadzendesk.list_organizationsList the organizations (customer companies) in Zendesk.

Input	Type		Description
`per_page`	integer	Optional	How many to return (max 100)

TypeScript

await setu.execute({
  userId: "user_1",
  action: "zendesk.list_organizations",
  input: {},
});

List ticket commentsreadzendesk.list_ticket_commentsList the comments on a ticket (public replies and internal notes), oldest first.

Input	Type		Description
`ticket_id`	integer	Required	Ticket ID

TypeScript

await setu.execute({
  userId: "user_1",
  action: "zendesk.list_ticket_comments",
  input: {
    "ticket_id": 1
  },
});

List ticketsreadzendesk.list_ticketsList tickets in the Zendesk account, oldest first by default. Use search_tickets to filter by status, assignee or text.

Input	Type		Description
`per_page`	integer	Optional	How many tickets to return (max 100)

TypeScript

await setu.execute({
  userId: "user_1",
  action: "zendesk.list_tickets",
  input: {},
});

Search tickets and other recordsreadzendesk.search_ticketsSearch Zendesk with its query syntax, for example 'type:ticket status:open assignee:me' or free text. Returns the matching records with their type.

Input	Type		Description
`query`	string	Required	Zendesk search query, e.g. 'type:ticket status:open priority:high'
`sort_by`	string	Optional	Sort field
`sort_order`	string	Optional	Sort direction

TypeScript

await setu.execute({
  userId: "user_1",
  action: "zendesk.search_tickets",
  input: {
    "query": "<query>"
  },
});

Search usersreadzendesk.search_usersFind Zendesk users (agents and end users) by name or email.

Input	Type		Description
`query`	string	Required	Name or email to search for

TypeScript

await setu.execute({
  userId: "user_1",
  action: "zendesk.search_users",
  input: {
    "query": "<query>"
  },
});

Update ticketwritezendesk.update_ticketChange a ticket's status, priority, assignee or subject. To reply or add a note use add_ticket_comment.

Input	Type		Description
`ticket_id`	integer	Required	Ticket ID
`status`	string	Optional	Ticket status
`priority`	string	Optional	Ticket priority
`assignee_id`	integer	Optional	User ID of the agent to assign
`subject`	string	Optional	New subject

TypeScript

await setu.execute({
  userId: "user_1",
  action: "zendesk.update_ticket",
  input: {
    "ticket_id": 1
  },
});