Zendesk

Manage Zendesk support tickets, comments, users and organizations, and search across all of them.

Actions

Action	What it does
Add ticket comment	Add a reply or an internal note to an existing ticket.
Create organization	Create an organization to group users by company.
Create ticket	Create a Zendesk ticket with a subject and description, and optionally set the requester, priority, type, status, tags, assignee and group.
Create user	Add an end user, agent or admin to Zendesk.
Delete organization	Permanently delete an organization from Zendesk.
Delete ticket	Delete a ticket.
Delete user	Deactivate a user.
Get connected account	Show which Zendesk account this connection acts as, and what role it has.
Get organization	Retrieve every field of a single Zendesk organization.
Get ticket	Retrieve every field of a single Zendesk ticket.
Get user	Retrieve every field of a single Zendesk user.
List groups	List the agent groups tickets can be assigned to, with their numeric ids.
List organizations	List the account's organizations.
List ticket comments	Read the full conversation on a ticket, oldest first by default.
List tickets	List the account's tickets, newest or oldest first.
Search users	Find users by name, email address or external id: the usual way to turn an email address into a Zendesk user id.
Search Zendesk	Search tickets, users, organizations and groups with Zendesk search syntax, for example 'type:ticket status:open'.
Update organization	Change an organization's name, email domains, details, notes or tags.
Update ticket	Change a ticket's subject, status, priority, type, assignee, group or tags.
Update user	Change a user's name, email, role, phone, organization, tags or notes.

Add ticket comment

Add a reply or an internal note to an existing ticket. A public comment is visible to the requester; a private one is not.

Inputs

Ticketticket_idnumberRequired: The ticket's numeric id, for example 12345.
CommentcommenttextRequired: The text to add to the ticket.
Visible to the requesterpublictrue/false: On posts a public reply the requester can see. Off leaves an internal note for agents only.Default: true.

Outputs

publictrue/false
statustext: Status of the action execution ("success" on success).
ticketobject
ticket_idnumber
urltext

Example output

{
  "public": true,
  "status": "success",
  "ticket": {
    "id": 12345,
    "status": "open",
    "subject": "Printer on fire"
  },
  "ticket_id": 12345,
  "url": "https://acme.zendesk.com/agent/tickets/12345"
}

Create organization

Create an organization to group users by company. The name must be unique across the account.

Inputs

NamenametextRequired: The organization's name. Must be unique in the account.
Email domainsdomain_nameslist: Email domains that automatically place new users in this organization, for example acme.com.
Detailsdetailstext: Details about the organization, visible to agents.
Notesnotestext: Internal notes about the organization.
Tagstagslist: Tags to put on the new organization.

Outputs

organizationobject
organization_idnumber
statustext: Status of the action execution ("success" on success).

Example output

{
  "organization": {
    "id": 24680,
    "name": "Acme Corp"
  },
  "organization_id": 24680,
  "status": "success"
}

Create ticket

Create a Zendesk ticket with a subject and description, and optionally set the requester, priority, type, status, tags, assignee and group.

Inputs

SubjectsubjecttextRequired: One line summarising the issue.
DescriptiondescriptiontextRequired: The body of the request. This becomes the ticket's first comment.
Requester emailrequester_emailtext: Email address of the person the ticket is for. Zendesk creates the user if it does not recognise the address. Leave empty to file the ticket under the connected account.
Requester namerequester_nametext: Name to give a requester Zendesk has not seen before. Needs a requester email as well.
Priorityprioritytext: How urgent the ticket is.One of: low, normal, high, urgent.
Typeticket_typetext: What kind of work the ticket represents.One of: problem, incident, question, task.
Statusstatustext: Status to open the ticket in. Defaults to New.One of: new, open, pending, hold (On hold), solved, closed.
Tagstagslist: Tags to put on the new ticket.
Assigneeassignee_idnumber: Numeric id of the agent to assign. Use Search users to find one. Leave empty to leave the ticket unassigned.
Groupgroup_idtext: Assign the ticket to this agent group. Leave empty to keep it as is.

Outputs

statustext: Status of the action execution ("success" on success).
ticketobject
ticket_idnumber
urltext

Example output

{
  "status": "success",
  "ticket": {
    "id": 12345,
    "status": "open",
    "subject": "Printer on fire"
  },
  "ticket_id": 12345,
  "url": "https://acme.zendesk.com/agent/tickets/12345"
}

