Zendesk

Zendesk integration (Communication, Productivity). Imported from open-connector.

OAuth11 toolshttps://{subdomain}.zendesk.com

GET

zendesk_get_current_user

Get the current authenticated Zendesk user.

/api/v2/users/me.json

GET

zendesk_list_tickets

List Zendesk tickets with offset or cursor pagination.

/api/v2/tickets.json

8 parameters

Param	Type	Required	Description
page	integer	optional	Offset pagination page number.
perPage	integer	optional	Maximum records to return for offset pagination.
pageSize	integer	optional	Maximum records to return for cursor pagination.
pageAfter	string	optional	Opaque cursor returned by the previous Zendesk page.
pageBefore	string	optional	Opaque cursor for retrieving the previous Zendesk page.
externalId	string	optional	External identifier used to filter tickets.
sortBy	string	optional	Zendesk field used to sort tickets.
sortOrder	string	optional	Zendesk sort direction.

GET

zendesk_get_ticket

Get a Zendesk ticket and its comments by identifier.

/api/v2/tickets/{ticketId}.json

1 parameter

Param	Type	Required	Description
ticketId	integer	required	Zendesk ticket identifier.

POST

zendesk_create_ticket

Create a Zendesk ticket with an initial comment.

/api/v2/tickets.json

16 parameters

Param	Type	Required	Description
subject	string	required	Ticket subject line.
description	string	optional	Plain-text body used for the initial or appended ticket comment.
htmlDescription	string	optional	HTML body used for the initial or appended ticket comment.
commentPublic	boolean	optional	Whether the generated comment is public when a comment is included.
status	string	optional	Zendesk ticket status accepted by update operations.
priority	string	optional	Zendesk ticket priority.
ticketType	string	optional	Zendesk ticket type.
assigneeId	integer	optional	Agent identifier assigned to the ticket.
groupId	integer	optional	Group identifier assigned to the ticket.
organizationId	integer	optional	Organization identifier for the ticket.
requesterId	integer	optional	Existing requester identifier.
externalId	string	optional	External identifier linked to the ticket.
dueAt	string	optional	Task due timestamp in ISO 8601 format.
tags	array	optional	Zendesk tag values.
customFields	array	optional	Custom field values applied to the ticket.
requester	object	optional	Requester object used when creating a ticket.

PUT

zendesk_update_ticket

Update fields on an existing Zendesk ticket.

/api/v2/tickets/{ticketId}.json

19 parameters

Param	Type	Required	Description
ticketId	integer	required	Zendesk ticket identifier.
subject	string	optional	Ticket subject line.
description	string	optional	Plain-text body used for the initial or appended ticket comment.
htmlDescription	string	optional	HTML body used for the initial or appended ticket comment.
commentPublic	boolean	optional	Whether the generated comment is public when a comment is included.
status	string	optional	Zendesk ticket status accepted by update operations.
priority	string	optional	Zendesk ticket priority.
ticketType	string	optional	Zendesk ticket type.
assigneeId	integer	optional	Agent identifier assigned to the ticket.
groupId	integer	optional	Group identifier assigned to the ticket.
organizationId	integer	optional	Organization identifier for the ticket.
requesterId	integer	optional	Existing requester identifier.
externalId	string	optional	External identifier linked to the ticket.
dueAt	string	optional	Task due timestamp in ISO 8601 format.
tags	array	optional	Zendesk tag values.
customFields	array	optional	Custom field values applied to the ticket.
safeUpdate	boolean	optional	Whether to enable optimistic locking for ticket updates.
updatedStamp	string	optional	Last known ticket updated_at timestamp used with safeUpdate.
metadata	object	optional	Additional Zendesk object fields.

PUT

zendesk_reply_to_ticket

Append a public reply or internal note to a Zendesk ticket.

/api/v2/tickets/{ticketId}.json

4 parameters

Param	Type	Required	Description
ticketId	integer	required	Zendesk ticket identifier.
body	string	required	Comment body to append to the ticket.
public	boolean	optional	Whether the appended comment is public. Defaults to true.
assigneeId	integer	optional	Agent identifier assigned together with the reply.

GET

zendesk_list_users

List Zendesk users with optional role and pagination filters.

/api/v2/users.json

9 parameters

Param	Type	Required	Description
page	integer	optional	Offset pagination page number.
perPage	integer	optional	Maximum records to return for offset pagination.
pageSize	integer	optional	Maximum records to return for cursor pagination.
pageAfter	string	optional	Opaque cursor returned by the previous Zendesk page.
pageBefore	string	optional	Opaque cursor for retrieving the previous Zendesk page.
role	string	optional	Zendesk user role.
roleList	array	optional	Roles included in the user filter.
externalId	string	optional	External identifier used to filter users.
permissionSet	integer	optional	Zendesk custom role identifier.

GET

zendesk_get_user

Get a Zendesk user by identifier.

/api/v2/users/{userId}.json

1 parameter

Param	Type	Required	Description
userId	integer	required	Zendesk user identifier.

GET

zendesk_search_users

Search Zendesk users by email address or name.

/api/v2/users/search.json

4 parameters

Param	Type	Required	Description
email	string	optional	User email used for the Zendesk search.
name	string	optional	User name fragment used for the Zendesk search.
page	integer	optional	Offset pagination page number.
perPage	integer	optional	Maximum records to return for offset pagination.

GET

zendesk_list_organizations

List Zendesk organizations with pagination.

/api/v2/organizations.json

2 parameters

Param	Type	Required	Description
page	integer	optional	Offset pagination page number.
perPage	integer	optional	Maximum records to return for offset pagination.

GET

zendesk_get_organization

Get a Zendesk organization by identifier.

/api/v2/organizations/{organizationId}.json

1 parameter

Param	Type	Required	Description
organizationId	integer	required	Zendesk organization identifier.