Skip to main content

Documentation Index

Fetch the complete documentation index at: https://explore.airia.com/llms.txt

Use this file to discover all available pages before exploring further.

Zendesk actions let an agent work with your support data directly in a flow. An agent can create and update tickets, manage users and organizations, read ticket fields, and pass the results to later steps.

Supported actions

GroupActions
TicketCreate, Update, Get, Get All, Delete, Recover
UserCreate, Update, Get, Get All, Search, Delete, Get Related Data
OrganizationCreate, Update, Get, Get All, Delete, Count, Get Related Data
Ticket fieldGet, Get All

Prerequisites

Generate an API token in your Zendesk admin center, then store it as a Zendesk credential in Credential Management. Select that credential on every Zendesk action.

How to use these actions

  • Every action needs your Subdomain and authentication email. The Subdomain is the mycompany part of mycompany.zendesk.com, and the authentication email is the email tied to your API token. Both are required on every Zendesk action.
  • Map text inputs from earlier steps. Inputs such as Subject, Description, and Email accept a value mapped from a previous step.
  • Numeric and toggle inputs take fixed values. Numeric IDs such as Assignee ID, Group ID, and Organization ID, the Limit, and the Comment Is Public toggle take fixed values.
  • Comma separated lists. Tags and Domain Names are entered as comma separated values.
  • JSON objects for custom data. Custom Fields, Organization Fields, and User Fields accept a JSON object.
  • List actions cap results with Limit. The Get All actions return up to Limit records.
Subdomain and the authentication email tied to your API token are required on every Zendesk action. They are documented here once and are not repeated in each operation’s input table below.

Actions

Ticket

Zendesk Ticket Create

Creates a new ticket.
InputRequiredDescription
SubjectYesThe subject line of the ticket.
DescriptionYesThe first comment body on the ticket.
PriorityNoThe ticket priority. One of urgent, high, normal, or low.
TypeNoThe ticket type. One of problem, incident, question, or task.
Requester EmailNoThe email address of the person requesting support.
Requester NameNoThe name of the person requesting support.
Assignee IDNoThe numeric ID of the agent to assign the ticket to. Takes a fixed number.
Group IDNoThe numeric ID of the group to assign the ticket to. Takes a fixed number.
TagsNoTags to apply, entered as a comma separated list.
Custom FieldsNoCustom field values as a JSON object.

Zendesk Ticket Update

Updates an existing ticket.
InputRequiredDescription
Ticket IDYesThe unique identifier of the ticket to update.
SubjectNoThe new subject line.
CommentNoA comment to add to the ticket.
Comment Is PublicNoWhether the added comment is public. Defaults to on.
StatusNoThe new status. One of new, open, pending, hold, solved, or closed.
PriorityNoThe ticket priority. One of urgent, high, normal, or low.
TypeNoThe ticket type. One of problem, incident, question, or task.
Assignee IDNoThe numeric ID of the agent to assign the ticket to. Takes a fixed number.
Group IDNoThe numeric ID of the group to assign the ticket to. Takes a fixed number.
TagsNoTags to apply, entered as a comma separated list.
Custom FieldsNoCustom field values as a JSON object.

Zendesk Ticket Get

Retrieves a ticket by ID.
InputRequiredDescription
Ticket IDYesThe unique identifier of the ticket to retrieve.

Zendesk Ticket Get All

Lists tickets.
InputRequiredDescription
LimitNoMaximum number of tickets to return, from 1 to 1000. Defaults to 100.
Sort ByNoThe field to sort on. One of created_at, updated_at, priority, or status.
Sort OrderNoThe sort direction, either asc or desc.
StatusNoFilter tickets by status.

Zendesk Ticket Delete

Deletes a ticket.
InputRequiredDescription
Ticket IDYesThe unique identifier of the ticket to delete.

Zendesk Ticket Recover

Recovers a deleted ticket.
InputRequiredDescription
Ticket IDYesThe unique identifier of the deleted ticket to recover.

User

Zendesk User Create

Creates a new user.
InputRequiredDescription
NameYesThe user’s full name.
EmailYesThe user’s email address.
RoleNoThe user role. One of end-user, agent, or admin.
PhoneNoThe user’s phone number.
Organization IDNoThe numeric ID of the organization to associate the user with. Takes a fixed number.
External IDNoAn identifier for the user in an external system.
User FieldsNoCustom user field values as a JSON object.