Create user

Add an end user, agent or admin to Zendesk. Only a name is required.

Inputs

NamenametextRequired: The person's full name.
Emailemailtext: Their email address. Must be unique in the account.
Roleroletext: What the person can do in Zendesk. Defaults to End user.One of: end-user (End user), agent, admin.
Phonephonetext: A contact phone number.
Organizationorganization_idnumber: Numeric id of the organization to file them under. Use List organizations to find one.
Tagstagslist: Tags to put on the new user.
Notesnotestext: Internal notes about this person, visible to agents.

Outputs

statustext: Status of the action execution ("success" on success).
userobject
user_idnumber

Example output

{
  "status": "success",
  "user": {
    "email": "sam@example.com",
    "id": 67890,
    "name": "Sam Rivera"
  },
  "user_id": 67890
}

Delete organization

Permanently delete an organization from Zendesk.

Inputs

Organizationorganization_idnumberRequired: The organization's numeric id. Use List organizations to find one.

Outputs

deletedtrue/false
organization_idnumber
statustext: Status of the action execution ("success" on success).

Example output

{
  "deleted": true,
  "organization_id": 24680,
  "status": "success"
}

Delete ticket

Delete a ticket. It moves to Zendesk's deleted-tickets list, where an admin can still restore it.

Inputs

Ticketticket_idnumberRequired: The ticket's numeric id, for example 12345.

Outputs

deletedtrue/false
statustext: Status of the action execution ("success" on success).
ticket_idnumber

Example output

{
  "deleted": true,
  "status": "success",
  "ticket_id": 12345
}

Delete user

Deactivate a user. Zendesk refuses if the person is the requester of any existing ticket.

Inputs

Useruser_idnumberRequired: The user's numeric id. Use Search users to find one.

Outputs

deletedtrue/false
statustext: Status of the action execution ("success" on success).
userobject
user_idnumber

Example output

{
  "deleted": true,
  "status": "success",
  "user": {
    "active": false,
    "id": 67890
  },
  "user_id": 67890
}

Get connected account

Show which Zendesk account this connection acts as, and what role it has. Useful for checking a connection works.

Inputs

None.

Outputs

emailtext
nametext
roletext
statustext: Status of the action execution ("success" on success).
userobject
user_idnumber

Example output

{
  "email": "sam@example.com",
  "name": "Sam Rivera",
  "role": "admin",
  "status": "success",
  "user": {
    "id": 67890,
    "name": "Sam Rivera"
  },
  "user_id": 67890
}

Get organization

Retrieve every field of a single Zendesk organization.

Inputs

Organizationorganization_idnumberRequired: The organization's numeric id. Use List organizations to find one.

Outputs

organizationobject
organization_idnumber
statustext: Status of the action execution ("success" on success).

Example output

{
  "organization": {
    "id": 24680,
    "name": "Acme Corp"
  },
  "organization_id": 24680,
  "status": "success"
}

Get ticket

Retrieve every field of a single Zendesk ticket.

Inputs

Ticketticket_idnumberRequired: The ticket's numeric id, for example 12345.

Outputs

statustext: Status of the action execution ("success" on success).
ticketobject
ticket_idnumber
urltext

Example output

{
  "status": "success",
  "ticket": {
    "id": 12345,
    "status": "open",
    "subject": "Printer on fire"
  },
  "ticket_id": 12345,
  "url": "https://acme.zendesk.com/agent/tickets/12345"
}

Get user

Retrieve every field of a single Zendesk user.

Inputs

Useruser_idnumberRequired: The user's numeric id. Use Search users to find one.

Outputs

statustext: Status of the action execution ("success" on success).
userobject
user_idnumber

Example output

{
  "status": "success",
  "user": {
    "email": "sam@example.com",
    "id": 67890,
    "name": "Sam Rivera"
  },
  "user_id": 67890
}

List groups

List the agent groups tickets can be assigned to, with their numeric ids.

Inputs

How manyper_pagenumber: How many records to return (1-100). Leave it out and you get the first 25, so set 100 when a list or digest should show everything that matches.From 1 to 100. Default: 25.
Hide deleted groupsexclude_deletedtrue/false: Leave on to list only groups still in use.Default: true.

Outputs

countnumber
groupslist
statustext: Status of the action execution ("success" on success).

Example output

{
  "count": 1,
  "groups": [
    {
      "id": 360001,
      "name": "Support"
    }
  ],
  "status": "success"
}

List organizations

List the account's organizations.

Inputs

How manyper_pagenumber: How many records to return (1-100). Leave it out and you get the first 25, so set 100 when a list or digest should show everything that matches.From 1 to 100. Default: 25.

Outputs

countnumber
organizationslist
statustext: Status of the action execution ("success" on success).

Example output

{
  "count": 1,
  "organizations": [
    {
      "id": 24680,
      "name": "Acme Corp"
    }
  ],
  "status": "success"
}

List ticket comments

Read the full conversation on a ticket, oldest first by default.

Inputs

Ticketticket_idnumberRequired: The ticket's numeric id, for example 12345.
How manyper_pagenumber: How many records to return (1-100). Leave it out and you get the first 25, so set 100 when a list or digest should show everything that matches.From 1 to 100. Default: 25.
Ordersort_ordertext: Which end of the list to start from.One of: asc (Oldest first), desc (Newest first).

Outputs

commentslist
countnumber
statustext: Status of the action execution ("success" on success).
ticket_idnumber

Example output

{
  "comments": [
    {
      "body": "Thanks for reporting.",
      "id": 1,
      "public": true
    }
  ],
  "count": 1,
  "status": "success",
  "ticket_id": 12345
}

List tickets

List the account's tickets, newest or oldest first.

Inputs

How manyper_pagenumber: How many records to return (1-100). Leave it out and you get the first 25, so set 100 when a list or digest should show everything that matches.From 1 to 100. Default: 25.
Sort bysort_bytext: Which field to order the tickets by.One of: assignee, created_at (Created), group, id (Ticket id), requester, status, subject, updated_at (Last updated).
Ordersort_ordertext: Which end of the list to start from.One of: asc (Oldest first), desc (Newest first).

Outputs

countnumber
statustext: Status of the action execution ("success" on success).
ticketslist

Example output

{
  "count": 1,
  "status": "success",
  "tickets": [
    {
      "id": 12345,
      "subject": "Printer on fire"
    }
  ]
}

Search users

Find users by name, email address or external id: the usual way to turn an email address into a Zendesk user id.

Inputs

Search termsquerytextRequired: A name, an email address, or part of one.
How manyper_pagenumber: How many records to return (1-100). Leave it out and you get the first 25, so set 100 when a list or digest should show everything that matches.From 1 to 100. Default: 25.

Outputs

countnumber
returnednumber
statustext: Status of the action execution ("success" on success).
userslist

Example output

{
  "count": 1,
  "returned": 1,
  "status": "success",
  "users": [
    {
      "id": 67890,
      "name": "Sam Rivera"
    }
  ]
}

Search Zendesk

Search tickets, users, organizations and groups with Zendesk search syntax, for example 'type:ticket status:open'.

Inputs

Search termsquerytextRequired: What to look for. Zendesk search syntax works here, such as type:ticket status:open priority:urgent. To look back from now, write the time with no spaces, such as created>30minutes or updated>2days.
Sort bysort_bytext: Which field to order results by. Defaults to relevance.One of: updated_at (Last updated), created_at (Created), priority, status, ticket_type (Type).
Ordersort_ordertext: Which end of the list to start from.One of: asc (Oldest first), desc (Newest first).
Pagepagenumber: Which page of results to read. Zendesk returns at most 1,000 results, so pages run from 1 to 10.From 1 to 10.
How manyper_pagenumber: How many records to return (1-100). Leave it out and you get the first 25, so set 100 when a list or digest should show everything that matches.From 1 to 100. Default: 25.

Outputs

countnumber
resultslist
returnednumber
statustext: Status of the action execution ("success" on success).

Example output

{
  "count": 1,
  "results": [
    {
      "id": 12345,
      "result_type": "ticket",
      "subject": "Printer on fire"
    }
  ],
  "returned": 1,
  "status": "success"
}

Update organization

Change an organization's name, email domains, details, notes or tags. Only the fields you set are changed.

Inputs