Zendesk User Update

Updates an existing user.
InputRequiredDescription
User IDYesThe unique identifier of the user to update.
NameNoThe user’s full name.
EmailNoThe user’s email address.
RoleNoThe user role. One of end-user, agent, or admin.
PhoneNoThe user’s phone number.
Organization IDNoThe numeric ID of the organization to associate the user with. Takes a fixed number.
User FieldsNoCustom user field values as a JSON object.

Zendesk User Get

Retrieves a user by ID.
InputRequiredDescription
User IDYesThe unique identifier of the user to retrieve.

Zendesk User Get All

Lists users.
InputRequiredDescription
LimitNoMaximum number of users to return, from 1 to 1000. Defaults to 100.
RoleNoFilter users by role, one of end-user, agent, or admin.
Searches for users.
InputRequiredDescription
QueryYesThe search query.
LimitNoMaximum number of users to return, from 1 to 1000. Defaults to 100.

Zendesk User Delete

Deletes a user.
InputRequiredDescription
User IDYesThe unique identifier of the user to delete.
Retrieves data related to a user, such as their tickets and organizations.
InputRequiredDescription
User IDYesThe unique identifier of the user to read related data for.

Organization

Zendesk Organization Create

Creates a new organization.
InputRequiredDescription
NameYesThe organization’s name.
Domain NamesNoEmail domains for the organization, entered as a comma separated list.
DetailsNoAdditional details about the organization.
NotesNoNotes about the organization.
External IDNoAn identifier for the organization in an external system.
TagsNoTags to apply, entered as a comma separated list.
Organization FieldsNoCustom organization field values as a JSON object.

Zendesk Organization Update

Updates an existing organization.
InputRequiredDescription
Organization IDYesThe unique identifier of the organization to update.
NameNoThe organization’s name.
Domain NamesNoEmail domains for the organization, entered as a comma separated list.
DetailsNoAdditional details about the organization.
NotesNoNotes about the organization.
TagsNoTags to apply, entered as a comma separated list.
Organization FieldsNoCustom organization field values as a JSON object.

Zendesk Organization Get

Retrieves an organization by ID.
InputRequiredDescription
Organization IDYesThe unique identifier of the organization to retrieve.

Zendesk Organization Get All

Lists organizations.
InputRequiredDescription
LimitNoMaximum number of organizations to return, from 1 to 1000. Defaults to 100.

Zendesk Organization Delete

Deletes an organization.
InputRequiredDescription
Organization IDYesThe unique identifier of the organization to delete.

Zendesk Organization Count

Returns the total number of organizations. This action takes no inputs beyond the credential. Retrieves data related to an organization, such as its users and tickets.
InputRequiredDescription
Organization IDYesThe unique identifier of the organization to read related data for.

Ticket field

Zendesk Ticket Field Get

Retrieves a ticket field by ID.
InputRequiredDescription
Field IDYesThe unique identifier of the ticket field to retrieve.

Zendesk Ticket Field Get All

Lists ticket fields. This action takes no inputs beyond the credential.

Example

An agent that opens a ticket for an inbound support request:
1

Find the requester

A Zendesk User Search action sets Query to the requester’s email so a model step can confirm whether the user already exists.
2

Create the ticket

A Zendesk Ticket Create action sets Subject and Description from the request, sets Priority, and maps Requester Email to the matched user.
3

Confirm

A model step summarizes the ticket result, including the returned ticket ID, for the activity log.

Troubleshooting

Confirm the Subdomain and the authentication email are correct, and that the stored API token belongs to that account and has not been revoked. The authentication email must match the user who owns the token.
The Ticket ID, User ID, or Organization ID you passed does not exist in this Zendesk account. Use a Get All or Search action to confirm the ID before referencing it.
Status, Priority, and Type accept only their listed values. Custom Fields, Organization Fields, and User Fields must be a valid JSON object whose keys match fields defined in your account.
Zendesk Ticket Recover only works on a ticket that was soft deleted and not yet permanently removed. A permanently deleted ticket cannot be recovered.
For issues common to every vendor, see the Actions overview.