Organizationorganization_idnumberRequired: The organization's numeric id. Use List organizations to find one.
Namenametext: Replace the organization's name.
Email domainsdomain_nameslist: Replace the organization's email domains. This replaces the existing list rather than adding to it.
Detailsdetailstext: Replace the details shown to agents.
Notesnotestext: Replace the internal notes.
Tagstagslist: Tags to set. This replaces the existing tags rather than adding to them.

Outputs

organizationobject
organization_idnumber
statustext: Status of the action execution ("success" on success).

Example output

{
  "organization": {
    "id": 24680,
    "name": "Acme Corp"
  },
  "organization_id": 24680,
  "status": "success"
}

Update ticket

Change a ticket's subject, status, priority, type, assignee, group or tags. Only the fields you set are changed.

Inputs

Ticketticket_idnumberRequired: The ticket's numeric id, for example 12345.
Subjectsubjecttext: Replace the ticket's subject.
Statusstatustext: Move the ticket to this status.One of: new, open, pending, hold (On hold), solved, closed.
Priorityprioritytext: Change how urgent the ticket is.One of: low, normal, high, urgent.
Typeticket_typetext: Change what kind of work the ticket represents.One of: problem, incident, question, task.
Assigneeassignee_idnumber: Numeric id of the agent to assign. Use Search users to find one. Leave empty to leave the ticket unassigned.
Groupgroup_idtext: Assign the ticket to this agent group. Leave empty to keep it as is.
Tagstagslist: Tags to set. This replaces the existing tags rather than adding to them.

Outputs

statustext: Status of the action execution ("success" on success).
ticketobject
ticket_idnumber
ticket_statustext
urltext

Example output

{
  "status": "success",
  "ticket": {
    "id": 12345,
    "status": "open",
    "subject": "Printer on fire"
  },
  "ticket_id": 12345,
  "ticket_status": "open",
  "url": "https://acme.zendesk.com/agent/tickets/12345"
}

Update user

Change a user's name, email, role, phone, organization, tags or notes. Only the fields you set are changed.

Inputs

Useruser_idnumberRequired: The user's numeric id. Use Search users to find one.
Namenametext: Replace the person's name.
Emailemailtext: Replace their email address.
Roleroletext: Change what the person can do in Zendesk.One of: end-user (End user), agent, admin.
Phonephonetext: Replace their phone number.
Organizationorganization_idnumber: Numeric id of the organization to move them to.
Tagstagslist: Tags to set on the user. This replaces the existing tags rather than adding to them.
Notesnotestext: Replace the internal notes about this person.

Outputs

statustext: Status of the action execution ("success" on success).
userobject
user_idnumber

Example output

{
  "status": "success",
  "user": {
    "email": "sam@example.com",
    "id": 67890,
    "name": "Sam Rivera"
  },
  "user_id": 67890
}

ActionsCopy Anchor Link

Add ticket commentCopy Anchor Link

Inputs

Outputs

Create organizationCopy Anchor Link

Inputs

Outputs

Create ticketCopy Anchor Link

Inputs

Outputs

Create userCopy Anchor Link

Inputs

Outputs

Delete organizationCopy Anchor Link

Inputs

Outputs

Delete ticketCopy Anchor Link

Inputs

Outputs

Delete userCopy Anchor Link

Inputs

Outputs

Get connected accountCopy Anchor Link

Inputs

Outputs

Get organizationCopy Anchor Link

Inputs

Outputs

Get ticketCopy Anchor Link

Inputs

Outputs

Get userCopy Anchor Link

Inputs

Outputs

List groupsCopy Anchor Link

Inputs

Outputs

List organizationsCopy Anchor Link

Inputs

Outputs

List ticket commentsCopy Anchor Link

Inputs

Outputs

List ticketsCopy Anchor Link

Inputs

Outputs

Search usersCopy Anchor Link

Inputs

Outputs

Search ZendeskCopy Anchor Link

Inputs

Outputs

Update organizationCopy Anchor Link

Inputs

Outputs

Update ticketCopy Anchor Link

Inputs

Outputs

Update userCopy Anchor Link

Inputs

Outputs

On this page

Actions

Add ticket comment

Create organization

Create ticket

Create user

Delete organization

Delete ticket

Delete user

Get connected account

Get organization

Get ticket

Get user

List groups

List organizations

List ticket comments

List tickets

Search users

Search Zendesk

Update organization

Update ticket

Update user