Skip to main content
Zendesk logo
  • Category: crm
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 457
  • Triggers: 2
  • Slug: ZENDESK
  • Version: 20261101_00

Frequently Asked Questions

For a step-by-step guide on creating and configuring your own Zendesk OAuth credentials with Composio, see How to create OAuth credentials for Zendesk.

Tools

Slug: ZENDESK_APPLY_ZENDESK_MACROPreview how a Zendesk macro would affect a ticket without actually applying it. Returns the ticket object as it would appear after the macro is applied, showing any changes to fields, comments, status, or other properties. Use this action to review macro changes before applying them to ensure the outcome is as expected.

Input Parameters

integer
required
The ID of the macro to apply.
integer
required
The ID of the ticket to preview the macro on.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_AUTOCOMPLETE_PROBLEMSAutocomplete problems in Zendesk. Use when you need to find problem suggestions based on a partial search text for ticket categorization or troubleshooting.

Input Parameters

string
required
The text to search for in problems. Used to find matching problem suggestions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_AUTOCOMPLETE_USERSFind Zendesk users using autocomplete by name prefix, phone, or lookup relationship, with optional filters. Name or phone searches cannot be combined with lookup relationship parameters.

Input Parameters

string
The name to search for matching users. Returns users whose name starts with the provided value. Cannot be combined with field_id/source.
string
The phone number to search for matching users. Cannot be combined with field_id/source.
string
Filter to apply to autocomplete results. Common values: ‘assignable’, ‘requester’, or ‘dynamic_values’ object.
string
The type of the object referenced by field_id. When provided, must be one of the recognized values: ‘zen:user’, ‘zen:organization’, ‘zen:ticket’, or ‘zen:custom_object:CUSTOM_OBJECT_KEY’ (also ‘zen:article’/‘zen:brand’ for lookup fields defined on a custom object) — any other value 400s with “Parameter source must be a valid type is required”.
integer
Field ID for lookup relationship autocomplete. If source is also provided, it must be a recognized type string — an unrecognized value 400s with “Parameter source must be a valid type is required”. field_id alone (with no source) is accepted and simply returns no matches. Cannot be combined with name/phone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CHECK_HOST_MAPPING_VALIDITY_FOR_EXISTING_BRANDCheck the host mapping validity for an existing brand in Zendesk. Returns the current CNAME record, expected CNAME values, validity status, and the reason for validity or invalidity. Use this action when you need to verify that DNS records are correctly configured for an existing brand that has already been created in Zendesk. This action requires a brand ID rather than subdomain/host_mapping parameters.

Input Parameters

integer
required
The ID of the brand to check host mapping validity for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_COUNT_DELETED_USERSRetrieve the count of deleted users in Zendesk, along with its refresh timestamp. The count value may be null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_COUNT_USER_CCD_TICKETSCount tickets where the specified user is CCD (carbon copy distribution). Returns an approximate count of tickets where the user appears in the CCD field. Use when you need to know how many tickets a user is copied on for reporting or operational purposes.

Input Parameters

integer
required
The numeric ID of the Zendesk user whose CCD tickets to count. This is the user ID found in ticket payloads (requester_id, submitter_id, assignee_id, author_id).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_COUNT_ZENDESK_CUSTOM_OBJECT_RECORDSCount the number of records in a specific Zendesk custom object. Use when you need to determine the total number of records for a custom object type, which is useful for reporting, capacity planning, or validation before creating new records. This is a read-only, idempotent operation. Example use cases: - Check if a custom object has records before deleting - Get record count for reporting dashboards - Verify capacity before bulk operations

Input Parameters

string
required
The key of a custom object. This is a user-defined unique identifier for the custom object type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_COUNT_ZENDESK_ORGANIZATIONSCount the number of organizations in Zendesk. Returns an approximate count of organizations with the timestamp of when the count was last calculated. This is a read-only, idempotent operation. Use when you need to know the total number of organizations for reporting, capacity planning, or operational purposes. For detailed per-organization information, use ZENDESK_GET_ALL_ZENDESK_ORGANIZATIONS instead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ACCESS_RULECreate an access rule for a custom object in Zendesk. Access rules control which users can view or modify custom object records based on conditions. Use when you need to set up data access policies for custom objects, such as limiting access to records created by the current user or records assigned to specific groups. Returns the created access rule with its ID, title, description, conditions, and timestamps.

Input Parameters

object
required
The access rule definition including title, description, and conditions
string
required
The key of the custom object to create an access rule for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_APPS_INSTALLATIONInstall a Zendesk app in the account. Use when you need to add an app from the Zendesk marketplace or a private app to your Zendesk instance. You must provide the app_id; settings are optional for apps that have defaults or no configurable settings. This action is irreversible once installed.

Input Parameters

integer
required
The ID of the app to install
boolean
Whether the app should be enabled after installation. When omitted, Zendesk’s server-side default applies (currently true for most apps). Pass True or False to override that default explicitly.
object
Installation settings as a flat key-value object. All apps support the ‘name’ setting. Example: {‘name’: ‘My App’, ‘iframeURL’: ‘https://example.com’}. Use either ‘settings’ or ‘settings_objects’, not both.
array
Alternative format for settings using key-value objects. Use either ‘settings’ or ‘settings_objects’, not both.
boolean
Enable recurring Stripe payment subscription for paid apps. Set to true to enable billing.
array
List of user roles to restrict the app to. Valid values: ‘end-user’, ‘agent’, ‘admin’
array
List of Zendesk group IDs to restrict the app to. Only users in these groups can see the app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_APPS_NOTIFYSend a notification to currently open instances of a Zendesk app. Use when you need to push real-time notifications or data to a Zendesk app that is currently open in an agent’s interface. The notification triggers an event in the app, which can then respond with custom behavior (e.g., display a popup, update UI, trigger a workflow). Only works with apps that are currently open in the Zendesk interface.

Input Parameters

string
The message body or data to send to the app. Can be a string, number, boolean, object, array, or null. Maximum payload size is 1MB.
string
required
The name of the event that will fire in the app. This is a custom event string that the app listens for to trigger its own logic.
integer
required
The ID of the app to send the notification to. Set to 0 for unpublished apps in development mode.
integer
The ID of a specific agent to notify. If not provided, the notification will be sent to all currently open instances of the app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_AUTOCOMPLETE_TAGSSearch for Zendesk tags using autocomplete via POST request body. Use when you need to find tag suggestions based on a partial tag name for tagging tickets or organizing content.

Input Parameters

string
A substring of a tag name to search for. The API returns registered and recent tags matching this substring.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_AUTOMATIONCreate a new automation in Zendesk. Automations are business rules that automatically perform actions on tickets when certain conditions are met. Automations run server-side and don’t require user interaction. Use this action when you need to: - Automatically assign tickets based on conditions - Change ticket priority/status based on rules - Add tags to tickets matching certain criteria - Notify agents or teams based on ticket properties - Implement escalation workflows Note: Automations must have at least one condition that is time-based (like created_at, updated_at) OR check one of: status, type, group_id, assignee_id, or requester_id.

Input Parameters

string
required
The title/name of the automation. Must be unique among all automations.
boolean
Whether the automation is active and will execute. Set to false to create a draft automation.
array
List of actions the automation will perform when triggered. Each action specifies a field to modify and the value to set.
integer
The position of the automation which specifies the order it will be executed. Lower numbers execute first. If not specified, the automation is added to the end.
object
required
The conditions that must be met for the automation to execute. At least one ‘all’ condition must reference a time-based field (created_at, updated_at, etc.) or check: status, type, group_id, assignee_id, or requester_id. Omitting it would post {"all": [], "any": []} to Zendesk and fail server-side.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_BOOKMARKCreate a bookmark for a ticket in Zendesk. Bookmarks allow you to save references to tickets for quick access. Use this action when you need to: - Save a ticket for later reference - Mark an important ticket for quick access - Create a watchlist-like functionality for specific tickets

Input Parameters

integer
required
The ID of the ticket to bookmark. The ticket must exist and the user must have permission to access it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_COMMENT_REDACTIONRedact specified text from a Zendesk ticket comment using the Agent Workspace method. Redaction is irreversible; Agent Workspace and appropriate permissions are required, and comments on closed tickets cannot be redacted.

Input Parameters

string
required
The exact text string to redact from the comment. Required: omitting it would send an empty payload to the redact endpoint and report success without any redaction having happened. The text must match exactly as it appears in the comment.
integer
required
The ID of the ticket containing the comment to redact.
integer
required
The ID of the ticket comment to redact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_CUSTOM_OBJECT_BULK_JOBSubmit a bulk job to create, update, delete, or upsert Zendesk custom object records. Delete items must be objects containing an id or name; the response may include a job ID for tracking progress.

Input Parameters

array
required
Array of record objects for create, update, or upsert actions. Each object contains the record attributes matching the custom object’s field definitions. For delete actions, this should be an array of record IDs (strings).
string ("create" | "update" | "delete" | "upsert")
required
The bulk operation to perform. ‘create’ adds new records, ‘update’ modifies existing records, ‘delete’ removes records, ‘upsert’ creates or updates based on matching criteria.
string
required
The key of the custom object to operate on. This is the unique identifier for the custom object type (e.g., ‘car’, ‘product’, ‘order’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_CUSTOM_OBJECT_RECORDCreate a record for a Zendesk custom object and return its generated ID and available record fields, including timestamps when provided.

Input Parameters

string
required
User-defined display name for the object. If autonumbering is selected for the custom object’s name field, the name isn’t allowed because it’s automatically generated. If uniqueness is enabled, the name must be unique.
string
An id you can use to link custom object records to external data
string
required
The key of a custom object (e.g., ‘car’)
object
A dictionary of custom field key-value pairs. The available fields are defined in the custom object’s field definitions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_CUSTOM_OBJECT_RECORD_ATTACHMENTCreate an attachment for a Zendesk custom object record by uploading a file as multipart form data; the response may include attachment details and malware scan status. Accepts an uploaded file reference or a data or permitted local file URL, but rejects remote file links.

Input Parameters

object
required
The file to upload as an attachment. The file name will be used for the attachment (for example, ‘document.pdf’ or ‘image.jpg’).
string
required
The id of a custom object record
string
required
The key of a custom object (e.g., ‘car’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_CUSTOM_STATUSESCreate a new custom ticket status in Zendesk. Custom statuses allow agents to define more granular ticket states beyond the default status categories. Use when you need to add custom ticket workflow states to better reflect your support process. Both agent_label, status_category, end_user_label, and description are required. The status category determines which lifecycle phase the custom status belongs to.

Input Parameters

boolean
Whether the custom status is active. Defaults to true. If false, the status is inactive and cannot be selected.
string
required
The label displayed to agents when this custom status is shown. Maximum length is 48 characters.
string
required
The description explaining when an agent should select this custom ticket status.
string
required
The label displayed to end users (customers) when this custom status is shown. Maximum length is 48 characters.
string ("new" | "open" | "pending" | "hold" | "solved")
required
The status category this custom status belongs to. Must be one of: ‘new’, ‘open’, ‘pending’, ‘hold’, ‘solved’.
string
The description displayed to end users (customers) about this status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_DELETION_SCHEDULECreate a Zendesk deletion schedule for records matching specified conditions, for retention or cleanup. The schedule is active by default, and its target object type cannot be changed after creation.

Input Parameters

string
required
The title/name of the deletion schedule. Must be descriptive so you can identify it in the Zendesk admin panel.
boolean
Whether the deletion schedule is active and will execute. Set to false to create a disabled schedule.
string
required
The entity type to delete. Cannot be modified after creation. Built-in values: ‘zen:ticket’ (tickets), ‘zen:user’ (users), ‘zen:attachment’ (attachments), ‘zen:bot_only_conversation’ (bot conversations). For custom objects, use ‘zen:custom_object:CUSTOM_OBJECT_KEY’ (the enum was widened to accept this documented pattern).
object
Conditions object for deletion schedule - defines when items should be deleted.
string
A description explaining what this deletion schedule does.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_DYNAMIC_CONTENT_ITEMSCreate a new dynamic content item with locale variants in Zendesk. Dynamic content items enable localized content for ticket fields, macros, and other text-based content. Use when setting up multilingual support or creating template content that varies by user locale. The item’s name cannot be changed after creation. Ensure the name is descriptive and follows your naming conventions.

Input Parameters

string
required
Unique name for the dynamic content item. This name is used to reference the item in macros, triggers, and other content. Must be unique within the account.
array
required
Array of locale variants for this item. At least one variant is required. Each variant provides content for a specific locale.
integer
required
The ID of the default locale for this item. Must be one of the locales the account has active.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_DYNAMIC_CONTENT_ITEMS_VARIANTSCreate a new locale variant for an existing dynamic content item in Zendesk. Use when you need to add support for a new locale to an existing dynamic content item. Note: You can only create one variant per locale per dynamic content item. Use the update action to modify existing variants.

Input Parameters

boolean
If true, the variant is active and usable. Set to false to create a draft variant.
string
required
The content text for this locale variant. This is the localized string that will be displayed.
boolean
If true, this is the default variant used when no matching locale is found. Only one variant should be marked as default per item.
integer
required
The ID of the locale for this variant. Must be one of the locales the account has active.
integer
required
The ID of the dynamic content item to add a variant to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_END_USER_IDENTITYAdd an identity (email or phone) to an end user’s profile in Zendesk. Use when you need to link a new email address or phone number to an existing end user account.

Input Parameters

string
required
The type of identity to create. Must be one of: ‘email’, ‘phone_number’, ‘twitter’, ‘facebook’, ‘google’, ‘agent_forwarding’, ‘any_channel’, ‘foreign’, ‘sdk’, ‘messaging’.
string
required
The identifier value (e.g., email address like ‘user@example.com’ or phone number in E.164 format)
boolean
If true, marks this identity as the primary identity for the user. Writable only at creation time.
integer
required
The numeric ID of the end user to add the identity to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_GROUP_MEMBERSHIPSCreate a group membership in Zendesk, assigning an agent to a group. Use when you need to add an agent to a specific group for ticket routing, permissions, or team organization. The user_id and group_id are both required parameters. Note: The user must exist and have appropriate permissions to be assigned to groups. The group must also exist.

Input Parameters

boolean
If true, tickets assigned directly to the agent will assume this membership’s group. Defaults to false.
integer
required
The numeric ID of the agent to assign to the group. You can find this from user search results or ticket payloads (requester_id, submitter_id, assignee_id, author_id).
integer
required
The numeric ID of the group to assign the agent to. You can find this from group list results or ticket group_id fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_IMPORTS_TICKETS_CREATE_MANYBulk import tickets into Zendesk by posting up to 100 ticket objects at a time. Use when migrating tickets from another system or creating multiple tickets in a single API call. The operation returns a job_status payload; the initial status is typically ‘queued’ or ‘completed’ for small batches. This action is useful for data migration, test data setup, and bulk ticket creation workflows.

Input Parameters

array
required
Array of up to 100 ticket objects to import. Each ticket can have any valid ticket field.
boolean
If true, any ticket created with a ‘closed’ status bypasses the normal ticket lifecycle and will be created directly in your ticket archive

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_MANY_DYNAMIC_CONTENT_ITEMS_VARIANTSCreate multiple locale variants for an existing Zendesk dynamic content item in one request, supplying localized content and active status. The default-variant flag is not sent.

Input Parameters

array
required
Array of locale variants to create. Each variant provides content for a specific locale.
integer
required
The ID of the dynamic content item to add variants to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_MANY_TICKETSCreate many tickets in Zendesk in a single request. Accepts an array of up to 100 ticket objects. The operation is handled asynchronously — a background job is queued and you receive a job_status payload with an initial status of ‘queued’ or ‘working’. Poll the job_status URL or use ZENDESK_GET_APPS_JOB_STATUS to check for completion and view per-ticket results. Use when creating multiple tickets at once or seeding test data. This action is irreversible — tickets created cannot be easily undone once the job completes. Ensure the tickets list is accurate before submitting.

Input Parameters

array
required
Array of ticket objects to create (max 100). Each ticket requires at minimum a ‘subject’ field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_MANY_USERSCreate many users in Zendesk in a single request. Accepts up to 100 user objects. The operation is handled asynchronously — a background job is queued and you receive a job_status payload with an initial status of ‘queued’ or ‘working’. Poll the job_status URL or use ZENDESK_GET_APPS_JOB_STATUS to check for completion and view per-user results. Use when onboarding multiple users at once or seeding test data. Note: This action is idempotent — re-running with the same external_ids may update existing users depending on Zendesk configuration.

Input Parameters

array
required
Array of user objects to create (max 100). Each user requires a ‘name’ field.
boolean
If true, do not send verification emails to new users. Passed as a URL query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_OBJECT_TRIGGERCreate a trigger for a Zendesk custom object, defining conditions and actions for automated workflows on its records.

Input Parameters

string
required
The title/name of the trigger. Must be unique within the custom object.
boolean
Whether the trigger is active and will execute. Set to false to create a draft trigger.
array
required
List of actions the trigger will perform when conditions are met. Each action specifies a field and value.
integer
The position of the trigger which specifies the order it will be executed. Lower numbers execute first.
object
required
The conditions that must be met for the trigger to execute. Conditions use ‘all’ (AND) and ‘any’ (OR) logic.
string
A description of what the trigger does.
string
required
The key of the custom object to create a trigger for. This is a user-defined unique identifier for the custom object type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ORGANIZATION_FIELDCreate a custom organization field in Zendesk. Use when you need to add a new custom field type (such as text, dropdown, checkbox, date, etc.) to track additional organization attributes. The field key must be unique and can only contain letters, numbers, and underscores.

Input Parameters

string
required
A unique key that identifies this custom field. Must consist of only letters, numbers, and underscores. Cannot be only numbers.
string
Optional tag for checkbox type fields
string ("checkbox" | "date" | "decimal" | "dropdown" | "integer" | "lookup" | "multiselect" | "regexp" | "text" | "textarea")
required
The custom field type. Must be one of: checkbox, date, decimal, dropdown, integer, lookup, multiselect, regexp, text, or textarea
string
required
The title of the custom field
boolean
If true, this field is available for use. Defaults to true.
integer
Ordering of the field relative to other fields. Lower values appear first.
string
User-defined description of the field’s purpose
array
Filter definition for autocomplete in lookup fields
array
Required for dropdown or multiselect types. Each option requires a name and value.
string
Regular expression pattern for validating regexp type fields
string ("zen:user" | "zen:organization" | "zen:ticket")
Object type referenced for lookup fields. Can be zen:user, zen:organization, zen:ticket, or zen:custom_object:{key}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ORGANIZATION_MEMBERSHIPSCreate an organization membership in Zendesk by assigning a user to an organization. By default, the request marks the membership as the user’s default organization; this can be changed.

Input Parameters

boolean
Denotes whether this is the default organization membership for the user. If set to true, this membership will be the primary organization for the user. Defaults to true if not specified.
integer
required
The ID of the user to assign to the organization. Must be a non-null integer. Obtain from ZENDESK_LIST_USERS or ZENDESK_SEARCH_USERS; do not guess or fabricate IDs.
integer
required
The ID of the organization to assign the user to. Must be a non-null integer. Obtain from ZENDESK_GET_ALL_ZENDESK_ORGANIZATIONS or ZENDESK_GET_ZENDESK_ORGANIZATION_BY_ID; do not guess or fabricate IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ORGANIZATION_MEMBERSHIPS_CREATE_MANYCreate multiple organization memberships in Zendesk by posting up to 100 membership objects at a time. Each membership links a user to an organization. Use when onboarding multiple users to organizations in bulk, such as during team migrations or organizational restructuring. The operation returns a job_status payload; the initial status is typically ‘queued’ for larger batches.

Input Parameters

array
required
Array of organization membership objects to create (max 100). Each object requires user_id and organization_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ORGANIZATION_MERGEMerge two Zendesk organizations by combining all users, tickets, and data from the losing organization into the winning organization. This action is irreversible — once merged, the losing organization and all its data cannot be recovered. Use when you need to consolidate duplicate organizations or combine organization data into a single organization.

Input Parameters

integer
required
The ID of the winning organization that will receive all users and tickets from the losing organization
integer
required
The ID of the organization to merge from (the losing organization that will be merged into another)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ORGANIZATIONS_TAGSSet organization tags in Zendesk by making a POST request to replace the tags on an organization. Use when you need to categorize or label organizations with specific tags for filtering and organization purposes. This operation replaces all existing tags on the organization with the new set provided. Note: This action is not idempotent as it replaces existing tags rather than adding to them.

Input Parameters

array
required
An array of tag strings to set for the organization. Tags are used to categorize and filter organizations. Existing tags on the organization will be replaced with this new set of tags.
integer
required
The ID of the organization to set tags for. Must be a non-null integer. Obtain from ZENDESK_GET_ALL_ZENDESK_ORGANIZATIONS or ZENDESK_SEARCH_ZENDESK_ORGANIZATIONS; do not guess or fabricate IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ORGANIZATION_SUBSCRIPTIONCreate an organization subscription in Zendesk. This subscribes a user to receive notifications and updates related to a specific organization. Use when you need to add a user to an organization’s subscription list so they can access organization-related resources and receive notifications.

Input Parameters

integer
required
The ID of the user who will be subscribed to the organization
integer
required
The ID of the organization to subscribe the user to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_OR_UPDATE_MANY_USERSCreate or update up to 100 Zendesk users in a single request; new users require a name. Returns a background job status, with per-user results when available.

Input Parameters

array
required
Array of user objects to create or update. Up to 100 users can be included. For new users, ‘name’ is required. For existing users, ‘id’ is required to identify the user to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_OR_UPDATE_ORGANIZATIONCreate or update a Zendesk organization in a single operation. If an organization with the same external_id already exists, it is updated. Otherwise, a new organization is created. Use when you need to ensure an organization exists without checking for duplicates first. Note: For updates, you must specify the external_id to match the existing organization. Name is not available as a matching criteria.

Input Parameters

string
required
A unique name for the organization. Required when creating a new organization. Note: Name is not available as a matching criteria for updates - use external_id or id instead.
array
The tags of the organization
string
Any notes you have about the organization
string
Any details about the organization, such as the address
integer
New tickets from users in this organization are automatically put in this group
string
A unique external id to associate organizations to an external record. The id is case-insensitive (e.g., ‘company1’ and ‘Company1’ are considered the same). Use this for matching when updating an existing organization.
array
An array of domain names associated with this organization
boolean
End users in this organization are able to see each other’s tickets
boolean
End users in this organization are able to comment on each other’s tickets
object
Custom fields for this organization. See custom organization fields documentation for available field definitions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_OR_UPDATE_USERCreate or update a Zendesk user, matching existing users by email or external_id. Returns the user object.

Input Parameters

object
required
User object with attributes. name is mandatory. The user is matched by email or external_id to determine create vs update. role must be one of: ‘end-user’, ‘agent’, or ‘admin’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_PUSH_NOTIFICATION_DEVICES_DESTROY_MANYBulk unregister push notification devices in Zendesk. This action is irreversible — the devices will be permanently removed from receiving push notifications and cannot be recovered once removed. Use when cleaning up obsolete device tokens or removing test devices from receiving push notifications.

Input Parameters

array
required
List of mobile device tokens to unregister from push notifications. These are the device tokens returned when a mobile device registers for push notifications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_RESOURCE_COLLECTIONSCreate a resource collection in Zendesk. Use when you need to batch multiple operations on Zendesk resources (like tickets) into a single request. The API processes the collection as a background job and returns a job status object. Note: This action queues a background job. Poll the returned job_status.url to check when the collection has been processed.

Input Parameters

string
required
The title/name of the resource collection. This is used to identify the collection.
array
required
Array of action objects specifying what to do with the resources. Each action has a type and list of resource IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_SIDE_CONVERSATIONCreate a private side conversation on a Zendesk ticket. Side conversations are agent-to-agent communications that don’t notify the customer. Use this action when you need to discuss a ticket privately with another agent, escalate to a specialist, or coordinate on sensitive issues without customer visibility. Recipients can include Zendesk users (by ID or email), Slack channels, support groups, or Microsoft Teams channels.

Input Parameters

array
required
List of recipients for the side conversation. Each recipient must have at least one of: user_id, email, slack_channel_id, support_group_id, or msteams_channel_id. At least one recipient is required.
string
required
Plain text body of the initial message. This is the main content of the side conversation that recipients will see.
string
Subject line for the side conversation. If not provided, a default subject may be used based on the parent ticket.
string
HTML-formatted body of the initial message. If provided, this will be used instead of the plain text body for HTML-capable clients.
integer
required
The ID of the Zendesk ticket to attach the side conversation to
object
Key-value external metadata to attach to the side conversation. Use this to store custom identifiers or tags from your external systems.
array
List of attachment file IDs to include with the message. These must be IDs from previously uploaded attachments via the CreateSideConversationAttachment action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_SUPPORT_ADDRESSCreate a new support address (recipient address) in Zendesk. Use when you need to add a new email address for receiving support requests. The email address must follow Zendesk’s format ({local-part}@{accountname}.zendesk.com) for internal addresses, or be an existing external email with forwarding properly configured. The created address will have verification statuses that indicate whether DNS records (CNAME, SPF) are properly configured. Note that you cannot change the email address of an existing support address after creation.

Input Parameters

string
required
The name for the address
string
required
The email address for the support address. Note: You cannot change the email address of an existing support address after creation.
boolean
Whether this address should be the account’s default support address
integer
The ID of the brand to associate with this support address. If not provided, the address will be associated with the account’s default brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_SUSPENDED_TICKETS_EXPORTExport Suspended Tickets from Zendesk Support. Use when you need to export all suspended tickets for compliance review, audit purposes, or data analysis. This action enqueues a job that creates a CSV file; when complete, Zendesk emails the requester a link to download the CSV. Suspended tickets are sorted by update timestamp in ascending order. Rate limited to one request per minute. Note: This action is read-only and returns the export job status. The actual CSV will be sent via email when the job completes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_TICKET_CONTENT_PINCreate a ticket content pin in Zendesk. Content pins allow you to attach helpful resources like Help Center articles or external content directly to tickets for easy reference. Use this action when you need to: - Attach a Help Center article to a ticket for context - Pin an external knowledge base article to a ticket - Add relevant documentation or resources to a support ticket

Input Parameters

string
The locale for the content pin. Required when content_type is ‘external_content’ — Zendesk rejects external-content pins with no locale (‘External contents must have locale to be able to get pinned to tickets.’). Also required when pinning articles. Format: language + underscore + locale code (e.g., ‘en-us’, ‘fr-ca’).
string
required
The ID of the ticket to which the content pin will be added
string
required
The ID of the content to pin
string
required
The type of content being pinned. Common values include ‘article’ for Help Center articles and ‘external_content’ for external resources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_TICKET_FIELDCreate a custom ticket field in Zendesk with various field types. Use when you need to add a new custom field (such as text, dropdown, checkbox, date, numeric, regex-validated, or lookup) to capture additional information on tickets. The field title is required; description, required flag, and custom options are optional.

Input Parameters

string
For checkbox fields only. The tag added to tickets when the checkbox is selected
string ("text" | "textarea" | "checkbox" | "date" | "integer" | "decimal" | "regexp" | "partialcreditcard" | "multiselect" | "tagger" | "lookup")
required
The ticket field type. Must be one of: text, textarea, checkbox, date, integer, decimal, regexp, partialcreditcard, multiselect, tagger, or lookup
string
required
The title of the ticket field shown to agents and end users
boolean
If true, this field is available for use. Defaults to true.
integer
Relative position of the field on the ticket. Fields with lower positions appear first.
boolean
If true, agents must enter a value in this field to change the ticket status to solved. Defaults to false.
string
User-defined description explaining the purpose of this field
boolean
If true, agents can edit this field. Defaults to true.
string
The title shown to end users in Help Center (may differ from agent title)
string
A description of the ticket field that only agents can see
boolean
If true, the field is visible to end users in Help Center. Defaults to true.
boolean
If true, end users can edit this field in Help Center. Defaults to true.
boolean
If true, end users must enter a value to create a request. Defaults to false.
array
Filter definition that allows autocomplete to filter down results for lookup fields
boolean
If true, the field is hidden alongside infrequently used fields. Classic interface only.
array
Required for multiselect and tagger types. Defines the available options for dropdown selection.
string
Regular expression pattern for validating input on regexp type fields
string ("zen:user" | "zen:organization" | "zen:ticket" | "zen:custom_object:apartment")
The type of object referenced by lookup fields. Can be zen:user, zen:organization, zen:ticket, or zen:custom_object:{key}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_TICKET_FIELD_OPTIONCreate or update an option for a dropdown or multiselect ticket field. Use when you need to add a new selectable option to a custom ticket field of type ‘multiselect’ or ‘tagger’. If an option with the same value already exists, it will be updated with the provided name. This action is idempotent - running it multiple times with the same value will update the existing option rather than creating duplicates.

Input Parameters

string
required
The name of the option displayed to agents and end users in the dropdown
string
required
The internal value of the option used when saving the ticket field selection
integer
The relative position of the option in the dropdown list. Options with lower positions appear first.
boolean
If true, selecting this option allows the ticket to be solved when the field is required to solve
integer
required
The ID of the ticket field to add the option to. The ticket field must be of type ‘multiselect’ or ‘tagger’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_TRIGGERCreate a new trigger in Zendesk. Triggers are business rules that automatically perform actions on tickets when certain conditions are met. Unlike automations, triggers execute immediately when tickets are created or updated. Use this action when you need to: - Automatically change ticket status based on conditions - Assign tickets to agents or groups based on rules - Add tags to tickets matching certain criteria - Send notifications to agents, groups, or external systems - Update custom fields based on ticket properties Note: Triggers must have at least one condition in the ‘all’ array that references a time-based field (like created_at, updated_at) OR checks one of: status, type, group_id, assignee_id, requester_id, custom_status_id.

Input Parameters

string
required
The title/name of the trigger. Must be unique among all triggers.
boolean
Whether the trigger is active and will execute. Set to false to create a draft trigger.
array
required
List of actions the trigger will perform when triggered. Each action specifies a field to modify and the value to set.
object
required
The conditions that must be met for the trigger to execute. At least one ‘all’ condition must reference a time-based field (created_at, updated_at) or check: status, type, group_id, assignee_id, requester_id, custom_status_id.
string
The ID of the category to assign the trigger to. Categories help organize triggers in the Zendesk admin interface.
string
A description of what the trigger does.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_TRIGGER_CATEGORIES_JOBSubmit a batch patch job for Zendesk ticket trigger categories by ID. The response can include status, results, and errors.

Input Parameters

string
The batch action to perform on trigger categories. Currently only ‘patch’ is supported.
array
required
List of trigger category IDs to include in the batch job

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_TRIGGER_CATEGORYCreate a new trigger category in Zendesk. Trigger categories are used to organize and group triggers for better management. Use when setting up automated workflows or organizing business rules. This action creates a trigger category with the specified name and optional position. The name must be unique within the account.

Input Parameters

string
required
The name of the trigger category. Names must be unique within the account.
integer
The position of the trigger category. Triggers with lower positions are run first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_USER_FIELD_OPTIONCreate or update an option for a dropdown or multiselect user field. Use when you need to add a new selectable option to a custom user field of type ‘multiselect’ or ‘tagger’. If an option with the same value already exists, it will be updated with the provided name. This action is idempotent - running it multiple times with the same value will update the existing option rather than creating duplicates.

Input Parameters

string
required
The name of the option displayed to agents and end users in the dropdown
string
required
The internal value of the option used when saving the user field selection
integer
The relative position of the option in the dropdown list. Options with lower positions appear first.
boolean
If true, selecting this option allows the ticket to be solved when the field is required to solve
string
required
The ID or key of the user field to add the option to. The user field must be of type ‘multiselect’ or ‘tagger’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_USER_IDENTITYTool to add an identity to a user’s profile in Zendesk. An agent can add multiple identities to a user (e.g., multiple email addresses). Use this when a user needs to be contacted via a new channel or needs an additional identifier. Use when you need to add an additional identity (email, phone, social) to an existing Zendesk user.

Input Parameters

string ("email" | "twitter" | "facebook" | "google" | "phone_number" | "agent_forwarding" | "any_channel" | "foreign" | "sdk" | "messaging")
required
The type of identity to create. Common types include ‘email’, ‘twitter’, ‘phone_number’, etc.
string
required
The identifier value for this identity, such as an email address, phone number, or social media handle.
boolean
Set to true to make this identity the primary identity for the user. Defaults to false. Note: Primary can only be set on creation, not on update.
integer
required
The numeric ID of the user to add the identity to. This is the user ID found in ticket payloads (requester_id, submitter_id, assignee_id, author_id) or from user search results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_USER_PROFILES_EVENTSStore an event against a Sunshine user profile identified by the supplied identifiers, creating the profile if it does not exist. Event properties are limited to name and description.

Input Parameters

object
required
Event information containing the event details and properties.
object
required
Profile information for the user who triggered the event. The profile is created if it doesn’t exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_USERS_LOGOUT_MANYLog out multiple users in Zendesk by ending their active sessions. This action is irreversible — the affected users will be logged out and will need to re-authenticate. Use when you need to immediately terminate sessions for multiple users (e.g., after security incident, offboarding, or credential revocation). The operation accepts up to 100 user IDs at a time.

Input Parameters

string
required
Comma-separated list of up to 100 user IDs to log out. The IDs must belong to end-users or agents, not brands or organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_USERS_ORGANIZATION_MEMBERSHIPSCreate a new organization membership for a specific user in Zendesk by assigning a user to an organization. Use when you need to associate an existing user with an organization so they can access organization-specific tickets and data. This action targets a specific user by their ID. This action is idempotent in that creating a duplicate membership will fail with a specific error, but the operation itself is not naturally idempotent.

Input Parameters

boolean
Denotes whether this is the default organization membership for the user. If set to true, this membership will be the primary organization for the user. Defaults to false if not specified.
integer
required
The ID of the user for whom to create the organization membership. Must be a non-null integer. Obtain from ZENDESK_LIST_USERS or ZENDESK_SEARCH_USERS; do not guess or fabricate IDs.
integer
required
The ID of the organization to assign the user to. Must be a non-null integer. Obtain from ZENDESK_GET_ALL_ZENDESK_ORGANIZATIONS or ZENDESK_GET_ZENDESK_ORGANIZATION_BY_ID; do not guess or fabricate IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_USERS_TAGSSet tags on a Zendesk user via POST request to /api/v2/users/{user_id}/tags. Use when you need to add or update tags on a specific user. Note that this replaces all existing tags on the user with the provided set of tags. This action is idempotent.

Input Parameters

array
required
An array of tag names to set on the user. Existing tags will be replaced with these tags.
integer
required
The numeric ID of the user to set tags for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_VIEWCreate a new view in Zendesk. Views are saved ticket filters that help agents organize and prioritize their work. They can filter tickets by conditions like status, priority, assignee, and more. Use this action when you need to: - Create a custom view for a specific team or workflow - Set up views for different ticket priorities or statuses - Create views with restricted access for specific groups - Configure views with specific columns, grouping, and sort order Note: At minimum, the ‘all’ conditions must include a condition checking ‘status’, ‘type’, ‘group_id’, ‘assignee_id’, or ‘requester_id’.

Input Parameters

string
required
The title of the view. Must be unique within the account.
boolean
Whether the view is active and visible to agents. Set to false to save as a draft.
object
Output configuration for view display settings.
object
required
The conditions that define which tickets appear in the view. ‘all’ conditions must ALL be true; ‘any’ conditions allow OR logic. At least one ‘all’ condition is required.
string
The description of the view shown to agents.
object
Restriction settings for view access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_VIEWS_PREVIEWPreview a Zendesk view by constructing conditions and execution settings to see which tickets match. Use when you need to test or validate view conditions before saving, or to retrieve a live preview of tickets matching specific filter criteria without creating a permanent view. This action is useful for verifying view logic, testing conditions, and previewing results before committing to a saved view.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive - use one format or the other, not both.
object
required
The view object containing title, conditions, and execution settings to preview
array
Optional list of column definitions to override or extend the view’s columns in the output
string
A comma-separated list of sideloads to exclude from the response.
string
A comma-separated list of sideloads to include in the response.
integer
Number of records to return per page. Default and maximum values vary by endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_VIEWS_PREVIEW_COUNTPreview ticket count for a view in Zendesk. Returns the number of tickets matching the specified conditions before saving the view. Use when you want to verify how many tickets will match a view’s filter criteria before creating or updating a view. This action sends a POST request to /api/v2/views/preview/count with view conditions and returns the matching ticket count. Rate limited to 5 requests per minute, per view, per agent.

Input Parameters

object
Output configuration for view sorting and grouping.
array
required
Array of one or more conditions that a ticket must meet ALL of to be included. This is the ‘all’ array in the view object. At least one condition is required. Note: ‘all’ is a Python keyword, so this field is named ‘all_conditions’ but maps to ‘all’ in the API.
array
Array of conditions where a ticket meets ANY of them to be included. Optional - if not provided, only ‘all_conditions’ are used. Note: ‘any’ is a Python keyword, so this field is named ‘any_conditions’ but maps to ‘any’ in the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ZENDESK_ATTACHMENTSUpload a file attachment to Zendesk for use in a ticket comment, returning attachment details and an upload token valid for 60 minutes. Use an uploaded file reference, data URL, or permitted local file URL.

Input Parameters

object
required
The file to upload to Zendesk. The file name will be used for the attachment (for example, ‘document.pdf’ or ‘error_log.txt’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ZENDESK_CUSTOM_OBJECTCreate a new custom object in Zendesk. Use when you need to define a new custom object type to store and manage custom data. The key is immutable once created, so choose carefully.

Input Parameters

object
required
The custom object definition containing key, title, title_pluralized, and optional properties.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ZENDESK_CUSTOM_OBJECT_FIELDCreate a new field for a custom object in Zendesk. Use when you need to add a new attribute or data field to an existing custom object type. The key is immutable once created. This action is idempotent for the same key, but the key parameter must be unique per custom object.

Input Parameters

string
required
A user-defined unique identifier for the field. Once created, this value cannot be changed.
string
A tag associated with this field for filtering and organization
string
required
The data type of the field. Common types include: ‘text’, ‘integer’, ‘boolean’, ‘float’, ‘date’, ‘datetime’, ‘tag’, ‘enumeration’, ‘relation’
string
required
Display name for the field shown in the Zendesk interface
boolean
Whether the field is active and available for use
integer
Position of the field in the field list. Lower values appear first.
boolean
Whether this field is required when creating records. Omit (None) to use Zendesk’s server-side default; pass True/False to set explicitly.
object
Additional properties for a custom object field.
string
A description of the field to help agents understand its purpose
string
required
The key of the custom object to add the field to
array
List of options for dropdown/enumeration type fields
string
A regular expression pattern to validate the field value against
string
For relationship fields, the key of the target custom object type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ZENDESK_GROUPCreate a Zendesk group with an account-unique name to organize agents for ticket assignment and routing. Returns the group’s assigned ID and supported group fields.

Input Parameters

string
required
The name of the group. Must be unique within the account. Leading/trailing whitespace is trimmed.
boolean
If true, the group is public and visible to all agents. If false, the group is private. Note: You cannot change a private group to a public group after creation.
string
An optional description of the group explaining its purpose or responsibilities

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ZENDESK_IMPORT_TICKETImport a ticket into Zendesk with historical timestamps. This action creates tickets with past created_at, updated_at, or solved_at values, useful for migrating historical data. For real-time ticket creation, use ZENDESK_CREATE_ZENDESK_TICKET. Tickets created with ‘closed’ status and archive_immediately=true bypass normal lifecycle and go directly to archive.

Input Parameters

array
Array of tags to apply to the ticket.
string
Due date for the ticket in ISO 8601 format. Only applicable for task tickets.
string ("new" | "open" | "pending" | "hold" | "solved" | "closed")
The state of the ticket. Allowed values: ‘new’, ‘open’, ‘pending’, ‘hold’, ‘solved’, ‘closed’.
string
required
Short summary of the issue for the imported ticket.
integer
The ID of the group to assign the ticket to.
string ("urgent" | "high" | "normal" | "low")
Zendesk priority. Must be one of: ‘urgent’, ‘high’, ‘normal’, ‘low’. Defaults to ‘normal’.
array
Array of email CC objects for adding/removing email CCs.
array
Array of follower objects for adding/removing followers.
string
The time the ticket was solved (for historical imports) in ISO 8601 format.
string
The time the ticket was created (for historical imports) in ISO 8601 format.
string
The time the ticket was last updated (for historical imports) in ISO 8601 format.
integer
The ID of the agent to assign to the ticket.
string
required
Long-form description / steps to reproduce. This becomes the initial comment on the ticket.
string
An external ID to link this ticket to records in another system.
string ("problem" | "incident" | "question" | "task")
The type of this ticket. Allowed values: ‘problem’, ‘incident’, ‘question’, ‘task’.
integer
The ID of the user who requested this ticket.
array
Array of collaborators to CC on the ticket. Each element can be: a user ID (integer), an email address (string), or an object with ‘email’ and optional ‘name’.
array
Array of custom field objects with ‘id’ and ‘value’ properties.
array
Array of user IDs to add as collaborators (CCs) on the ticket.
integer
The custom ticket status id of the ticket.
boolean
If true, any ticket created with a ‘closed’ status bypasses the normal ticket lifecycle and will be created directly in your ticket archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ZENDESK_ORGANIZATIONCreate a new organization in Zendesk. After creation, the organization ID is auto-assigned and returned. Verify the exact ID before performing downstream operations that target this organization. Multiple organizations may share similar names — always confirm the correct organization by ID. This action is irreversible — the organization cannot be recovered once deleted. Use this action when you need to register a new company, customer, or group as a Zendesk organization so you can assign users, tickets, or other resources to it.

Input Parameters

string
required
A unique name for the organization. Leading and trailing whitespace are automatically trimmed. Names differing only by whitespace are treated as duplicates.
array
The tags of the organization
string
Any notes you have about the organization
string
Any details about the organization, such as the address
integer
New tickets from users in this organization are automatically put in this group
string
A unique external id to associate organizations to an external record
array
An array of domain names associated with this organization
boolean
End users in this organization are able to see each other’s tickets
boolean
End users in this organization are able to comment on each other’s tickets

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ZENDESK_REQUESTCreate a new request in Zendesk. Use when an end user needs to submit a support request through the API. The request will be created with the provided subject, description, priority, and other optional fields. Returns the created request with its ID and URL.

Input Parameters

array
Array of tags to apply to the request.
string ("problem" | "incident" | "question" | "task")
The type of the request. Must be one of: ‘question’, ‘incident’, ‘problem’, ‘task’.
string ("new" | "open" | "pending" | "hold" | "solved" | "closed")
The state of the request. Must be one of: ‘new’, ‘open’, ‘pending’, ‘hold’, ‘solved’, ‘closed’. Defaults to ‘new’.
string
required
The subject/title of the request. This is a required field.
string ("urgent" | "high" | "normal" | "low")
The priority of the request. Must be one of: ‘low’, ‘normal’, ‘high’, ‘urgent’. Defaults to ‘normal’.
string
An external ID to link this request to records in another system.
string
required
The initial description or comment on the request. Required — Zendesk’s Create Request API documents comment as mandatory (confirmed live: omitting it returns a 422).
integer
The ID of the user making the request.
array
Custom fields for the request. Each item should include ‘id’ and ‘value’ properties.
string
Name of the requester. If provided with requester_email, creates a user object for the requester.
integer
The numeric ID of the ticket form associated with the request. Only applicable for enterprise accounts.
string
Email of the requester. Must be provided together with requester_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ZENDESK_TARGETCreate a target in Zendesk for triggering outbound integrations. Use when you need to set up a notification channel or integration with external services like Campfire, email, URL webhooks, or other supported targets. Targets can be used with triggers and automation rules. Note: URL targets are being discontinued October 28, 2024 in favor of webhooks. Email targets remain unaffected.

Input Parameters

string
Recipient phone number for clickatell targets.
string
Room name or ID for campfire targets.
string
Email address for email targets (recipient) and get_satisfaction targets (auth).
string
required
A name for the target. Must be unique within the account.
string
API token for basecamp, campfire, pivotal, twitter, and yammer targets.
boolean
Whether the target is active. Defaults to true. Set to false to create without activating.
string
API ID for clickatell targets.
string
Email subject for email targets.
string
Yammer group ID (optional for yammer targets).
string
Password for clickatell targets.
string ("todo" | "message")
Resource type for basecamp targets.
string
Username for clickatell targets.
string
API token for flowdock targets.
string
Attribute name to send for url_target. The ticket field value will be sent as this parameter.
string
Subdomain for campfire targets.
string
Sender phone number for clickatell targets.
string
Project ID for basecamp and pivotal targets.
string ("bug" | "chore" | "feature")
Story type for pivotal targets.
string
URL for basecamp, get_satisfaction, and jira targets. Must be a valid HTTPS URL.
string
Story title for pivotal targets.
string ("basecamp_target" | "campfire_target" | "clickatell_target" | "email_target" | "flowdock_target" | "get_satisfaction_target" | "jira_target" | "pivotal_target" | "twitter_target" | "url_target" | "yammer_target")
required
The type of target to create. Each type requires specific parameters. Available types: basecamp_target, campfire_target, clickatell_target, email_target, flowdock_target, get_satisfaction_target, jira_target, pivotal_target, twitter_target, url_target, yammer_target.
string
Account name for get_satisfaction targets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ZENDESK_TICKETCreate a Zendesk ticket with a subject and initial comment, plus optional ticket properties such as priority, status, assignment, tags, collaborators, followers and custom fields. Returns the ticket ID, agent URL and selected ticket properties.

Input Parameters

array
Array of tags to apply to the ticket.
string
Due date for the ticket in ISO 8601 format. Only applicable for task tickets.
string ("new" | "open" | "pending" | "hold" | "solved" | "closed")
The state of the ticket. Allowed values: ‘new’, ‘open’, ‘pending’, ‘hold’, ‘solved’, ‘closed’.
string
required
Short summary of the issue. Keep it concise (e.g. ‘Cannot log in’).
integer
The ID of the group to assign the ticket to.
string ("urgent" | "high" | "normal" | "low")
Zendesk priority. Must be one of: ‘urgent’, ‘high’, ‘normal’, ‘low’. Defaults to ‘normal’.
array
Array of email CC objects. Write-only field for adding/removing email CCs.
array
Array of follower objects. Write-only field for adding/removing followers.
integer
The ID of the agent to assign to the ticket.
string
required
Long-form description / steps to reproduce. This becomes the initial comment on the ticket.
string
An external ID to link this ticket to records in another system.
string ("problem" | "incident" | "question" | "task")
The type of this ticket. Allowed values: ‘problem’, ‘incident’, ‘question’, ‘task’.
integer
The ID of the user requesting support. If provided, requester_name and requester_email are ignored.
array
Array of collaborators to CC on the ticket. Each element can be: a user ID (integer), an email address (string), or an object with ‘email’ and optional ‘name’.
array
Array of custom field objects with ‘id’ and ‘value’ properties.
string
Name of the requester. If you supply this, you MUST also supply requester_email. Leave both blank to default to the authenticated user. Ignored if requester_id is provided.
integer
The ID of the ticket form to render for the ticket. Enterprise only.
string
Email of the requester. Must accompany requester_name. Ignored if requester_id is provided.
array
Array of user IDs to add as collaborators (CCs) on the ticket.
integer
The ID of a closed ticket to create a follow-up from. The new ticket will be linked to the source ticket.
array
Array of collaborators to add as CCs without removing existing collaborators. Each element can be: a user ID (integer), an email address (string), or an object with ‘email’ and optional ‘name’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ZENDESK_TICKET_OR_VOICEMAIL_TICKETCreate a ticket in Zendesk via the voice/channel API endpoint. Use this action when you need to create tickets from phone calls, voicemails, or other voice channel interactions. Returns ticket_id and ticket_url for the created ticket. This endpoint is specifically for Zendesk Talk/voice channel ticket creation.

Input Parameters

array
Array of tags to apply to the ticket.
string ("new" | "open" | "pending" | "hold" | "solved" | "closed")
The state of the ticket. Allowed values: ‘new’, ‘open’, ‘pending’, ‘hold’, ‘solved’, ‘closed’.
integer
The via ID for the channel through which the ticket was created.
string
required
Short summary of the issue. Keep it concise (e.g. ‘Cannot log in’ or ‘Voicemail from customer’).
integer
The ID of the group to assign the ticket to.
string ("urgent" | "high" | "normal" | "low")
Zendesk priority. Must be one of: ‘urgent’, ‘high’, ‘normal’, ‘low’. Defaults to ‘normal’.
integer
The ID of the agent to assign to the ticket.
string
required
Long-form description / steps to reproduce. This becomes the initial comment on the ticket.
string
An external ID to link this ticket to records in another system.
string ("problem" | "incident" | "question" | "task")
The type of this ticket. Allowed values: ‘problem’, ‘incident’, ‘question’, ‘task’.
integer
The ID of the user requesting support. If provided, requester_name and requester_email are ignored.
array
Array of custom field objects with ‘id’ and ‘value’ properties.
object
Voice comment details for voicemail tickets.
string
Name of the requester. If you supply this, you MUST also supply requester_email. Leave both blank to default to the authenticated user. Ignored if requester_id is provided.
string
Email of the requester. Must accompany requester_name. Ignored if requester_id is provided.
integer
Optional agent ID who will see the newly created ticket. Use this to route the ticket to a specific agent for immediate attention.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ZENDESK_USERTool to create a new user in Zendesk. Search for existing users first to avoid duplicate accounts with the same email. Use when you need to onboard a user with specific details.

Input Parameters

object
required
User object containing all attributes to create name is mandatory; omitting it causes a validation error. role must be one of: ‘end-user’, ‘agent’, or ‘admin’. organization_id must be a numeric ID of an existing organization — not a name string. Only include fields supported by the Zendesk user schema; unsupported or incorrectly typed fields trigger validation errors.
boolean
If true, do not send a verification email upon creation. Passed as a URL query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_CREATE_ZENDESK_USER_FIELDCreate a custom user field in Zendesk. Use when you need to define a new custom field to capture additional user data. Supports text, checkbox, dropdown, multiselect, date, integer, decimal, regexp validation, and lookup types. Only administrators can create user fields.

Input Parameters

string
required
Unique key that identifies this custom field. Must contain only letters, numbers, and underscores. Cannot be only numbers.
string
Tag value for checkbox fields
string ("checkbox" | "date" | "decimal" | "dropdown" | "integer" | "lookup" | "multiselect" | "regexp" | "text" | "textarea")
required
The custom field type. Options: ‘checkbox’, ‘date’, ‘decimal’, ‘dropdown’, ‘integer’, ‘lookup’, ‘multiselect’, ‘regexp’, ‘text’, ‘textarea’.
string
required
The title (label) displayed for this custom field
boolean
If true, this field is available for use. Defaults to true.
integer
Ordering of the field relative to other user fields
string
Dynamic content placeholder for title (supports i18n placeholders)
string
User-defined description of this field’s purpose
string
Dynamic content placeholder for description (supports i18n placeholders)
object
Filter definition for autocomplete results in lookup fields.
array
Required for ‘dropdown’ and ‘multiselect’ types. Each option has a name (display) and value (internal tag).
string
Regular expression pattern for validation. Required for ‘regexp’ type fields.
string
Target type for ‘lookup’ fields. Options: ‘zen:user’, ‘zen:organization’, ‘zen:ticket’, ‘zen:custom_object:{key}‘

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_ACCESS_RULEDelete an access rule for a custom object in Zendesk. This action is irreversible — the access rule cannot be recovered once deleted. Use when you need to remove access control rules for custom objects.

Input Parameters

string
required
The access rule ID
string
required
The key of a custom object

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_AUTOMATIONPermanently deletes an automation in Zendesk. This action is irreversible — the automation will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete automations or removing test data. Note: You might be restricted from deleting automations that are active or referenced by other rules.

Input Parameters

integer
required
The ID of the automation to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_BUSINESS_HOURS_SCHEDULEPermanently deletes a business hours schedule in Zendesk. Use when you need to remove obsolete schedules or clean up test data. This action is irreversible — the schedule cannot be recovered once removed. Admin permissions are required. Note: Schedules that are currently in use by active SLA policies or other configurations may not be deletable.

Input Parameters

integer
required
The ID of the schedule to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_CUSTOM_OBJECT_RECORD_ATTACHMENTPermanently deletes an attachment from a custom object record in Zendesk. Use this action when you need to remove a specific file attachment from a custom object record. This action is irreversible — the attachment will be permanently deleted and cannot be recovered once removed. Note: Only attachments that are not required and not the primary attachment can be deleted.

Input Parameters

string
required
The ID of the custom object record attachment to delete
string
required
The ID of the custom object record that contains the attachment to delete
string
required
The key of the custom object that contains the record with the attachment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_CUSTOM_OBJECT_RECORD_BY_EXTERNAL_ID_OR_NAMEPermanently deletes a custom object record in Zendesk by its external ID or name. Use this action when you need to remove a specific record from a custom object. This action is irreversible — the record cannot be recovered once deleted. Requires admin permissions. Note: Either external_id or name must be provided to identify the record to delete.

Input Parameters

string
The name of the custom object record to delete. Use either external_id or name to identify the record.
string
The external ID of the custom object record to delete. Use either external_id or name to identify the record.
string
required
The key of the custom object containing the record to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_DELETED_TICKETPermanently delete a soft-deleted Zendesk ticket by ID. This irreversible operation returns a job status; check the job to confirm completion.

Input Parameters

integer
required
The ID of the deleted ticket to permanently remove

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_DELETION_SCHEDULEPermanently deletes a deletion schedule in Zendesk. This action is irreversible — the deletion schedule will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete deletion schedules or removing test data.

Input Parameters

integer
required
The ID of the deletion schedule to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_GROUP_MEMBERSHIPPermanently deletes a group membership in Zendesk, immediately removing a user from a group. This action is irreversible — the group membership cannot be recovered once deleted. Use when cleaning up obsolete group memberships or removing users from groups. Note: Deleting a group membership does not delete the user or the group itself, only the association between them.

Input Parameters

integer
required
The ID of the group membership to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_GROUP_MEMBERSHIPS_DESTROY_MANYBulk delete Zendesk group memberships by ID. Returns a job status for tracking the asynchronous deletion of the memberships.

Input Parameters

string
Comma-separated list of Zendesk group membership IDs to delete. Example: 26923118307484,26923118307485,26923118307486

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_MACROPermanently deletes a macro in Zendesk. This action is irreversible — the macro will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete macros or removing test data. Note: You might be restricted from deleting macros that are active or referenced by other rules.

Input Parameters

integer
required
The ID of the macro to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_MACROS_DESTROY_MANYBulk delete macros in Zendesk. This action is irreversible — the macros will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete macros or removing test data.

Input Parameters

string
required
Comma-separated list of Zendesk macro IDs to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_MANY_AUTOMATIONSBulk delete automations in Zendesk. This action is irreversible — the automations will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete automations or removing test data.

Input Parameters

string
required
Comma-separated list of Zendesk automation IDs to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_MANY_OBJECT_TRIGGERSBulk delete triggers for a Zendesk custom object. This action is irreversible — the triggers will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete triggers or removing test data for a specific custom object. Returns a success indicator upon completion. Requires the custom object key and a comma-separated list of trigger IDs to identify which triggers to delete.

Input Parameters

string
required
A comma separated list of trigger IDs to delete
string
required
The key of a custom object

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_MANY_ORGANIZATION_MEMBERSHIPSBulk delete organization memberships in Zendesk. This action is irreversible — the memberships will be permanently removed and cannot be recovered once deleted. Use when cleaning up obsolete organization memberships or removing users from organizations. Returns a job_status payload (initial status typically ‘queued’); deletions complete asynchronously and may require follow-up polling to confirm completion.

Input Parameters

string
required
Comma-separated list of Zendesk organization membership IDs to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_MANY_VIEWSBulk delete specified Zendesk views. This action is irreversible and returns a success indicator when the deletion succeeds.

Input Parameters

string
required
Comma-separated list of Zendesk view IDs to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_ORGANIZATION_FIELDPermanently deletes an organization field in Zendesk. Use this action when you need to remove a custom organization field from the system. This action is irreversible — the organization field will be permanently deleted and cannot be recovered once removed. Any data stored in this field across all organizations will be lost. Note: Ensure no organizations are using this field before deletion, as the deletion cannot be undone.

Input Parameters

string
required
The ID or key of the organization field to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_ORGANIZATION_MEMBERSHIPPermanently removes a user from an organization in Zendesk by deleting the organization membership. This action is irreversible — the membership cannot be recovered once deleted. Use this action when you need to remove a user’s association with an organization. This operation requires admin permissions.

Input Parameters

integer
required
The ID of the organization membership to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_ORGANIZATIONS_TAGSRemove all tags from a Zendesk organization. Use when you need to clear organization tags as part of cleanup or reorganization tasks. This action is irreversible — the tags will be permanently removed from the organization and cannot be recovered once deleted.

Input Parameters

integer
required
The ID of the organization whose tags will be removed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_ORGANIZATION_SUBSCRIPTIONPermanently deletes an organization subscription in Zendesk. This action is irreversible — the subscription cannot be recovered once removed. Use when you need to remove an organization subscription.

Input Parameters

integer
required
The ID of the organization subscription to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_RESOURCE_COLLECTIONSDelete a resource collection in Zendesk. Use when you need to remove a resource collection that is no longer needed. This action returns a job status that can be polled to track the deletion progress. This operation is irreversible; confirm the correct resource_collection_id before executing.

Input Parameters

integer
required
The ID of the resource collection to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_SUSPENDED_TICKETS_DESTROY_MANYPermanently deletes multiple suspended tickets in Zendesk. This action is irreversible — the suspended tickets will be permanently deleted and cannot be recovered once removed. Use when cleaning up spam or irrelevant suspended tickets. Accepts up to 100 ticket IDs per request.

Input Parameters

string
required
A comma-separated list of suspended ticket IDs to delete (max 100)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_TARGETPermanently deletes a target in Zendesk. This action is irreversible — the target will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete targets or removing test data. Note: Deleting a target that is actively used by triggers or other automation rules may cause those rules to fail.

Input Parameters

integer
required
The ID of the target to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_TICKET_FIELDPermanently deletes a ticket field in Zendesk. Use this action when you need to remove a custom ticket field that is no longer needed. This action is irreversible — the ticket field and all associated data will be permanently deleted and cannot be recovered once removed. Requires admin permissions. Note: System ticket fields cannot be deleted. Only custom ticket fields can be removed.

Input Parameters

boolean
If true, displays the creator_user_id and creator_app_name properties in the response. If the ticket field is created by an app, creator_app_name is the name of the app and creator_user_id is -1. If the ticket field is not created by an app, then creator_app_name is null
integer
required
The ID of the ticket field to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_TICKET_FIELD_OPTIONPermanently deletes an option from a ticket field in Zendesk. Use this action when you need to remove a specific selectable option from a dropdown or multiselect ticket field. This action is irreversible — the ticket field option will be permanently deleted and cannot be recovered once removed. Note: Only custom options can be deleted. System-defined options cannot be removed.

Input Parameters

integer
required
The ID of the ticket field containing the option to delete
integer
required
The ID of the ticket field option to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_TICKETS_TAGSRemove tags from a Zendesk ticket. This action is irreversible; once tags are removed, they cannot be recovered without re-adding them. Use when you need to clean up ticket tags, remove outdated labels, or clear all tags from a ticket.

Input Parameters

string
Comma-separated list of tag names to remove from the ticket. If not provided, all tags will be removed from the ticket.
integer
required
The ID of the ticket to remove tags from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_TRIGGERPermanently deletes a trigger in Zendesk. This action is irreversible — the trigger will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete triggers or removing test data. Note: You might be restricted from deleting triggers that are active or referenced by other rules.

Input Parameters

integer
required
The ID of the trigger to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_TRIGGER_CATEGORYPermanently deletes a trigger category in Zendesk. This action is irreversible — the trigger category will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete trigger categories or removing test data. Note: You might be restricted from deleting trigger categories that are in use by active triggers.

Input Parameters

string
required
The ID of the ticket trigger category to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_USER_FIELDPermanently deletes a user field in Zendesk, removing it from all user profiles. This action is irreversible — the field and all its associated data will be permanently lost. Use when cleaning up deprecated custom fields or removing test fields.

Input Parameters

string
required
The ID or key of the user field to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_USER_FIELD_OPTIONPermanently deletes an option from a user field in Zendesk. Use this action when you need to remove a specific selectable option from a dropdown or multiselect user field. This action is irreversible — the user field option will be permanently deleted and cannot be recovered once removed.

Input Parameters

string
required
The ID or key of the user field containing the option to delete
integer
required
The ID of the user field option to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_USER_PERMANENTLYPermanently deletes a soft-deleted user from Zendesk. This action is irreversible - once a user is permanently deleted, it cannot be recovered. Use this action to remove users that were previously soft-deleted using the delete_user action. Use this action when you need to permanently remove a user that has already been deleted and is no longer accessible through normal operations. This action requires appropriate admin permissions.

Input Parameters

integer
required
The ID of the deleted user to permanently remove

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_USER_PROFILEPermanently deletes a user profile in Zendesk by its profile ID. This action is irreversible — the profile and all associated data will be permanently lost. Use when cleaning up duplicate profiles, test profiles, or removing profiles that are no longer needed. Requires agent-level access with appropriate role permissions.

Input Parameters

string
required
The Sunshine profile ID of the user profile to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_USERS_DESTROY_MANYBulk delete users from Zendesk by their IDs or external IDs. This action is irreversible — once deleted, users cannot be recovered. Use when cleaning up test data, removing obsolete accounts, or consolidating user records in bulk. The operation returns a job_status payload (initial status typically ‘queued’); deletions complete asynchronously and may require follow-up polling via the job_status URL to confirm completion.

Input Parameters

string
Comma-separated list of Zendesk user IDs to delete (max 100). Required if external_ids is not provided.
string
Comma-separated list of Zendesk external user IDs to delete (max 100). Required if ids is not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_USER_SESSIONDelete a specific user session in Zendesk. Use this action when you need to invalidate and remove a specific user session. This action is irreversible — the session cannot be recovered once deleted. Use when you need to forcibly log out a user or remove a specific session from their account for security or administrative purposes.

Input Parameters

integer
required
The ID of the user
integer
required
The ID of the session to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_USERS_GROUP_MEMBERSHIPSPermanently deletes a user’s group membership in Zendesk, immediately removing a user from a group. This action is irreversible — the group membership cannot be recovered once deleted. Use when cleaning up obsolete group memberships, removing users from groups, or revoking group access. Note: Deleting a group membership does not delete the user or the group itself, only the association between them. The user will no longer have access to tickets routed to that group.

Input Parameters

integer
required
The numeric ID of the user whose group membership to delete
integer
required
The numeric ID of the group membership to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_USERS_IDENTITYDeletes an identity for a given user in Zendesk. Use when you need to remove a specific identity (e.g., email, phone, social login) from a user’s account. This action is irreversible — once the identity is deleted, it cannot be recovered. Ensure you have the correct user_id and user_identity_id before executing.

Input Parameters

integer
required
The ID of the user
integer
required
The ID of the user identity to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_USERS_ME_LOGOUTDelete the current authenticated session in Zendesk. This action invalidates the current API session, requiring re-authentication for future API calls. Use when you need to explicitly log out the current user session or terminate an active authenticated connection. This action is irreversible — the session cannot be recovered once deleted. Note: This action targets the authenticated user’s own session only and cannot terminate other user sessions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_USERS_ORGANIZATION_MEMBERSHIPSPermanently removes a user from an organization in Zendesk by deleting the organization membership for a specific user. This action is irreversible — the membership cannot be recovered once deleted. Use this action when you need to remove a user’s association with an organization for a specific user. This operation requires admin permissions.

Input Parameters

integer
required
The ID of the user
integer
required
The ID of the organization membership to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_USERS_SESSIONSBulk delete all sessions for a specific user in Zendesk. This action invalidates all active sessions for the specified user, forcing them to re-authenticate on their next API call or login. Use when you need to forcibly log out a user by revoking all their active sessions, such as during security incidents or account deactivation. This action is irreversible — all sessions for the user will be immediately invalidated and cannot be recovered.

Input Parameters

integer
required
The ID of the user whose sessions to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_USERS_TAGSRemove tags from a Zendesk user. Use when you need to clean up user tags, remove outdated labels, or clear all tags from a user account. This action is irreversible — once tags are removed, they cannot be recovered without re-adding them.

Input Parameters

string
Comma-separated list of tag names to remove from the user. If not provided, all tags will be removed from the user.
integer
required
The ID of the user to remove tags from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_VIEWDelete a specified Zendesk view. Returns a success indicator for both a 204 deletion response and a 404 response indicating the view was not found.

Input Parameters

integer
required
The ID of the view to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_ZENDESK_APP_INSTALLATIONPermanently removes an installed app from Zendesk. Use when you need to uninstall an app from your Zendesk instance. This action is irreversible — the app installation cannot be recovered once removed. Admin permissions are required.

Input Parameters

integer
required
The ID of the app installation to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_ZENDESK_BOOKMARKPermanently deletes a bookmark in Zendesk. Use when you need to remove a user bookmark. This action is irreversible — the bookmark cannot be recovered once deleted.

Input Parameters

integer
required
The ID of the bookmark to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_ZENDESK_CUSTOM_OBJECTPermanently deletes a custom object definition in Zendesk. Use this action when you need to remove a custom object type and all its associated records. This action is irreversible — the custom object and all its data will be permanently deleted and cannot be recovered once removed. Requires admin permissions. Note: Deleting a custom object will also delete all records associated with it.

Input Parameters

string
required
The key of the custom object to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_ZENDESK_CUSTOM_OBJECT_FIELDPermanently deletes a custom object field in Zendesk. Use this action when you need to remove a specific field from a custom object definition. This action is irreversible — the field and all its data will be permanently deleted and cannot be recovered once removed. Requires admin permissions.

Input Parameters

string
required
The key of the custom object that contains the field to delete
string
required
The key or ID of the custom object field to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_ZENDESK_CUSTOM_OBJECT_RECORDDelete a specified Zendesk custom object record by object key and record ID. Deletion is irreversible; the tool also reports success when Zendesk returns 404, so success does not establish that a record was deleted.

Input Parameters

string
required
The key of the custom object containing the record to delete
string
required
The ID of the custom object record to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_ZENDESK_CUSTOM_STATUSPermanently deletes a custom ticket status in Zendesk. Use this action when you need to remove a custom ticket status from the system. This action is irreversible — the custom status will be permanently deleted and cannot be recovered once removed. Note: Ensure no tickets are using this custom status before deletion.

Input Parameters

integer
required
The ID of the custom ticket status to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_ZENDESK_DYNAMIC_CONTENT_ITEMPermanently deletes a dynamic content item in Zendesk. This action is irreversible — the dynamic content item cannot be recovered once deleted. Always confirm the correct dynamic_content_item_id before executing.

Input Parameters

integer
required
The ID of the dynamic content item to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_ZENDESK_DYNAMIC_CONTENT_ITEM_VARIANTPermanently deletes a dynamic content item variant in Zendesk. This action is irreversible — the variant cannot be recovered once deleted. Always confirm the correct dynamic_content_item_id and dynamic_content_variant_id before executing.

Input Parameters

integer
required
The ID of the dynamic content item containing the variant to delete
integer
required
The ID of the variant to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_ZENDESK_OBJECT_TRIGGERPermanently deletes a custom object trigger in Zendesk. Use this action when you need to remove a specific trigger from a custom object definition. This action is irreversible — the trigger and all its data will be permanently deleted and cannot be recovered once removed. Requires admin permissions.

Input Parameters

integer
required
The ID of the trigger to delete
string
required
The key of the custom object that contains the trigger to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_ZENDESK_ORGANIZATIONDelete an organization in Zendesk. This operation is irreversible; confirm organization_id and get explicit user confirmation before calling.

Input Parameters

string
required
ID of the organization to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_ZENDESK_SUPPORT_ADDRESSPermanently deletes a support address from Zendesk. This action is irreversible — the support address cannot be recovered once deleted. Use this action when you need to remove a deprecated or unwanted support email address from your Zendesk account. This operation requires admin permissions and the support address must not be set as the default address. Deleting an address that is actively used may impact email routing.

Input Parameters

integer
required
The ID of the support address to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_ZENDESK_TICKETPermanently deletes a ticket in Zendesk, including its entire conversation history. This action is irreversible; always confirm the correct ticket_id before executing.

Input Parameters

integer
required
ID of the ticket to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DELETE_ZENDESK_USERTool to permanently delete a user from Zendesk. Use when you need to remove a user account. This action cannot be undone and requires appropriate admin permissions.

Input Parameters

integer
required
The ID of the user to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DESTROY_MANY_DELETED_TICKETSPermanently deletes multiple soft-deleted tickets in Zendesk. This action is irreversible — the tickets will be permanently removed and cannot be recovered once executed. Use when cleaning up test tickets or removing obsolete soft-deleted tickets in bulk. The operation returns a job_status payload (initial status typically ‘queued’); deletions complete asynchronously and may require follow-up polling to confirm completion. Maximum 100 tickets per request.

Input Parameters

string
required
Comma-separated list of ticket IDs to permanently delete (max 100). Only soft-deleted tickets can be destroyed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DESTROY_MANY_ORGANIZATIONSBulk delete Zendesk organizations. This action is irreversible - once organizations are deleted, they cannot be recovered. Use when you need to remove multiple organizations in a single operation. Returns a job_status payload (initial status typically ‘queued’); deletions complete asynchronously and may require follow-up polling to confirm completion. Maximum 100 organizations per request. Use this action when you need to clean up test data, remove obsolete organizations, or perform bulk organization deletions. You must provide either ‘ids’ (comma-separated list of Zendesk organization IDs) or ‘external_ids’ (comma-separated list of external IDs).

Input Parameters

string
Comma-separated list of Zendesk organization IDs to delete (max 100). Required if external_ids is not provided.
string
Comma-separated list of Zendesk external organization IDs to delete (max 100). Required if ids is not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DETECT_BEST_LOCALEDetect a Zendesk locale using the detect-best-locale endpoint and return its locale details. The request uses connection headers rather than accepting browser language settings as an input.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DOWNLOAD_ATTACHMENTDownload the file bytes for one Zendesk ticket attachment ID. Zendesk attachment IDs first resolve to metadata. This action then downloads the provider-issued content URL and returns the file for use by other tools.

Input Parameters

string
required
The attachment ID from a Zendesk ticket comment, as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_DOWNLOAD_CUSTOM_OBJECT_RECORD_ATTACHMENTDownload an attachment from a Zendesk custom object record and return it as a downloadable file. An inline option is sent to Zendesk with the request.

Input Parameters

string
required
The id of a custom object record attachment. You can find attachment IDs in the custom object record’s attachment list.
boolean
If true, the attachment content is displayed inline in the browser (e.g., for viewing images). If false or omitted, the attachment is downloaded as a file.
string
required
The id of a custom object record. You can find record IDs by listing or searching custom object records.
string
required
The key of a custom object. You can find custom object keys by listing custom objects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ABOUT_MEGet information about the currently authenticated user in Zendesk. Returns only the caller’s own account; to look up other users, use ZENDESK_SEARCH_ZENDESK_USERS. Response nests the user object under data.owner_info.user. Useful for verifying the acting user’s identity and permissions before performing bulk operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ACCOUNT_SETTINGSRetrieve Zendesk account settings. Use this action when you need to view the configuration and feature flags for a Zendesk account, including API settings, branding, ticket preferences, chat configuration, voice settings, and more.

Input Parameters

string
Legacy CSRF token. Ignored by API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ACTIVE_TRIGGERSList a page of active Zendesk ticket triggers, including their conditions, actions, and metadata when returned. Supports pagination, sorting, and category filtering for auditing automation rules.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: traditional uses ?page=2 (integer page number); cursor uses ?page[size]=50&page[after]=cursor (deepObject with size, after, before). Mutually exclusive.
string
Cursor-based pagination only. Possible values are ‘alphabetical’, ‘created_at’, ‘updated_at’, or ‘position’.
string
Offset pagination only. Possible values are ‘alphabetical’, ‘created_at’, ‘updated_at’, ‘usage_1h’, ‘usage_24h’, or ‘usage_7d’. Defaults to ‘position’
integer
Number of records to return per page. Maximum is 100 records per page for the active-triggers endpoint.
string
One of ‘asc’ or ‘desc’. Defaults to ‘asc’ for alphabetical and position sort, ‘desc’ for all others
string
Filter triggers by category ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ACTIVITIES_COUNTCount ticket activities in Zendesk. Returns an approximate count of ticket activities. Use when you need to know how many activities exist in the activity stream for reporting or operational purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ALL_ZENDESK_ORGANIZATIONSGet Zendesk organizations in an organizations array, automatically fetching numbered pages until an empty page is returned. The action accepts no server-side filters; filter results client-side and disambiguate similar names or domains before acting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_APPGet a single Zendesk app by its numeric ID. Use when you have an app ID and need to retrieve the app’s details including name, author information, version, installation count, categories, and description.

Input Parameters

integer
required
The numeric ID of the Zendesk app to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_APPS_INSTALLATIONS_REQUIREMENTSList all requirements for a Zendesk app installation. Use when you need to check what configuration or parameters are required for a specific installed app to function properly. Requirements may include OAuth settings, parameter configurations, or other setup steps needed by the app. This action is read-only and idempotent.

Input Parameters

integer
required
The numeric ID of the app installation to retrieve requirements for. You can find this ID from the app installations list or when working with specific app installations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_APPS_LOCATIONGet details for a specific Zendesk app location by its numeric ID. Returns location properties including visibility settings, orderability, and associated product codes. Use when you have an app_location_id from listing locations or creating apps and need to retrieve detailed location information. Only accessible to admin users.

Input Parameters

integer
required
The numeric ID of the app location to retrieve. This is the internal location ID returned by Zendesk when listing or creating app locations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_APPS_LOCATION_INSTALLATIONSList Zendesk app location installations, returning installation objects and an optional location name. This read-only action is intended for admins.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_APPS_PUBLIC_KEYRetrieves the public key for a specific Zendesk app. The response is in JSON Web Key (JWK) format containing RSA key components (modulus n, exponent e). Use this action when you need to verify JWTs issued by a Zendesk app or establish trust for app-based authentication. This is a read-only operation.

Input Parameters

integer
required
The numeric ID of the Zendesk app whose public key you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_APPS_PUBLIC_KEY_PEMRetrieve a specific Zendesk app’s public key in PEM format. This read-only action can be used to verify app-issued JWTs or establish trust for app-based authentication.

Input Parameters

integer
required
The numeric ID of the Zendesk app whose public key in PEM format you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ATTACHMENTRetrieve details of a single Zendesk attachment by ID, including available file metadata, URLs, and thumbnails.

Input Parameters

integer
required
The numeric ID of the attachment to retrieve. You can find attachment IDs in ticket comments or via the attachments list endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_AUTOCOMPLETE_TAGSSearch for Zendesk tags using autocomplete. Use when you need to find tag suggestions based on a partial tag name for tagging tickets or organizing content.

Input Parameters

string
A substring of a tag name to search for. The API returns registered and recent tags matching this substring.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_AUTOMATIONShow a specific automation by its ID. Use when you need to retrieve details of a single automation rule in your Zendesk account, such as for auditing, modifying, or understanding what actions and conditions are configured for a particular automation. This action is read-only and idempotent.

Input Parameters

integer
required
The ID of the automation to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_AUTOMATIONSList Zendesk automations for review or auditing, with page and page-size parameters and an optional active-status filter.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive - use one format or the other, not both.
string
Field to sort results by. Prefix with - for descending order. When used with cursor pagination, this determines the cursor ordering. Example: ?sort=name or ?sort=-created_at
boolean
Filter by active automations if true or inactive automations if false
string
A sideload to include in the response. See Zendesk API documentation for available sideloads.
integer
Number of records to return per page. Default and maximum values vary by endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_AUTOMATIONS_SEARCHSearch for Zendesk automations by their title. Use when you need to find automations in your Zendesk account by searching for keywords in their titles. Automations are business rules that automatically perform actions when certain conditions are met. This action supports filtering by active status and sorting results.

Input Parameters

string
required
Query string used to find all automations with matching title. Case-insensitive partial match on automation titles.
boolean
Filter automations by active status. Set to true to return only active automations, or false to return only inactive automations. When not specified, returns both active and inactive automations.
string
Sideload related data to include in the response. Currently supported: ‘usage_24h’ returns statistics about how many times each automation was triggered in the last 24 hours.
string ("alphabetical" | "created_at" | "updated_at" | "position")
Field to sort results by. Options: ‘alphabetical’ (sorts A-Z), ‘created_at’ (by creation date), ‘updated_at’ (by last modification), ‘position’ (by dashboard position). If unspecified, automations are sorted by relevance to the query.
string ("asc" | "desc")
Sort order direction. Options: ‘asc’ (ascending) or ‘desc’ (descending). Defaults to ‘asc’ for alphabetical and position sorts, ‘desc’ for created_at and updated_at sorts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_BRANDSList Zendesk brands and retrieve metadata such as default status, subdomain, and host mapping. Supports cursor pagination and a per-page parameter.

Input Parameters

string
Field to sort results by. Prefix with - for descending order. When used with cursor pagination, this determines the cursor ordering.
integer
Number of records to return per page. Default and maximum values vary by endpoint.
integer
Number of brands to return per page (cursor pagination). Sent as the ‘page[size]’ query parameter.
string
Cursor for the next page of results (cursor pagination). Use the value from the previous response’s ‘links.next’ URL. Sent as the ‘page[after]’ query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_BRANDS2Show a Brand. Use when you have a brand ID and need to retrieve detailed information about a specific Zendesk brand, including its name, subdomain, active status, Help Center configuration, logo, and associated ticket forms.

Input Parameters

integer
required
The numeric ID of the brand to retrieve. This is the brand ID returned from list brands operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_BRANDS_AGENTSList agents assigned to a specific brand in Zendesk. Use when you need to enumerate which agents have access to a specific brand, such as auditing brand access permissions or determining which agents can access a brand’s help center. This is a read-only, idempotent operation.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive - use one format or the other, not both.
string
Field to sort results by. Prefix with - for descending order. When used with cursor pagination, this determines the cursor ordering.
integer
required
The ID of the brand to list agents for.
integer
Number of records to return per page. Default and maximum values vary by endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_CUSTOM_OBJECT_FIELDS_LIMITGet the current count and maximum limit for custom object fields in Zendesk. Returns the number of fields currently defined for a specific custom object and the maximum allowed limit. Use when you need to check how many fields have been created for a custom object and how much capacity remains before hitting the limit. This is a read-only operation that does not modify any data.

Input Parameters

string
required
The key of a custom object

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_CUSTOM_OBJECT_RECORDS_LIMITGet the current record limit and usage count for custom objects in Zendesk. Returns the current number of custom object records and the maximum allowed limit. Use when you need to check how many custom object records have been created and how much capacity remains. This is a read-only operation that does not modify any data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_CUSTOM_OBJECTS_LIMITGet the current count and maximum limit for custom objects in Zendesk. Use when you need to check how many custom objects exist in your Zendesk account and what the allowed limit is, to avoid exceeding capacity or to plan for scaling.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_CUSTOM_STATUSGet a specific custom ticket status from Zendesk by its ID. Use when you have a custom status ID from ticket payloads or from listing custom statuses and need to retrieve the full status details including agent/end-user labels, descriptions, and status category. This is a read-only, idempotent operation that retrieves the current state of a custom ticket status.

Input Parameters

integer
required
The numeric ID of the custom status to retrieve. This is the custom status ID found in ticket payloads or from listing custom statuses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_CUSTOM_STATUSESList custom ticket statuses available in a Zendesk account. Use when you need to retrieve all undeleted custom ticket statuses, optionally filtered by status category, active state, or default status. This action is useful for understanding available custom statuses for ticket workflows, automation rules, or displaying status options to users.

Input Parameters

boolean
If true, show only active custom ticket statuses. If false, show only inactive custom ticket statuses. If the filter is not used, show all custom ticket statuses.
boolean
If true, show only default custom ticket statuses. If false, show only non-default custom ticket statuses. If the filter is not used, show all custom ticket statuses.
string
Filter the list of custom ticket statuses by a comma-separated list of status categories. Example: ‘new,open,pending’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_DELETED_TICKETSLists tickets that have been deleted from Zendesk, showing up to 100 deleted tickets per page with pagination. Use when you need to retrieve information about previously deleted tickets or audit ticket deletions. This action is read-only and idempotent.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive.
string ("id" | "subject" | "deleted_at" | "created_at" | "updated_at" | "status" | "requester" | "requester.name" | "group" | "assignee" | "assignee.name")
Sort field options for deleted tickets.
integer
Number of records to return per page (max 100). Default and maximum values vary by endpoint.
string ("asc" | "desc")
Sort order options.
string ("all" | "agent" | "ai_agent")
Support type scope options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_DELETED_USERRetrieves a single deleted Zendesk user by their ID. Use when you have a specific deleted user ID and need to fetch details about that deleted user, such as for auditing purposes, account recovery, or compliance records. Deleted users retain their associated tickets and historical data.

Input Parameters

integer
required
The numeric ID of the deleted user to retrieve. You can find this from the deleted users list endpoint or from previous user search results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_DELETION_SCHEDULERetrieve a specific deletion schedule from Zendesk by its ID. Use this action when you need to get the details of a particular deletion schedule, including its title, description, active status, object type, conditions, and creation/update timestamps. This action is read-only and idempotent.

Input Parameters

integer
required
The unique ID of the deletion schedule to retrieve. Must be a non-negative integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_DELETION_SCHEDULESList all deletion schedules for the current Zendesk account. Use when you need to retrieve, audit, or review the deletion schedule rules configured in your Zendesk account. Deletion schedules define automated data retention policies that periodically remove specified entity types based on configured conditions. Only Zendesk admins can access this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_DYNAMIC_CONTENT_ITEMSList dynamic content items configured in your Zendesk account, including localization variants and placeholder metadata. This read-only operation supports offset pagination and sorting.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: traditional using ?page=2 (integer page number), or cursor using ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive.
string
Field to sort results by. Prefix with - for descending order. When used with cursor pagination, this determines the cursor ordering.
integer
Number of records to return per page. Default and maximum values vary by endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_DYNAMIC_CONTENT_ITEM_SHOWShow a specific dynamic content item by its ID. Use when you have a dynamic content item ID and need to retrieve its details, including name, default locale, placeholder value, variants, and creation/update timestamps. This is a read-only, idempotent operation that returns a single dynamic content item.

Input Parameters

integer
required
The ID of the dynamic content item to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_DYNAMIC_CONTENT_ITEMS_SHOW_MANYRetrieve multiple dynamic content items by their identifiers. Use when you have specific dynamic content item IDs or names and need to fetch their metadata including placeholder, default locale, variants, and outdated status. This is a read-only, idempotent operation. The ‘identifiers’ parameter accepts comma-separated values; omit it to retrieve all items (use with caution on accounts with many items).

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: traditional uses ?page=2 (integer page number); cursor uses ?page[size]=50&page[after]=cursor (deepObject with size, after, before). Mutually exclusive.
integer
Number of records to return per page. Maximum is 100 records per page for the dynamic-content-items endpoint.
string
Comma-separated list of dynamic content item identifiers to retrieve. Each identifier can be an item ID or name. If not provided, returns all items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_DYNAMIC_CONTENT_ITEMS_VARIANTSList all variants of a specific Zendesk dynamic content item. Use when you need to retrieve all locale variants for a dynamic content item to view, manage, or update the localized content. Variants represent the same content in different locales/languages. Supports pagination and sorting parameters. This action is read-only and idempotent — calling it multiple times with the same parameters will return the same results without side effects.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive - use one format or the other, not both.
string
Field to sort results by. Prefix with - for descending order. When used with cursor pagination, this determines the cursor ordering. Example: ?sort=name or ?sort=-created_at
integer
Number of records to return per page. Default and maximum values vary by endpoint.
integer
required
The ID of the dynamic content item whose variants to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_DYNAMIC_CONTENT_ITEM_VARIANTShow a specific variant of a dynamic content item in Zendesk. Use when you have a dynamic_content_item_id and dynamic_content_variant_id and need to retrieve the variant’s details including its content, locale, active status, and timestamps. This is a read-only operation. Dynamic content items allow you to create reusable content that can be localized into multiple variants for different languages or contexts.

Input Parameters

integer
required
The ID of the dynamic content item
integer
required
The ID of the variant

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_EMAIL_NOTIFICATIONRetrieve details of a single email notification in Zendesk by its notification ID. Use when you have a notification_id from ticket audit logs or email notifications list and need to fetch full notification details including recipients, delivery status, and associated ticket/comment information. This action is useful for tracking email delivery status and troubleshooting email notification issues.

Input Parameters

integer
required
The numeric ID of the email notification to retrieve. You can find notification IDs from ticket audit logs or email notification list responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_EMAIL_NOTIFICATIONSList email notifications from Zendesk. Use this action when you need to retrieve email notification records filtered by ticket, comment, or notification ID. The filter parameter is required to specify which type of ID to filter by. Returns delivery status information for each recipient including any delivery failures.

Input Parameters

string
Field to sort by: ‘created_at’, ‘updated_at’ (ascending) or ‘-created_at’, ‘-updated_at’ (descending)
integer
Number of email notifications to return per page (max 100)
integer
Filter email notifications by ticket ID
integer
Filter email notifications by comment ID
integer
Filter email notifications by notification ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_EMAIL_NOTIFICATIONS_SHOW_MANYRequest Zendesk email notifications by notification IDs, comment IDs, or ticket IDs. The response model exposes only a single optional email notification object.

Input Parameters

string
Comma-separated list of email notification IDs to retrieve. One of ids, comment_ids, or ticket_ids is required.
string
Comma-separated list of ticket IDs to filter email notifications by. One of ids, comment_ids, or ticket_ids is required.
string
Comma-separated list of comment IDs to filter email notifications by. One of ids, comment_ids, or ticket_ids is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_END_USER_IDENTITIESTool to list all identities associated with a specific end user. Use when you need to retrieve the email addresses and/or phone numbers linked to an end user account. Supports optional filtering by identity type (email, phone_number).

Input Parameters

integer
Page number for offset pagination (Zendesk returns up to 100 identities per page).
integer
required
The numeric ID of the end user whose identities to retrieve
integer
Number of identities per page (max 100 per Zendesk offset pagination).
integer
Records per page for cursor pagination (sent as page[size], max 100).
array
Filter results by one or more identity types. Use to filter for ‘email’ or ‘phone_number’ identities. When multiple types are provided, identities matching any of the types are returned.
string
Cursor for forward cursor pagination (sent as page[after]).
string
Cursor for backward cursor pagination (sent as page[before]).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_END_USER_IDENTITYTool to fetch a specific end user identity by user ID and identity ID. Use when you need to retrieve detailed information about a particular user identity in Zendesk.

Input Parameters

integer
required
The numeric ID of the end user
integer
required
The numeric ID of the user identity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_GROUP_MEMBERSHIPGet a group membership by its unique ID. Use when you have a group membership ID and need to retrieve details including the associated group, user, and timestamps. Note: The group_membership_id parameter is the membership ID, not a group ID.

Input Parameters

integer
required
The numeric ID of the group membership to retrieve. Note: This is the group membership ID, not a group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_GROUP_MEMBERSHIPSList all group memberships in your Zendesk account. Group memberships link users to groups, determining which agents belong to which support groups. Use when you need to audit group assignments, manage team memberships, or enumerate the relationship between users and groups. This action supports both offset pagination (page, per_page) and cursor pagination (page_size, page_after, page_before). It also supports sideloading related users and groups via the include parameter. This action is read-only and idempotent.

Input Parameters

integer
Pagination parameter. Supports both traditional offset and cursor-based pagination: traditional uses ?page=2 (integer page number); cursor uses ?page[size]=50&page[after]=cursor. These are mutually exclusive.
string
Field to sort results by. Prefix with - for descending order. Example: ?sort=name or ?sort=-created_at
string
Sideloads to include in the response. Accepts a comma-separated list of values. Valid values: users, groups.
integer
Number of records to return per page.
integer
Number of records per page for cursor pagination. Use with page_after or page_before.
string
Cursor for fetching the next page in cursor pagination. Use with page_size.
string
Cursor for fetching the previous page in cursor pagination. Use with page_size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_GROUP_MEMBERSHIPS_BY_GROUPList group memberships for a specific Zendesk group. Use when you need to retrieve all members assigned to a particular group, audit group membership, or understand which users belong to a specific support group. This action is read-only and idempotent. Supports both offset pagination (page, per_page) and cursor pagination (page_size, page_after, page_before). Also supports sideloading users and groups via the include parameter.

Input Parameters

integer
Page number for offset pagination (starts at 1). Cannot be used with cursor pagination.
string
Field to sort results by. Prefix with - for descending order. Example: ?sort=user_id or ?sort=-created_at
string
Sideloads to include in the response. Accepts a comma-separated list of values. Valid values: users, groups.
integer
required
The numeric ID of the group to retrieve memberships for. This is the group ID, not a membership ID.
integer
Number of records to return per page (max 100).
integer
Number of records per page for cursor pagination (max 100). Use with page_after. Cannot be used with offset pagination.
string
Cursor for fetching next page in cursor pagination. Use with page_size. Cannot be used with offset pagination.
string
Cursor for fetching previous page in cursor pagination. Use with page_size. Cannot be used with offset pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_GROUPS_ASSIGNABLEList all groups that can be assigned to tickets or users in your Zendesk account. Use when you need to enumerate available groups for assignment operations, check group availability, or retrieve group metadata. This is a read-only, idempotent operation.

Input Parameters

integer
Page number for offset pagination (1-100). Limited to first 100 pages or 10,000 records total.
integer
Number of records to return per page (max 100). Default and maximum values vary by endpoint.
integer
Number of records per page for cursor pagination (max 100). Use this for large datasets.
string
Cursor value to retrieve the next page of results. Obtained from previous response’s ‘next_page’ or cursor.
string
Cursor value to retrieve the previous page of results. Obtained from previous response’s ‘prev’ or cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_GROUPS_COUNTCount groups in Zendesk. Returns an approximate count of groups in the system. Use when you need to know how many groups exist for reporting, organizational management, or operational purposes. This action is read-only and idempotent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_GROUPS_USERS_COUNTCount users in a specific Zendesk group. Returns an approximate count of users belonging to the specified group, with optional filtering by role or permission set. Use when you need to know how many users are in a particular group for reporting, resource planning, or administrative purposes. This action is read-only and idempotent.

Input Parameters

string ("end-user" | "agent" | "admin")
User role values for filtering.
integer
required
The numeric ID of the group whose users will be counted. This is the group ID from the Groups API.
array
Filter the results by more than one role. Provide a list of roles to include users matching any of them.
integer
Filter by custom role ID (Enterprise plan and above). Only one role ID per request is allowed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_GROUP_USERSList a page of users belonging to a specific Zendesk group, with optional filtering by user role, permission set, or external ID. This is a read-only operation.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: traditional uses ?page=2 (integer page number); cursor uses ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive.
string ("end-user" | "agent" | "admin")
Filter results by a single role. Use ‘end-user’, ‘agent’, or ‘admin’.
integer
required
The numeric ID of the group. Users belonging to this group will be returned.
integer
Number of records to return per page. Maximum is 100 records per page for the group users endpoint.
array
Filter results by multiple roles. Provide a list of roles to include users matching any of them.
string
Filter by external ID. Must be unique per user under the same account.
integer
Filter by custom role ID (Enterprise plan only). Only one role ID per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_GUIDE_SURVEY_RESPONSESList survey responses from Zendesk Guide. Use when you need to retrieve CSAT survey responses, analyze customer satisfaction scores, or monitor survey completion rates. Survey responses are available on Support Professional plan and above, and Zendesk Suite Growth plan and above. This action is read-only and idempotent.

Input Parameters

string ("id" | "-id")
Sort order for survey responses. Use ‘id’ for ascending or ‘-id’ for descending order.
integer
Number of survey responses to return per page (max 100).
string
Cursor to retrieve the next page of results. Use the ‘after_cursor’ value from a previous response.
string
Cursor to retrieve the previous page of results. Use the ‘before_cursor’ value from a previous response.
array
Filter survey responses by subject Zendesk Resource Names (ZRNs). Format: ‘zen:ticket:123’ for tickets. Example: [‘zen:ticket:1’, ‘zen:ticket:2’]
array
Filter survey responses by responder user IDs. Pass a list of user IDs to only include responses from these users.
string
Filter survey responses created on or before this date. Use ISO 8601 format (e.g., ‘2024-01-15T23:59:59Z’).
string
Filter survey responses created on or after this date. Use ISO 8601 format (e.g., ‘2024-01-15T00:00:00Z’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_GUIDE_SURVEYSList available CSAT (Customer Satisfaction) surveys in Zendesk Guide. Use when you need to retrieve survey definitions, check which surveys are enabled/disabled, or get survey questions and versions. The response includes survey IDs, states, creation timestamps, and question arrays. This is a read-only, idempotent operation.

Input Parameters

string
required
The locale used for the display of the corresponding survey questions and options. Example: ‘en-us’, ‘fr-fr’, ‘de-de’
integer
Number of surveys to return per page (max 100). Use for paginating through large result sets.
string
Cursor for pagination to retrieve the next page of results. Obtain from previous response’s next_page link.
string
A comma-separated list of survey types to filter the results. Common types include ‘csat’ for customer satisfaction surveys.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_INCREMENTAL_ORGANIZATIONSRetrieve organizations that have been modified since a specified start time using the Incremental Organization Export API. Use when you need to sync or track changes to Zendesk organizations over time. Provide a start_time (Unix timestamp) from a previous response’s end_time to paginate through changes incrementally. This action is read-only and idempotent. Organizations may be created, updated, or appear as deleted; interpret based on your use case. Rate limiting may apply for large accounts.

Input Parameters

integer
Number of records to return per page (max 100). Default varies by API tier.
integer
required
Unix timestamp (seconds since epoch) to start the incremental export from. Must be at least one minute in the past. Data isn’t provided for the most recent minute. Use the end_time from a previous response for subsequent pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_INCREMENTAL_ROUTING_ATTRIBUTESExport routing attributes incrementally with optional start_time filtering and cursor-based pagination. Use when you need to retrieve all skill-based routing attributes (attributes, attribute values, and instance values) that have changed in your Zendesk account. This is a read-only operation that returns a stream of changes; it does not include data from the most recent minute. For large datasets, use cursor-based pagination with the after_cursor value from responses. This action is read-only and idempotent — calling it multiple times with the same start_time returns the same results.

Input Parameters

string
The cursor pointer for pagination. Use the after_cursor value from a previous response to fetch subsequent pages of records.
integer
Number of records to return per page. Default and maximum is 1000.
integer
The Unix timestamp to start the incremental export from. The result set includes only records created at or after this time. If not specified, returns records from the beginning of time. Note: Data isn’t provided for the most recent minute.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_INCREMENTAL_ROUTING_ATTRIBUTE_VALUESRetrieve routing attribute values that have been modified since a specified start time using the Incremental Skill-Based Routing API. Use when you need to sync or track changes to routing attributes, values, and their associations over time. Provide a start_time (Unix timestamp) and the API returns all attribute values modified since that time. Call repeatedly with the end_time from each response to paginate through all changes. This action is read-only and idempotent. Note: Data isn’t available for the most recent minute due to eventual consistency. Attribute values may appear as modified; interpret based on your use case.

Input Parameters

string
A non-human-readable cursor for pagination. Use the next_page URL from a previous response to move forward through results. The cursor is read-only and only available in API responses.
integer
Number of records to return per page (max 3000).
integer
required
Unix timestamp (seconds since epoch) marking the start of the incremental export window. Must be at least one minute in the past. Data isn’t provided for the most recent minute. Use the end_time from a previous response for subsequent pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_INCREMENTAL_ROUTING_INSTANCE_VALUESExport incremental routing instance values from Zendesk skill-based routing. Returns a stream of changes that occurred on routing attributes, attribute values, and instance values. Use this action when you need to synchronize routing configuration data or monitor changes to skill-based routing assignments. This action is read-only and supports cursor-based pagination with a maximum of 3000 records per page. Stop paging when the count is 0. Note: The cursor parameter is read-only and should only be obtained from API responses, not manually constructed.

Input Parameters

string
A non-human-readable cursor to move forward or backward in time for pagination. Read-only and only available in API responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_INCREMENTAL_SAMPLERequest a sample incremental export for a resource since a specified start time, to test an export setup. The response exposes ticket records but not user or organization record arrays; data from the most recent minute is not provided.

Input Parameters

integer
Number of records to return per page (max 100).
integer
required
The Unix timestamp (seconds since epoch) to start the incremental export from. Must be at least one minute in the past. Data isn’t provided for the most recent minute.
string
required
The incremental resource to sample. Supported values include ‘tickets’, ‘users’, ‘organizations’, and other incremental export types available in the Zendesk API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_INCREMENTAL_TICKET_EVENTSExport incremental ticket events from Zendesk. Use when you need to track changes to tickets over time, monitor agent performance metrics, or sync ticket event data with an external system. This action returns a stream of ticket metric events (like agent work time, reply times) that occurred after the specified start_time. Call repeatedly with the end_time from each response to continue exporting events. Data isn’t available for the most recent minute due to eventual consistency. Note: This is a read-only, idempotent operation. The start_time must be at least one minute in the past.

Input Parameters

string
Sideloads to include in the response. Accepts a comma-separated list of values. Supports ‘comment_events’ to include full comment data in the response.
integer
required
The time to start the incremental export from. Must be at least one minute in the past. Data isn’t provided for the most recent minute due to eventual consistency delays.
string ("all" | "agent" | "ai_agent")
Scope for filtering tickets by support type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_INCREMENTAL_TICKET_METRIC_EVENTSList ticket metric events in Zendesk that occurred on or after a specified time. This action supports incremental data export — use the end_time from one response as the start_time for the next request to retrieve subsequent events. This action is read-only and idempotent — use it to monitor ticket metrics, track SLA compliance, or build analytics dashboards. Note: deleted tickets can create orphan metric events; use exclude_deleted=true to filter these out.

Input Parameters

integer
Page number for offset pagination. Zendesk returns up to 1000 records per page for incremental exports.
integer
Number of records per page (max 1000 for incremental exports).
integer
required
The Unix UTC epoch time of the oldest event you’re interested in. Only events that occurred on or after this time are returned. Example: 1332034771.
boolean
When true, excludes ticket metric events for deleted tickets. Use this to avoid receiving events for tickets that have been deleted.
boolean
This optional parameter enhances incremental data retrieval, delivering a consistent and accurate representation of data changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_INCREMENTAL_TICKETSRetrieve tickets modified since a specified start time using the incremental ticket export, and use the response’s end_time for subsequent requests. The support type defaults to agent; select all to include other support types, and note that data from the most recent minute is not provided.

Input Parameters

integer
Number of tickets to return per page (max 1000). Default varies by API tier.
integer
required
Unix timestamp (seconds since epoch) to start the incremental export from. Must be at least one minute in the past. Data isn’t provided for the most recent minute. Use the end_time from a previous response for subsequent pagination.
string ("all" | "agent" | "ai_agent")
Filter tickets by support type. Possible values are ‘all’, ‘agent’, or ‘ai_agent’. Defaults to ‘agent’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_INCREMENTAL_TICKETS_CURSORExport tickets incrementally using cursor-based pagination for synchronization, backups, or analytics. Supply a start time for the initial request and use the returned cursor in subsequent requests to fetch further pages.

Input Parameters

string
The cursor pointer for pagination. Use the after_cursor value from a previous response to fetch subsequent pages of tickets.
integer
The Unix timestamp (seconds since epoch) to start the incremental export from. Must be at least one minute in the past. Data isn’t provided for the most recent minute. Required on the initial export request; not required on subsequent cursor-based pagination requests.
string
Filter tickets by support type. Possible values are ‘all’, ‘agent’, or ‘ai_agent’. Defaults to ‘agent’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_INCREMENTAL_USERSRetrieve users that have been modified since a specified start time using the Incremental User Export API. Use when you need to sync or track changes to Zendesk users over time, such as for data warehousing, backup, or external system synchronization. Provide a start_time (Unix timestamp) and the API returns users that have been created, updated, or deleted since that time. Call repeatedly with the end_time from each response to paginate through all changes. This action is read-only and idempotent. Note: Data isn’t available for the most recent minute due to eventual consistency. Users may appear as modified or deleted; interpret based on your use case.

Input Parameters

integer
The number of records to return per page (max 100).
integer
required
The Unix timestamp (seconds since epoch) to start the incremental export from. Must be at least one minute in the past. Data isn’t provided for the most recent minute. Use the end_time from a previous response for subsequent pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_INCREMENTAL_USERS_CURSORExport users incrementally using cursor-based pagination. Use when you need to export all users from Zendesk in a reliable, paginated manner. The start_time parameter is required for the initial request to define the time range. Subsequent requests use the cursor returned in previous responses to fetch the next batch of records. This action is ideal for: - Full user data synchronization to external systems - Regular incremental backups of user data - Building user directories with pagination support Note: Data from the most recent minute is not included to ensure consistency.

Input Parameters

string
The cursor pointer to work with for all subsequent exports after the initial request. Use the cursor returned in the previous response to paginate through all records.
integer
The number of records to return per page (max 100).
integer
The time to start the incremental export from. Must be at least one minute in the past. Data isn’t provided for the most recent minute. Required on the initial export request; not required on subsequent cursor-based pagination requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_JOB_STATUSESList job statuses from Zendesk. Shows the status of all background jobs that have been initiated, including those created by bulk operations like bulk updates, imports, or exports. Each job status includes progress information, completion status, and any results from individual tasks. Use this action to track the progress of long-running operations or check if background tasks completed successfully. Use this action when you need to check the status of background jobs, monitor bulk operation progress, or verify that asynchronous tasks have finished processing.

Input Parameters

integer
Number of records per page for cursor pagination (max 100). Default varies by endpoint.
string
Cursor token to fetch records after this position. Use the ‘after_cursor’ value from a previous response to get the next page.
string
Cursor token to fetch records before this position. Use the ‘before_cursor’ value from a previous response to get the previous page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_JOB_STATUSES2Get a single job status by ID from Zendesk. Shows the status of a background job initiated by bulk operations (like bulk updates, imports, or exports). The response includes progress information, completion status, and any results from individual tasks. Use this action when you have a job_status_id from a previously queued bulk operation and need to check if it completed successfully, failed, or is still processing. Check the ‘status’ field for the current state (‘queued’, ‘working’, ‘completed’, ‘failed’) and the ‘results’ array for individual task outcomes.

Input Parameters

string
required
The unique identifier of the job status to retrieve. This is the job ID returned when a bulk operation was queued.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_LOCALEGet a locale by its ID or BCP-47 code. Use when you need to retrieve details about a specific locale including the locale identifier, language name, and timestamps.

Input Parameters

string
required
The ID or the BCP-47 code of the locale. Examples: es-419, en-us, pr-br, or numeric ID like 1

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_LOCALESList all translation locales available for your Zendesk account. Use when you need to retrieve the available locales for translation purposes, check which languages are enabled, or get locale metadata including the locale code, display name, and creation timestamps. This is a read-only, idempotent operation that supports pagination.

Input Parameters

integer
Page number for pagination.
integer
Number of records to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_LOCALES_AGENTList the translation locales that have been localized for agent use. Use when you need to discover which locales are available for agents to work with in multilingual support scenarios. This is a read-only, idempotent operation that requires no parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_LOCALES_CURRENTShow the current locale for a Zendesk account. Use when you need to determine what language/locale is currently active for the account, which affects how content is displayed to end users and which translations are available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_MACRO2Show a specific macro by its ID. Use when you need to retrieve details of a single macro in your Zendesk account, such as for auditing, modifying, or understanding what actions and conditions are configured for a particular macro. Macros are saved response templates that agents can apply to tickets. Supports optional sideloads for usage statistics and additional metadata via the include parameter.

Input Parameters

string
A sideload to include in the response. See Zendesk API documentation for available sideloads such as ‘usage_7d’, ‘usage_24h’, ‘usage_30d’, ‘permissions’, or ‘categories’.
integer
required
The ID of the macro to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_MACRO_ATTACHMENTSList attachment metadata for a specific Zendesk macro, including filenames, content types, sizes, and download URLs. The response may include a next-page URL.

Input Parameters

integer
required
The numeric ID of the macro whose attachments to list. You can find macro IDs from the macros list endpoint or the macro URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_MACRO_CATEGORIESList all macro categories available to the current Zendesk account. Use when you need to retrieve or browse available macro categories for organizing and applying macros to tickets. This action is read-only and idempotent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_MACRO_DEFINITIONSRetrieve the definitions of all actions that a macro can perform in Zendesk. Use this action when you need to discover what actions are available for macro creation, understand the available values for each action type, or build a macro configuration interface. The response includes action fields, their display titles, types, and available value options. Common macro actions include: setting ticket status, priority, or type; assigning agents or groups; adding/removing tags; setting custom fields; and adding comments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_MACRO_REPLICAShow a macro replica (unpersisted macro representation) based on a macro ID and ticket ID. Use when you need to preview how a macro will look when applied to a specific ticket, allowing you to see the actions and values that will be applied without actually applying the macro. This is useful for testing macro configurations or displaying macro previews in your interface. This action is read-only and idempotent.

Input Parameters

integer
required
The ID of the macro to replicate
integer
required
The ID of the ticket from which to build a macro replica

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_MACROSList all shared and personal macros available in your Zendesk account. Use when you need to retrieve, audit, or review the macros configured for automating ticket responses and actions. Macros are saved response templates that agents can apply to tickets. Supports filtering by access level, active status, category, and group. Results can be sorted by name, creation date, update date, or usage statistics.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive - use one format or the other, not both.
string
Filter macros by access. Possible values are ‘personal’, ‘agents’, ‘shared’, or ‘account’. The ‘agents’ value returns all personal macros for the account’s agents and is only available to admins.
boolean
Filter by active macros if true or inactive macros if false
string
A sideload to include in the response. See Zendesk API documentation for available sideloads.
string ("alphabetical" | "created_at" | "updated_at" | "usage_1h" | "usage_24h" | "usage_7d" | "usage_30d")
Sort order for results. Possible values are ‘alphabetical’, ‘created_at’, ‘updated_at’, ‘usage_1h’, ‘usage_24h’, ‘usage_7d’, or ‘usage_30d’. Defaults to alphabetical
integer
Filter macros by category ID
integer
Filter macros by group ID
integer
Number of records to return per page. Default and maximum values vary by endpoint.
string ("asc" | "desc")
Sort direction. One of ‘asc’ or ‘desc’. Defaults to ‘asc’ for alphabetical and position sort, ‘desc’ for all others
boolean
If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Defaults to false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_MACROS_ACTIONSList supported actions for macros in Zendesk. Use when you need to discover what field modifications are available when creating or editing macros. This endpoint returns the available action fields that can be set in a macro (e.g., status, priority, assignee, etc.) along with their possible values. This is useful for validating macro configurations or building macro management interfaces. This action is read-only and idempotent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_MACROS_ACTIVEList all active shared and personal macros in Zendesk. Use when you need to retrieve, audit, or review the macros configured in your Zendesk account. Macros are saved responses that agents can apply to tickets. This action supports filtering by access level, category, group, and sorting options. Note: This action only returns active macros. The sort_by parameter supports sorting by usage metrics (usage_1h, usage_24h, usage_7d, usage_30d) to identify the most frequently used macros.

Input Parameters

integer
Page number for offset pagination. Zendesk returns up to 100 records per page.
string ("personal" | "agents" | "shared" | "account")
Filter macros by access level.
string
A sideload to include in the response. See Zendesk API documentation for available sideloads.
string ("alphabetical" | "created_at" | "updated_at" | "usage_1h" | "usage_24h" | "usage_7d" | "usage_30d")
Possible values for sorting macros.
integer
Filter macros by category ID
integer
Filter macros by group ID
integer
Number of macros per page for offset pagination (max 100).
integer
Records per page for cursor pagination (sent as page[size], max 100).
string
Cursor for forward cursor pagination (sent as page[after]).
string ("asc" | "desc")
Sort order for macro listing.
string
Cursor for backward cursor pagination (sent as page[before]).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_MACROS_APPLYShow changes to a ticket that would result from applying a macro. Use when you need to preview what changes a macro would make to a ticket before actually applying it. This allows you to review the changes that would be applied, such as assignee changes, group reassignments, comments, or custom field updates. This action is read-only and idempotent — it does not actually modify the ticket.

Input Parameters

integer
required
The ID of the macro to preview

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_MACROS_SEARCHSearch for Zendesk macros by their title. Use when you need to find macros in your Zendesk account by searching for keywords in their titles. Macros are pre-defined responses or actions that can be applied to tickets to automate repetitive tasks. This action supports filtering by access, active status, category, and group, as well as sorting results.

Input Parameters

string
required
Query string used to find macros with matching titles. Case-insensitive partial match on macro titles.
string ("personal" | "agents" | "shared" | "account")
Filter macros by access. Options: ‘personal’ (user’s own macros), ‘agents’ (all personal macros for account’s agents, admin only), ‘shared’ (macros shared with the user), ‘account’ (account-level macros).
boolean
Filter by active macros if true or inactive macros if false. When not specified, returns both active and inactive macros.
string
A sideload to include in the response. See Zendesk docs for available sideloads (e.g., ‘usage_7d’ returns usage statistics for the last 7 days).
string ("alphabetical" | "created_at" | "updated_at" | "position")
Field to sort results by. Options: ‘alphabetical’ (sorts A-Z), ‘created_at’ (by creation date), ‘updated_at’ (by last modification), ‘position’ (by dashboard position). Defaults to alphabetical.
integer
Filter macros by category ID.
integer
Filter macros by group ID.
string ("asc" | "desc")
Sort order direction. Options: ‘asc’ (ascending) or ‘desc’ (descending). Defaults to ‘asc’ for alphabetical and position sorts, ‘desc’ for created_at and updated_at sorts.
boolean
If true, returns only macros that can be applied to tickets. If false (default), returns all macros the current user can manage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_OBJECT_TRIGGERShow a specific trigger for a custom object in Zendesk. Use when you need to retrieve details of a single trigger, such as for auditing, understanding its conditions and actions, or preparing modifications. This action is read-only and idempotent.

Input Parameters

integer
required
The ID of the trigger to retrieve
string
required
The key of a custom object (e.g., ‘car’, ‘order’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_OPEN_REQUESTSList open requests from Zendesk. Use this action when you need to retrieve all requests with “open” status for the authenticated user. Supports sorting by creation date or last update time. This action is read-only and idempotent.

Input Parameters

integer
Page number for paginating through results (starts at 1).
string ("updated_at" | "created_at")
Sort field options for listing open requests.
integer
Number of requests per page (max 100).
string ("asc" | "desc")
Sort order options for listing open requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ORGANIZATION_FIELD2Get details for a specific organization field in Zendesk by its ID or key. Use this action when you need to retrieve detailed information about a single custom organization field, including its type, options, validation rules, and display settings. This is useful for understanding field configuration or before updating/deleting a field. Returns the complete organization field definition with all metadata.

Input Parameters

boolean
If true, resolves dynamic content placeholders in the response
string
required
The ID or key of the organization field to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ORGANIZATION_FIELDSList Zendesk organization field definitions, with an optional page parameter and dynamic content resolution. The response includes pagination links.

Input Parameters

string
Cursor-based pagination parameter. Supports JSON:API style: page[size]=50&page[after]=cursor or page[before]=cursor. Traditional offset: page=2 (integer). Cannot mix formats.
boolean
If true, resolves dynamic content placeholders in the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ORGANIZATION_MEMBERSHIP2Get details for a specific organization membership by its ID. Use when you have an organization membership ID and need to retrieve the associated user, organization, and membership metadata. This action is read-only and idempotent - calling it multiple times with the same membership ID will return the same result.

Input Parameters

integer
required
The numeric ID of the organization membership to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ORGANIZATION_REQUESTSList requests for a specific Zendesk organization. Use when you need to retrieve all requests associated with a particular organization. This action returns request details including subject, status, priority, requester, and timestamps. Pagination is available for large result sets.

Input Parameters

integer
Page number for pagination (1-100). Limited to first 100 pages or 10,000 records total. For larger datasets, use cursor pagination instead.
string ("updated_at" | "created_at")
Field to sort requests by. Options are ‘updated_at’ or ‘created_at’.
integer
Number of requests per page (max 100). Note: page * per_page cannot exceed 10,000. Set to 100 for large accounts to minimize requests before client-side filtering.
integer
Number of requests per page for cursor pagination (max 100). Use this for large datasets instead of page/per_page.
string
Cursor value to retrieve the next page of results. Obtained from previous response’s ‘after_cursor’ or ‘next’ link.
string ("asc" | "desc")
Sort order direction. Options are ‘asc’ (ascending) or ‘desc’ (descending). Defaults to ‘asc’ if not specified.
string
Cursor value to retrieve the previous page of results. Obtained from previous response’s ‘before_cursor’ or ‘prev’ link.
integer
required
Numeric ID of the organization whose requests to retrieve. Must be a non-null integer; cast to int if sourced from tools that return it as a string. Do not pass null (skip the call if organization_id is null). Obtain from ZENDESK_GET_ALL_ZENDESK_ORGANIZATIONS or ZENDESK_CREATE_ZENDESK_ORGANIZATION; never derive from organization name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ORGANIZATIONS_AUTOCOMPLETESearch for Zendesk organizations using autocomplete. Use when you need to find organization suggestions based on a partial organization name for ticket creation, user assignment, or organization lookup. The name parameter is required - provide at least a few characters for meaningful autocomplete results. Returns organizations sorted by relevance.

Input Parameters

string
required
A substring of an organization name to search for. The API returns organizations whose name starts with or contains this substring. Case-insensitive matching is applied.
string
If a field_id is provided, this specifies the type of the field. For example, if the field is on a ‘zen:user’, it references a field on a user.
string
The ID of a lookup relationship field. The type of field is determined by the source parameter. Use this to filter results based on custom field values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ORGANIZATIONS_MERGESList all organization merge operations for a specific organization in Zendesk. This action retrieves the merge history showing which organizations were merged into or out of the specified organization. Use this action when you need to audit organization merge history or track the consolidation of organizations. Supports pagination to handle large result sets efficiently. This is a read-only, idempotent operation.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination. Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor. These are mutually exclusive.
integer
Number of records to return per page. Default and maximum values vary by endpoint.
integer
required
The ID of the organization for which to retrieve merge history. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ORGANIZATIONS_SHOW_MANYShow many Zendesk organizations by their IDs or external IDs. Use when you need to retrieve multiple organizations in a single API call. Accepts up to 100 organization IDs or external IDs as comma-separated lists. Only one of ids or external_ids should be provided. Returns organization objects with all standard fields including name, domain_names, tags, and organization_fields.

Input Parameters

string
A comma-separated list of organization IDs to retrieve (max 100). Either this or external_ids is required.
string
A comma-separated list of external organization IDs to retrieve (max 100). Either this or ids is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ORGANIZATIONS_TICKETS_COUNTCount organization tickets in Zendesk. Returns an approximate count of tickets for a specific organization. Use when you need to know how many tickets are associated with an organization for reporting or operational purposes.

Input Parameters

integer
required
Numeric ID of the organization whose tickets to count (e.g. 123456). Must be a non-null integer; cast to int if sourced from tools that return it as a string. Do not pass null (skip the call if organization_id is null). Obtain from ZENDESK_GET_ALL_ZENDESK_ORGANIZATIONS or ZENDESK_CREATE_ZENDESK_ORGANIZATION; never derive from organization name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ORGANIZATION_SUBSCRIPTIONShow Organization Subscription - retrieves details of a specific organization subscription by its ID. Use when you need to get information about an organization subscription, including the associated user and organization IDs, and the creation timestamp. This is a read-only operation that does not modify any data.

Input Parameters

integer
required
The ID of the organization subscription to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ORGANIZATION_SUBSCRIPTIONSList Organization Subscriptions in Zendesk. Returns organization subscriptions with pagination support (cursor and offset). Use when you need to retrieve all organization subscriptions or need to paginate through results. End users only see their own subscriptions.

Input Parameters

integer
Page number for offset pagination (1-100). Limited to first 100 pages or 10,000 records total.
integer
Number of organization subscriptions per page (max 100).
integer
Number of organization subscriptions per page for cursor pagination (max 100). Use this for large datasets.
string
Cursor value to retrieve the next page of results. Obtained from previous response’s ‘after_cursor’ or ‘next’ link.
string
Cursor value to retrieve the previous page of results. Obtained from previous response’s ‘before_cursor’ or ‘prev’ link.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ORGANIZATION_TAGSList all tags associated with a specific Zendesk organization. Use when you need to retrieve the tags assigned to a particular organization for ticket categorization, filtering, or reporting purposes.

Input Parameters

integer
required
The numeric ID of the organization whose tags to retrieve. Must be a non-null integer; cast to int if sourced from tools that return it as a string. Do not pass null (skip the call if organization_id is null). Obtain from ZENDESK_GET_ALL_ZENDESK_ORGANIZATIONS or ZENDESK_GET_ZENDESK_ORGANIZATION.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ORGANIZATION_TICKETSGet tickets for a specific Zendesk organization, potentially including tickets from multiple requesters. Supports offset pagination and sorting; the page parameter is limited to 100.

Input Parameters

integer
Page number for pagination (1-100). Limited to first 100 pages or 10,000 records total.
string ("assignee" | "created_at" | "id" | "priority" | "status" | "updated_at")
Field to sort by: ‘assignee’, ‘created_at’, ‘id’, ‘priority’, ‘status’, ‘updated_at’
integer
Number of tickets per page (max 100).
string ("asc" | "desc")
Sort order: ‘asc’ or ‘desc’
integer
required
The ID of the organization whose tickets to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ORGANIZATION_USERSList users associated with a specific Zendesk organization. Supports filtering by role, permission set, or external ID, and pagination by page number.

Input Parameters

integer
Page number for offset pagination (starts at 1). Cannot be used with cursor pagination (page[size] and page[after]/page[before]).
string ("end-user" | "agent" | "admin")
Filter results by a single role. Use ‘end-user’, ‘agent’, or ‘admin’.
string ("id" | "name" | "created_at" | "updated_at")
The field to sort users by. Defaults to natural order if not specified.
integer
Number of users to return per page.
array
Filter results by multiple roles. Provide a list of roles to include users matching any of them.
string ("asc" | "desc")
The sort order for results. Defaults to ‘asc’ if not specified.
string
Filter by external ID. Must be unique per user under the same account.
integer
Filter by custom role ID. For Enterprise plan and above. Only one role ID per request.
integer
required
The numeric ID of the organization to list users from. Must be a non-null positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ORGANIZATION_USERS_COUNTCount users in a specific Zendesk organization by ID. Returns an approximate count of users. Use when you need to know how many users belong to a particular organization for reporting or operational purposes.

Input Parameters

string
Filters the results by role. Possible values are “end-user”, “agent”, “admin”, or a custom role name.
integer
For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request.
integer
required
Numeric ID of the organization to count users for (e.g. 16). Must be a non-null integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_OWNED_APPSList apps owned by the current Zendesk account. Use when you need to retrieve information about apps installed in your Zendesk instance, such as checking installed apps, reviewing app details (version, status, author), or auditing your app inventory. This endpoint requires admin authentication.

Input Parameters

integer
Page number for pagination. Use this to retrieve subsequent pages of results when there are many owned apps.
string
Comma-separated list of sideloaded objects to exclude from the response. Use this to reduce payload size. The exclude parameter removes the specified related objects (e.g., ‘parameters,categories’) from being returned alongside the apps.
integer
Number of apps to return per page. Defaults to 25 if not specified, maximum is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_PROBLEMSList Zendesk ticket problems. Use when you need to retrieve all tickets of type ‘problem’ in your Zendesk account. The response is always ordered by updated_at by default; use sort_by and sort_order parameters to customize. Supports both offset and cursor-based pagination. Note: Problems are tickets with type=‘problem’. This endpoint specifically returns problem-type tickets which are linked to other incidents that share the same root cause.

Input Parameters

integer
Page number for offset pagination (starts at 1). Cannot be used with cursor pagination.
string ("updated_at" | "created_at" | "id")
Field to sort results by. Prefix with - for descending order. Common values: updated_at, created_at, id.
integer
Number of problems to return per page (max 100). Cannot be used with cursor pagination.
integer
Number of problems per page for cursor pagination (max 100). Use with page_after or page_before for large datasets.
string
Cursor value to retrieve the next page of results. Obtained from previous response’s next link or cursor.
string ("asc" | "desc")
Sort order: ‘asc’ for ascending or ‘desc’ for descending.
string
Cursor value to retrieve the previous page of results. Obtained from previous response’s prev link or cursor.
boolean
When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page_size, page_after, page_before).
boolean
When true, includes ‘has_more’ indicator in the cursor pagination response meta. Only valid with cursor pagination (page_size, page_after, page_before).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_PUBLIC_LOCALESList all available public locales that can be used for translations in Zendesk. Use when you need to enumerate supported languages/locales for your Zendesk account, display language options to users, or determine which locales are available for ticket or article translations. This is a read-only, idempotent operation that returns the complete list of public locales with no pagination parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_RECENT_TICKETSList recently viewed tickets in Zendesk. Returns tickets sorted by the time they were last viewed, most recent first. Useful for agents to quickly access tickets they’ve been working on. The endpoint returns tickets visible to the agent based on their permission restrictions. Pagination is limited to 10,000 records (100 pages * 100 per page). Use this action to retrieve the tickets an agent has recently accessed in the Zendesk interface.

Input Parameters

integer
Page number for offset pagination (1-100). Limited to first 100 pages or 10,000 records total.
integer
Number of tickets per page (max 100). Note: page * per_page cannot exceed 10,000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_REMOTE_AUTHENTICATIONSList all remote authentication configurations in your Zendesk account. Use this action when you need to enumerate SSO configurations, check which authentication methods are enabled, or retrieve metadata about remote authentication settings for agents and end users. This is a read-only, idempotent operation that returns all configured remote authentication providers including SAML, LDAP, JWT, and OAuth configurations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_REQUEST_COMMENTSList a page of comments on a Zendesk request, with optional time and author-role filters. The response includes pagination information and may include comment content, attachments and metadata.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: traditional uses ?page=2 (integer page number); cursor uses ?page[size]=50&page[after]=cursor (deepObject with size, after, before). Mutually exclusive.
string ("agent" | "end_user")
Filter comments by the role of the author. One of ‘agent’ or ‘end_user’. If not specified, all comments are returned regardless of author role.
string
Filters comments to include only those from the given datetime and later. Format as ISO 8601 UTC timestamp (e.g., ‘2024-01-15T00:00:00Z’).
integer
Number of records to return per page. Maximum is 100 records per page for the request comments endpoint.
integer
required
The ID of the request to retrieve comments for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_REQUESTS_CCDBList CCD Requests. Use when you need to retrieve requests where the authenticated end user is listed as a CC (carbon copy) recipient. These are requests the user is watching but did not create. Supports sorting by creation or update timestamps.

Input Parameters

integer
Page number for offset pagination (1-100). Limited to first 100 pages.
string ("updated_at" | "created_at")
Field to sort requests by. Possible values are ‘updated_at’ or ‘created_at’.
integer
Number of requests per page for offset pagination (max 100).
string ("asc" | "desc")
Sort order direction. One of ‘asc’ (ascending) or ‘desc’ (descending). Defaults to ‘asc’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_REQUESTS_COMMENTGet a specific comment from a Zendesk request. Use when you need to retrieve a single comment by its ID for a given request, such as displaying a specific comment detail or checking comment metadata. This action is read-only and idempotent.

Input Parameters

integer
required
The ID of the request
integer
required
The ID of the ticket comment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_REQUESTS_SEARCHSearch for requests in Zendesk using query syntax. Use when you need to find customer requests across Zendesk using flexible search criteria such as status, priority, subject, or requester information. Returns paginated results with request details. This action is read-only and idempotent - searching for requests does not modify any data.

Input Parameters

integer
Page number for pagination (starts at 1). Increment until results array is empty to retrieve all matching requests.
string
The syntax and matching logic for the string is detailed in the Zendesk Support search reference. See Query basics in the Tickets API documentation. Examples: ‘status:open’, ‘type:request’, ‘priority:high’, ‘subject:fire’
string
Field to sort results by. Options: ‘updated_at’, ‘created_at’, ‘status’, ‘priority’. Defaults to sorting by relevance if not specified.
integer
Number of results per page (max 100).
string
Sort order direction. Options: ‘asc’ (ascending) or ‘desc’ (descending). Defaults to ‘desc’ if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_REQUESTS_SOLVEDList Zendesk requests with the ‘solved’ status. Useful for reviewing completed customer requests, generating reports on resolution times, or tracking customer satisfaction. Use this action when you need to retrieve requests that have been marked as solved.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive - use one format or the other, not both.
string ("updated_at" | "created_at")
Sort field options for listing solved requests.
integer
Number of records to return per page. Default and maximum values vary by endpoint.
string ("asc" | "desc")
Sort order options for listing solved requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ROUTING_AGENTS_INSTANCE_VALUESRetrieve routing attribute values for specified Zendesk agents using the Skill-Based Routing API, such as their skills or qualifications. Results can be requested with a page size of 1–100.

Input Parameters

array
required
A list of agent IDs whose attribute values to retrieve
integer
The number of items to return per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_SATISFACTION_RATINGSList Zendesk ticket satisfaction ratings for reviewing customer feedback and CSAT scores. Supports page-number pagination and sorting.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: ?page=2 (integer page number) - Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both.
string
Field to sort results by. Prefix with - for descending order. When used with cursor pagination, this determines the cursor ordering. Example: ?sort=name or ?sort=-created_at
integer
Number of records to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_SATISFACTION_RATINGS_COUNTCount satisfaction ratings in Zendesk. Returns an approximate count of satisfaction ratings. Use when you need to know how many satisfaction ratings exist for reporting or operational purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_SEARCH_COUNTCount the number of items matching a search query in Zendesk. Use when you need to know how many results a search would return without fetching all the actual results. This is useful for displaying result counts before executing a full search.

Input Parameters

string
required
The search query string. Supports Zendesk query syntax for filtering by type, status, priority, etc. Example: ‘type:ticket status:open priority:urgent’ or ‘assignee:me status:pending’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_SEARCH_EXPORTExport Zendesk search results in batches using cursor pagination. Use the response’s after_cursor value as page_after to fetch the next page.

Input Parameters

string
required
The search query string. Supports Zendesk query syntax for filtering by type, status, priority, etc. Example: ‘type:ticket status:open priority:urgent’ or ‘assignee:me status:pending’.
string
Comma-separated list of sideloads to include in the response. Available sideloads depend on the search result types (e.g., ‘users’, ‘organizations’).
integer
The number of results shown per page (max 100).
string
Cursor token for fetching the next page of results.
string
The object type returned by the export query. Can be ‘ticket’, ‘organization’, ‘user’, or ‘group’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_SECURITY_SETTINGSShow Security Settings for a Zendesk account. Use when you need to retrieve the security configuration of a Zendesk account, including session timeouts, password policies, two-factor authentication settings, IP restrictions, and account assumption options. This is a read-only, idempotent operation that does not modify any data. This action is useful for auditing security settings, verifying compliance requirements, or understanding the security posture of a Zendesk account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_SIDE_CONVERSATIONS_EVENTSRetrieve side conversation events for incremental export. Returns events created since the specified start_time in chronological order. Use when you need to export or sync side conversation events for backup, analytics, or integration purposes. This action supports pagination via the next_page URL which contains a next_start_time parameter — pass that timestamp as start_time for subsequent requests. Only available to Admins. Note: This is a read-only, idempotent action suitable for building event pipelines or audit trails.

Input Parameters

integer
Page number for offset pagination. Zendesk returns up to 1000 events per page for incremental exports.
integer
Number of events per page (max 1000 for incremental exports).
integer
required
A Unix timestamp for the query start time for incremental exports. Returns events created at or after this time. Use this parameter to paginate through large result sets by using the timestamp from the last event in the previous page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_SUPPORT_ADDRESSGet a support address by its unique ID. Use when you have a support_address_id and need to retrieve details including the email address, brand association, and DNS verification statuses. This is a read-only operation.

Input Parameters

integer
required
The ID of the support address to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TAGSList Zendesk tags and their usage counts to identify frequently used tags. Returns one page, with an optional page size of up to 100 and a sort field.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive - use one format or the other, not both.
string
Field to sort results by. Prefix with - for descending order. Example: ?sort=name or ?sort=-created_at
integer
Number of records to return per page (max 100). Note: Default and maximum values vary by endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TAGS_COUNTCount Tags in Zendesk. Returns an approximate count of tags. Use when you need to know how many tags exist in your Zendesk account for reporting or operational purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TARGETShow a specific target by its ID. Use when you have a target ID and need to retrieve its details including title, type, active status, and creation timestamp. This is a read-only, idempotent operation that returns a single target object. This action is irreversible for data retrieval - it only reads target information, no destructive changes occur.

Input Parameters

integer
required
The numeric ID of the target to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TARGET_FAILUREShow a target failure in Zendesk. Use when you have a target_failure_id and need to retrieve details about a failed target execution, including the HTTP status code, raw request/response data, and consecutive failure count. This is a read-only operation.

Input Parameters

integer
required
The numeric ID of the target failure to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TARGET_FAILURESList the 25 most recent target failures in Zendesk. Target failures occur when a target (webhook, callback, or external integration) fails to execute properly. Each failure record includes the request sent, response received, and status code. Use this action to monitor and troubleshoot failing integrations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TARGETSList all targets for the current Zendesk account. Use when you need to retrieve, audit, or review the targets configured in your Zendesk account. Targets are endpoints that receive data when triggers or automations fire. This is a read-only, idempotent action with no required parameters.

Input Parameters

integer
Page number for offset pagination. Zendesk returns up to 100 targets per page.
integer
Number of targets per page for offset pagination (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKET_AUDIT_BY_IDRetrieve a specific Zendesk ticket audit by ticket ID and audit ID. Returns its events and selected audit details and metadata.

Input Parameters

integer
required
The ID of the ticket
integer
required
The ID of the ticket audit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKET_COLLABORATORSList all collaborators (CC’d users) on a Zendesk ticket. Use when you need to see who is currently CC’d on a ticket, such as when coordinating with multiple stakeholders or before adding/removing collaborators. Each collaborator is a user object with basic profile information. Paginate through results using page and per_page parameters.

Input Parameters

integer
Page number for pagination (starts at 1).
integer
Number of collaborators per page (max 100).
integer
required
The numeric ID of the ticket whose collaborators to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKET_COMMENTSList comments on a Zendesk ticket, including available author, content and attachment details. Supports sort order, page size and inclusion of inline images; comment body fields may be absent.

Input Parameters

string
Accepts ‘users’. Use this parameter to list email CCs by side-loading users. Example: ?include=users. Note: If the comment source is email, a deleted user will be represented as the CC’d email address. If the comment source is anything else, a deleted user will be represented as the user name.
integer
Number of records to return per page (max 100).
integer
required
The ID of the ticket to retrieve comments for.
string ("asc" | "desc")
Sort order for comments. Defaults to ‘asc’ (oldest first). Use ‘desc’ for newest first.
boolean
When true, inline images are also listed as attachments in the response. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKET_EMAIL_C_CSList email CCs for a specified Zendesk ticket, returning available user details and pagination information.

Input Parameters

integer
required
The ID of the ticket to list email CCs for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKET_FIELD2Show a specific ticket field by its ID. Use when you need to retrieve details of a single ticket field in your Zendesk account, such as for auditing, understanding field configuration, or validating field properties. This action is read-only and idempotent.

Input Parameters

boolean
If true, displays the creator_user_id and creator_app_name properties. If the ticket field is created by an app, creator_app_name is the name of the app and creator_user_id is -1. If the ticket field is not created by an app, then creator_app_name is null
integer
required
The ID of the ticket field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKET_FIELDSList all system and custom ticket fields in Zendesk. Use when you need to retrieve field definitions for building forms, validating field values, or understanding available ticket field structure. Supports cursor-based pagination for large datasets. When creator=true is specified, includes creator_user_id and creator_app_name for each field. Locale parameter affects dynamic content variants for title_in_portal.

Input Parameters

string
Field to sort results by. Prefix with - for descending order. Example: name or -created_at.
string
Forces the title_in_portal property to return a dynamic content variant for the specified locale. Only accepts active locale IDs.
boolean
Displays the creator_user_id and creator_app_name properties. If created by an app, creator_app_name shows the app name and creator_user_id is -1.
integer
Number of records per page for cursor pagination (max 100).
string
Cursor token to fetch records after this position. Obtain from previous response’s cursor values.
string
Cursor token to fetch records before this position. Obtain from previous response’s cursor values.
boolean
When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination.
boolean
When true, includes has_more indicator in the cursor pagination response meta. Only valid with cursor pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKET_FIELDS_COUNTCount ticket fields in Zendesk. Returns an approximate count of system and custom ticket fields. Use when you need to know how many ticket fields exist for reporting or operational purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKET_FIELDS_SHOW_MANYRetrieve multiple ticket fields by their IDs or keys in a single request. Use when you have specific ticket field identifiers (numeric IDs like ‘123’ or keys like ‘priority’, ‘status’, ‘subject’) and need to fetch their complete metadata including type, title, required status, custom options, and portal visibility settings. This is a read-only, idempotent operation. Up to 100 fields can be retrieved per request. Either ids or keys parameter can be used, but not both simultaneously.

Input Parameters

string
Comma-separated list of ticket field IDs to retrieve. Up to 100 values accepted. Either ids or keys can be used, but not both.
string
Comma-separated list of ticket field keys to retrieve. Up to 100 values accepted. Use field keys like ‘priority’, ‘status’, ‘subject’ instead of numeric IDs. Either ids or keys can be used, but not both.
boolean
If true, includes creator information in the response.
boolean
If true, excludes sub-selection options from dropdown fields in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKET_FOLLOWERSList all followers on a Zendesk ticket. Use when you need to see who is following a ticket, such as when coordinating with stakeholders or managing ticket notifications. Followers receive notifications about the ticket. Each follower is a user object with basic profile information. Paginate through results using page and per_page parameters.

Input Parameters

integer
Page number for pagination (starts at 1).
integer
Number of followers per page (max 100).
integer
required
The numeric ID of the ticket whose followers to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKET_FORMSList Zendesk ticket forms and their metadata, with filters for active status, end-user visibility, form type, and brand association. Supports page and per-page pagination.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive - use one format or the other, not both.
string
Field to sort results by. Prefix with - for descending order. When used with cursor pagination, this determines the cursor ordering. Example: ?sort=name or ?sort=-created_at
boolean
true returns active ticket forms; false returns inactive ticket forms. If not present, returns both
string
Locale to use for the ticket form names. If not specified, the default locale is used.
integer
Number of records to return per page. Default and maximum values vary by endpoint.
string ("standard" | "service_catalog" | "all")
Ticket form type filter options.
boolean
true returns ticket forms where end_user_visible; false returns ticket forms that are not end-user visible. If not present, returns both
boolean
true returns the ticket forms of the brand specified by the URL’s subdomain
boolean
true returns the default ticket form when the criteria results in an empty set without active and end-user visible ticket forms
boolean
When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before])
boolean
When true, includes has_more indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before])

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKET_FORMS_SHOW_MANYShow multiple ticket forms by their IDs. Use when you need to retrieve specific ticket forms by their IDs to display form details, validate form availability, or bulk fetch form configurations. The ids parameter accepts a comma-separated list of ticket form IDs (e.g., ‘1,2,3’). Returns an empty ticket_forms array for non-existent IDs without error. Supports optional filtering by active status, end-user visibility, brand association, and default form fallback behavior.

Input Parameters

string
required
Comma-separated list of ticket form IDs to retrieve (e.g., ‘1,2,3’ or ‘1,2,3,4,5’). Maximum 100 IDs per request.
boolean
Filter by active status. True returns active ticket forms; false returns inactive ticket forms. If not specified, returns both active and inactive forms.
boolean
Filter by end-user visibility. True returns ticket forms visible to end users; false returns forms not visible to end users. If not specified, returns both.
boolean
Filter ticket forms by brand association. True returns ticket forms belonging to the brand specified in the URL subdomain.
boolean
When true, returns the default ticket form when the filter criteria results in no active, end-user-visible ticket forms.
boolean
When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page_size, page[after], page[before]).
boolean
When true, includes has_more indicator in the cursor pagination response meta. Only valid with cursor pagination (page_size, page[after], page[before]).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKET_INCIDENTSList incidents linked to a problem ticket in Zendesk. Use when you need to retrieve all incident tickets that share the same root cause as a problem ticket. Incidents are tickets of type ‘incident’ that are related to a problem ticket via the problem_id field. Supports both offset and cursor-based pagination.

Input Parameters

integer
Page number for offset pagination (starts at 1). Cannot be used with cursor pagination.
integer
Number of incidents to return per page (max 100). Cannot be used with cursor pagination.
integer
Number of incidents per page for cursor pagination (max 100). Use with page_after or page_before for large datasets.
integer
required
The ID of the problem ticket to list incidents for. Incidents are tickets of type ‘incident’ that are linked to this problem ticket.
string
Cursor value to retrieve the next page of results. Obtained from previous response’s next link or cursor.
string
Cursor value to retrieve the previous page of results. Obtained from previous response’s prev link or cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKET_METRICRetrieve a specific ticket metric from Zendesk by its ID. Use this action when you have a ticket_metric_id and need to fetch the detailed metrics for that ticket, including resolution times, wait times, reply times, and SLA breaches. This action is read-only and idempotent — fetching the same metric multiple times has no side effects.

Input Parameters

integer
required
The numeric ID of the ticket metric to retrieve. This is the metric ID associated with a ticket, found in ticket_metric responses or ticket data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKET_METRICSList Zendesk ticket metric records, including response times, resolution times, and assignment statistics, for analyzing ticket performance. Supports sorting and cursor-based page requests with a page size of up to 100.

Input Parameters

string
Field to sort results by. Prefix with ’-’ for descending order.
integer
Number of records per page for cursor pagination (max 100). Use this for large datasets.
string
Cursor token to fetch records after this position. Obtain from previous response’s ‘after_cursor’.
string
Cursor token to fetch records before this position. Obtain from previous response’s ‘before_cursor’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKETS_AUDITSList audits for a specific Zendesk ticket, including events such as comments and changes. Supports offset and cursor pagination; retrieve subsequent pages to view the audit history.

Input Parameters

integer
Pagination parameter. Supports both traditional offset and cursor-based pagination. Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive - use one format or the other, not both.
string
A comma-separated list of sideloads to include in the response (e.g., ‘users,groups’).
string
Field to sort results by. Prefix with ’-’ for descending order. When used with cursor pagination, this determines the cursor ordering.
integer
Number of audits per page for cursor pagination (max 100). Use with page[after] or page[before] for cursor-based pagination.
integer
required
The ID of the ticket to retrieve audits for.
string
Cursor value to retrieve the next page of results. Obtained from previous response’s next_page link.
string ("asc" | "desc")
Sort order for the results. Defaults to ‘asc’ if not specified.
string
Cursor value to retrieve the previous page of results. Obtained from previous response’s previous_page link.
array
Filter audit events by type. Use the format filter_events[]=Type1&filter_events[]=Type2 to include only specific event types.
boolean
When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before]).
boolean
When true, includes ‘has_more’ indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before]).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKETS_AUDITS_COUNTCount audits for a specific ticket in Zendesk. Returns an approximate count of audits associated with the specified ticket. Use when you need to know how many audit records exist for a ticket for reporting, analytics, or operational purposes.

Input Parameters

integer
required
The ID of the ticket to count audits for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKETS_COMMENTS_COUNTCount comments on a Zendesk ticket. Returns an approximate count of comments added to the specified ticket. Use when you need to know how many comments exist on a ticket without fetching the full comment list, such as for reporting or determining if pagination is needed.

Input Parameters

integer
required
The ID of the ticket to count comments for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKETS_CONVERSATION_LOGList conversation log events for a specific Zendesk ticket. Use this action when you need to retrieve the chronological history of interactions, comments, and activities on a ticket. The conversation log provides a comprehensive view of all events including comments, status changes, and other ticket activities. Supports cursor-based pagination for accessing large datasets.

Input Parameters

string
Field to sort results by. Prefix with - for descending order
integer
Number of records per page for cursor pagination (max 100)
integer
required
The ID of the ticket to retrieve conversation log for
string
Cursor token to fetch records after this position
string
Cursor token to fetch records before this position

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKETS_COUNTCount the number of tickets in Zendesk. Returns an approximate count of tickets with the timestamp of when the count was last calculated. This is a read-only, idempotent operation. Use when you need to know the total number of tickets for reporting, capacity planning, or operational purposes. Note that the count is approximate and may not reflect real-time changes. For detailed per-ticket information, use ZENDESK_LIST_ZENDESK_TICKETS instead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKET_SKIPSList ticket skips for a specific ticket from Zendesk. Use when you need to retrieve all skip records associated with a particular ticket, such as when reviewing which agents skipped working on a ticket or analyzing skip patterns. This action is read-only and idempotent. It returns a list of skip records that include the reason for skipping, who skipped it, and when.

Input Parameters

integer
required
The ID of the ticket to get skips for
string ("asc" | "desc")
Sort order for the skips list. Defaults to ‘asc’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKET_SLA_POLICY_METRICSReturn the SLA policy metric targets applied to one Zendesk ticket.

Input Parameters

string
required
ID of the Zendesk ticket, as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKETS_METRICSGet ticket metrics from Zendesk for a specific ticket. Returns performance metrics including resolution times, agent and requester wait times, reply counts, station changes, and timestamps for key events. Use when you need to analyze ticket performance, SLA compliance, or agent productivity metrics.

Input Parameters

integer
required
The ID of the ticket to get metrics for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TICKETS_SIDE_CONVERSATIONS_EVENTSList events for a specific side conversation on a Zendesk ticket, including creation, replies, and state updates. The response includes pagination links when available.

Input Parameters

integer
required
The ID of the parent ticket containing the side conversation
string
required
The ID of the side conversation to retrieve events for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TRIGGERShow a specific trigger by its ID. Use when you need to retrieve details of a single trigger in your Zendesk account, such as for auditing, modifying, or understanding what actions and conditions are configured for a particular trigger. This is useful for reviewing business rules before making changes or understanding automation behavior. This action is read-only and idempotent.

Input Parameters

integer
required
The ID of the trigger to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TRIGGER_CATEGORIESList all ticket trigger categories in your Zendesk account. Use when you need to retrieve, audit, or review the trigger category organization for your business rules and automations. Supports filtering with sort options (position, name, created_at, updated_at) and can include rule counts via the include parameter to show how many triggers are in each category.

Input Parameters

string
Pagination cursor or page number. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive - use one format or the other, not both.
string ("position" | "-position" | "name" | "-name" | "created_at" | "-created_at" | "updated_at" | "-updated_at")
Sort options for trigger categories.
string ("rule_counts")
Sideload options for trigger categories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TRIGGER_CATEGORIES2Show a specific ticket trigger category by its ID. Use when you need to retrieve details of a single trigger category, such as for auditing or understanding the organization of your ticket triggers. This action is read-only and idempotent.

Input Parameters

string
required
The ID of the ticket trigger category to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TRIGGERSList Zendesk ticket triggers, with optional active-status and category filters and sorting. The tool accepts a page value and per-page size for pagination.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive - use one format or the other, not both.
string ("alphabetical" | "created_at" | "updated_at" | "position")
Sort field for cursor-based pagination.
boolean
Filter by active triggers if true or inactive triggers if false
string
A sideload to include in the response. See Zendesk API documentation for available sideloads.
string ("alphabetical" | "created_at" | "updated_at" | "usage_1h" | "usage_24h" | "usage_7d")
Sort by field for offset pagination.
integer
Number of records to return per page. Default and maximum values vary by endpoint.
string ("asc" | "desc")
Sort order for trigger listing.
string
Filter triggers by category ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TRIGGERS_DEFINITIONSGet Ticket Trigger Action and Condition Definitions. Use when you need to discover the available actions and conditions that can be used to create or configure ticket triggers. This returns metadata about what types of automations are possible - the action definitions show what a trigger can do (e.g., set status to ‘solved’), while the condition definitions show what conditions can trigger it (e.g., when status is ‘open’). This is a read-only, idempotent operation that returns the available trigger definitions metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_TRIGGERS_SEARCHSearch for Zendesk ticket triggers by their title. Use when you need to find triggers in your Zendesk account by searching for keywords in their titles. Triggers are business rules that automatically perform actions when certain conditions are met on tickets. This action supports filtering by active status, sorting, and sideloading usage statistics. This is a read-only and idempotent action that queries existing triggers without making any changes.

Input Parameters

string ("alphabetical" | "created_at" | "updated_at" | "position")
Sort field for cursor-based pagination.
string
Query string used to find all triggers with matching title. Case-insensitive partial match on trigger titles.
boolean
Filter by active triggers if true or inactive triggers if false
string
JSON-encoded trigger attribute filters for the search. Example: {“json”:{“description”:“Close a ticket”}}
string
A sideload to include in the response. Currently supported: ‘usage_24h’ returns statistics about how many times each trigger was triggered in the last 24 hours.
string ("alphabetical" | "created_at" | "updated_at" | "usage_1h" | "usage_24h" | "usage_7d")
Sort by field for offset pagination.
string ("asc" | "desc")
Sort order for trigger listing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERTool to fetch a single Zendesk user by numeric user_id. Use when you have a user ID from ticket payloads (requester_id, submitter_id, assignee_id, author_id) and need to enrich with full user details (name, email, role, organization_id, etc.).

Input Parameters

integer
required
The numeric ID of the Zendesk user to retrieve. This is the user ID found in ticket payloads (requester_id, submitter_id, assignee_id, author_id).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USER_ENTITLEMENTS_FULLTool to retrieve full entitlements for a Zendesk user across all products (Chat, Explore, Talk, Guide). Use when you need to check which Zendesk products a user has access to and their activation status. Returns detailed entitlement information including whether each product is active and its display name.

Input Parameters

integer
required
The numeric ID of the Zendesk user whose entitlements to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USER_EVENTSRetrieve event history for a specific Zendesk user. Use when you need to track user activity such as login history, profile changes, or other interactions with the Zendesk system. Supports filtering by event source, type, and time range. This action is read-only and idempotent. Note: The ‘zendesk’ source value is protected; attempts to use it when creating events result in an error.

Input Parameters

integer
required
The numeric ID of the Zendesk user whose events to retrieve. This is the user ID found in ticket payloads (requester_id, submitter_id, assignee_id, author_id) or from the Users API.
integer
Number of events to include per page (max 100).
string
Include events of the specified type for the given event source. The filter_source parameter must be included when using this parameter.
string
Include events from the specified source application. Examples: ‘web’, ‘mobile’, ‘api’, etc. Check your Zendesk configuration for available sources.
string
Include events equal to or before the specified created_at time. Use ISO 8601 format (e.g., ‘2023-12-31T23:59:59Z’).
string
Include events equal to or later than the specified created_at time. Use ISO 8601 format (e.g., ‘2023-01-01T00:00:00Z’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USER_FIELD_BY_IDRetrieve a single Zendesk user field by its numeric ID. Use when you have a user field ID and need to fetch its full definition including title, type, description, custom options, validation patterns, and other settings. This is a read-only, idempotent operation.

Input Parameters

integer
required
The numeric ID of the user field to retrieve. This is the field’s unique numeric identifier in Zendesk, not the field key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USER_FIELD_OPTIONSList custom user field options for a given user field. Use when you need to retrieve the dropdown or tag options available for a custom user field in Zendesk. This action fetches the configurable options that can be selected for custom user fields of type dropdown, tagger, or similar multi-option field types.

Input Parameters

integer
Page number for offset pagination (starts at 1).
integer
Number of options per page (max 100).
string
required
The numeric ID of the user field to get options for (e.g., ‘26943537108124’). Unlike other user_field endpoints, this /options sub-resource does not accept the field key — passing a key returns a 400 ‘user_field_id must be an integer’ error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USER_FIELDSList custom user field definitions configured in a Zendesk account, including field types, dropdown options, and validation patterns. Results are paginated; use the pagination parameters to retrieve additional pages.

Input Parameters

integer
Number of records per page for cursor pagination (max 100). Use with page_after to get the next page of results.
string
Cursor token to fetch records after a specific position. Use the next_page URL from a previous response to get more results.
boolean
If true, resolves dynamic content placeholders in field titles and descriptions.
string
Cursor token to fetch records before a specific position. Use to go backwards in the pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USER_FIELDS_SHOW_MANYRetrieve multiple Zendesk user fields by their keys. Use when you have specific user field keys and need to fetch their definitions (title, type, description, options, etc.) in a single request instead of making individual calls. This is a read-only, idempotent operation.

Input Parameters

string
Comma-separated list of user field keys to retrieve. Each key should match an existing user field’s key in your Zendesk instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USER_PROFILES2Retrieve a single Zendesk user profile by its Sunshine profile ID. Use this action when you have a specific profile_id (obtained from profile listings or search results) and need to fetch the full profile details including attributes, identifiers, and linked user information. Note that this uses the Sunshine Profiles API with string profile IDs, not numeric user IDs from the Users API.

Input Parameters

string
required
The Sunshine profile ID of the user profile to retrieve. This is a string ID (e.g., ‘01KPP5TCJBCAP3E4BB1K1BJ1C5’), not a numeric user ID. Obtain from previous profile listing or search results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USER_PROFILES_EVENTS2Get a page of events for a Sunshine profile by its profile ID, with optional source, type, and time filters. Use it to examine profile activity or event history.

Input Parameters

string
Number of events to return per page (as string, e.g., ‘25’, ‘50’, ‘100’).
string
required
The unique Sunshine profile ID (e.g., ‘01KPP5TCJBCAP3E4BB1K1BJ1C5’). Use the profile ID obtained from profile lookup or creation. The profile must exist or the request returns 404.
string
Include events of the specified type. Requires filter_source to also be set.
string
Include events from the specified source application. Example: ‘shopify’, ‘my-app’
string
Include only events with created_at time less than or equal to this value. ISO 8601 format (e.g., ‘2024-12-31T23:59:59Z’).
string
Include only events with created_at time greater than or equal to this value. ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_ASSIGNED_TICKETSList tickets assigned to a specified Zendesk user, with sorting and offset pagination. The page parameter is limited to pages 1–100.

Input Parameters

integer
Page number for offset pagination (1-100). Limited to first 100 pages or 10,000 records total.
string ("created_at" | "id" | "priority" | "status" | "updated_at")
Field to sort by: ‘created_at’, ‘id’, ‘priority’, ‘status’, ‘updated_at’
integer
required
The numeric ID of the user whose assigned tickets to retrieve. This is the user ID found in ticket payloads (assignee_id, requester_id, submitter_id, author_id) or from user listings.
integer
Number of tickets per page (max 100).
string ("asc" | "desc")
Sort order: ‘asc’ or ‘desc’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_AUTOCOMPLETEAutocomplete users by name or phone number. Use when you need to find users based on a partial name or phone number for ticket creation or user lookup scenarios. At least one of ‘name’ or ‘phone’ must be provided.

Input Parameters

string
The name to search for the user. You must specify either ‘name’ or ‘phone’.
string
The phone number to search for the user. You must specify either ‘name’ or ‘phone’.
string ("assignable" | "requester")
Filter values for autocomplete results.
string
If a ‘field_id’ is provided, this specifies the type of the field. For example, if the field is on a ‘zen:user’, it references a field on a user.
string
Sideloads to include in the response. Accepts a comma-separated list of values. See Sideloading for available options.
string
The ID of a lookup relationship field. The type of field is determined by the ‘source’ parameter.
integer
Number of results to return (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_BRAND_AGENTSList brand agent memberships for a specific user in Zendesk. Use when you have a user ID and need to find all brands that the user is an agent for, such as auditing which brands a specific agent can access. This is a read-only, idempotent operation.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive - use one format or the other, not both.
string
Field to sort results by. Prefix with - for descending order. When used with cursor pagination, this determines the cursor ordering.
integer
required
The numeric ID of the Zendesk user. This is the user ID found in ticket payloads (requester_id, submitter_id, assignee_id, author_id).
integer
Number of records to return per page. Default and maximum values vary by endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_CCD_TICKETSList tickets where a specified Zendesk user is CC’d, with sorting and offset pagination. The page parameter is limited to pages 1–100.

Input Parameters

integer
Page number for offset pagination (1-100). Limited to first 100 pages or 10,000 records total.
string ("created_at" | "id" | "priority" | "status" | "updated_at")
Field to sort by: ‘created_at’, ‘id’, ‘priority’, ‘status’, ‘updated_at’
integer
required
The numeric ID of the user whose CC’d tickets to retrieve. This is the user ID found in ticket payloads (requester_id, submitter_id, assignee_id, author_id) or from user listings.
integer
Number of tickets per page (max 100).
string ("asc" | "desc")
Sort order: ‘asc’ or ‘desc’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_COMPLIANCE_DELETION_STATUSESTool to fetch GDPR compliance deletion statuses for a specific Zendesk user. Use when you need to check the deletion status for each compliance area (e.g., chat, talk) associated with a user account. Returns status records showing deletion requests and their current state. Use when auditing user data deletion requests, verifying GDPR compliance status, or tracking the progress of data removal across different Zendesk products.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive.
integer
required
The numeric ID of the user to retrieve compliance deletion statuses for
integer
Number of records to return per page (max 100).
string
Filter by the application or area of compliance (e.g., ‘chat’). If not provided, returns statuses for all applications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_COUNTCount users in Zendesk. Returns an approximate count of users. If the count is more than 1000, the value is an estimate and the response is refreshed every 24 hours. Use when you need to know how many users exist in the system for reporting or administrative purposes.

Input Parameters

string
Filters the results by role. Possible values are ‘end-user’, ‘agent’, ‘admin’, or a custom role name.
array
Filters the results by more than one role. Provide a list of role values.
integer
For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USER_SESSIONSList all sessions for a specific Zendesk user. Returns details about each active session including authentication time and last seen time. Use this action to monitor session activity for a specific user, investigate security events, or audit login history for account troubleshooting. Use when you need to see all active sessions for a particular user, track their login activity, or investigate potential unauthorized access.

Input Parameters

string
Field to sort results by. Prefix with - for descending order. Example: ?sort=created_at or ?sort=-created_at
integer
required
The numeric ID of the user whose sessions to retrieve
integer
Number of records to return per page (max 100).
string
Cursor token to fetch records after this position.
string
Cursor token to fetch records before this position.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_FOLLOWED_TICKETSList tickets the specified Zendesk user is following. Returns all tickets where the specified user is a follower. Use when you need to retrieve all tickets a particular user is watching or tracking, such as for notification purposes, audit trails, or understanding which tickets a user has interest in. Pagination is available for large result sets; follow next_page links until null to retrieve all followed tickets.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: traditional uses ‘?page=2’ (integer page number), cursor uses ‘?page[size]=50&page[after]=cursor’ (deepObject with size, after, before). These are mutually exclusive.
string ("id" | "subject" | "deleted_at" | "created_at" | "updated_at" | "status" | "requester" | "requester.name" | "group" | "assignee" | "assignee.name")
Field to sort by: ‘id’, ‘subject’, ‘deleted_at’, ‘created_at’, ‘updated_at’, ‘status’, ‘requester’, ‘requester.name’, ‘group’, ‘assignee’, ‘assignee.name’
integer
required
The numeric ID of the user whose followed tickets to retrieve. This is the user ID found in ticket payloads (assignee_id, requester_id, submitter_id, author_id) or from user listings.
integer
Number of tickets to return per page (max 100).
string ("asc" | "desc")
Sort order: ‘asc’ or ‘desc’. Defaults to ‘asc’
boolean
If true, excludes archived tickets from the results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_GROUP_MEMBERSHIPSList group memberships for a specific Zendesk user. Use when you need to retrieve all groups a user belongs to, audit user group assignments, or understand which support groups a specific user is a member of. This action is read-only and idempotent. Supports both offset pagination (page, per_page) and cursor pagination (page_size, page_after, page_before). Also supports sideloading users and groups via the include parameter.

Input Parameters

integer
Page number for offset pagination (starts at 1). Cannot be used with cursor pagination.
string
Field to sort results by. Prefix with - for descending order. Example: ?sort=group_id or ?sort=-created_at
string
Sideloads to include in the response. Accepts a comma-separated list of values. Valid values: users, groups.
integer
required
The numeric ID of the user to retrieve group memberships for. This is the user ID, not a membership ID.
integer
Number of records to return per page (max 100).
integer
Number of records per page for cursor pagination (max 100). Use with page_after. Cannot be used with offset pagination.
string
Cursor for fetching next page in cursor pagination. Use with page_size. Cannot be used with offset pagination.
string
Cursor for fetching previous page in cursor pagination. Use with page_size. Cannot be used with offset pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_GROUP_MEMBERSHIPS_BY_IDGet a specific group membership for a user by their IDs. Use when you have both a user ID and a group membership ID and need to retrieve details including the associated group, user, and timestamps. This action retrieves a single group membership record scoped to a specific user, unlike GetGroupMembership which retrieves by membership ID alone, and unlike ListUsersGroupMemberships which lists all memberships for a user.

Input Parameters

integer
required
The numeric ID of the user. This is the user ID, not a membership ID.
integer
required
The numeric ID of the group membership to retrieve. This is the group membership ID, not a group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_GROUPSList groups a specific Zendesk user belongs to, with page and per-page parameters, optional exclusion of deleted groups, and sorting. Use it to audit team memberships or retrieve a user’s support groups.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: traditional uses ?page=2 (integer page number); cursor uses ?page[size]=50&page[after]=cursor. These are mutually exclusive.
string
Field to sort results by. Prefix with - for descending order. Example: ?sort=name or ?sort=-created_at
integer
required
The numeric ID of the user. Returns groups that this user belongs to.
integer
Number of records to return per page. Default and maximum values vary by endpoint.
boolean
Whether to exclude deleted groups from the response.
boolean
When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before]).
boolean
When true, includes has_more indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before]).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_GROUPS_COUNTCount user groups in Zendesk. Returns an approximate count of groups that a specific user belongs to. Use when you need to know how many groups a user is assigned to for reporting, organizational management, or operational purposes. This action is read-only and idempotent.

Input Parameters

integer
required
The numeric ID of the user whose groups to count

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_IDENTITIES2Tool to show a specific user identity by user ID and identity ID. Use when you need to retrieve detailed information about a particular identity associated with a Zendesk user. This action is read-only and idempotent - it only retrieves data without modifying anything.

Input Parameters

integer
required
The numeric ID of the user
integer
required
The numeric ID of the user identity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_ME_SESSIONRetrieve sessions for the currently authenticated Zendesk user, with optional pagination. Session details can include authentication time, last seen time, and user ID.

Input Parameters

string
Pagination parameter for the underlying sessions endpoint. Supports cursor pagination: ?page[size]=50&page[after]=cursor (deepObject with size/after/before). Most callers don’t need this — current users typically have only a handful of sessions.
integer
Number of session records to return per page. Maximum is 100 records per page for the sessions endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_ME_SETTINGSGet the settings for the currently authenticated user in Zendesk. Returns user preferences including Admin Center UI settings, Lotus UI settings (onboarding, tooltips, keyboard shortcuts), and shared views order. Use this action to retrieve the current user’s personal settings and preferences.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_ORGANIZATION_MEMBERSHIPSList organization memberships for a specific Zendesk user. Returns membership details including default status, ticket viewing permission, and organization information; the response may contain a next-page URL.

Input Parameters

string ("users" | "organizations")
Sideloads to include in the response. Accepts a comma-separated list of values. Valid values: ‘users’, ‘organizations’.
integer
required
The numeric ID of the user whose organization memberships to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_ORGANIZATION_MEMBERSHIPS2Get details for a specific organization membership by user ID and membership ID. Use when you have both a user ID and an organization membership ID and need to retrieve the associated membership metadata including organization details, default status, and ticket viewing permissions. This action is read-only and idempotent - calling it multiple times with the same parameters will return the same result.

Input Parameters

integer
required
The numeric ID of the user
integer
required
The numeric ID of the organization membership to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_ORGANIZATIONSList organizations associated with a specific Zendesk user. Returns a page of organization details, including name, domain names, tags, and custom fields, with pagination options.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: traditional ‘?page=2’ or cursor ‘?page[size]=50&page[after]=cursor’. These are mutually exclusive.
string
Field to sort results by. Prefix with ’-’ for descending order. Example: ?sort=name or ?sort=-created_at
integer
required
The numeric ID of the user whose organizations to retrieve
integer
Number of records to return per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_ORGANIZATIONS_COUNTReturns an approximate count of organizations that a user belongs to. Use when you need to know how many organizations a specific user is associated with in Zendesk.

Input Parameters

integer
required
The numeric ID of the user whose organizations to count

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_ORGANIZATION_SUBSCRIPTIONSList User’s Organization Subscriptions - retrieves organization subscriptions for a specific user. Use when you need to get all organization subscriptions associated with a particular user, including the organization IDs and creation timestamps. Supports both cursor and offset pagination. End users only see their own subscriptions. This is a read-only operation that does not modify any data.

Input Parameters

integer
Page number for offset pagination (starts at 1)
integer
required
The numeric ID of the user whose organization subscriptions to list
integer
Number of organization subscriptions per page (max 100)
integer
Number of organization subscriptions per page for cursor pagination (max 100)
string
Cursor value to retrieve the next page of results
string
Cursor value to retrieve the previous page of results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_PASSWORD_REQUIREMENTSGet password requirements for a specific Zendesk user. Use when you need to retrieve the password policy rules that apply to a user’s password, such as minimum length, complexity requirements, or expiration policies. This action is read-only and idempotent.

Input Parameters

integer
required
The numeric ID of the Zendesk user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_PROFILESRetrieve profiles associated with a specific Zendesk user by user ID. Use when you need to look up user profile information using the Zendesk user ID. This action returns all profiles linked to the specified user account. This action is read-only and idempotent. Note: Access requires agent permissions in Zendesk (Support > People > Roles > People).

Input Parameters

integer
required
The numeric ID of the Zendesk user whose profiles to retrieve. This is the user ID found in ticket payloads (requester_id, submitter_id, assignee_id, author_id) or from the Users API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_REQUESTED_TICKETSList tickets requested by a specified Zendesk user, with sorting and offset pagination. The page parameter is limited to pages 1–100.

Input Parameters

integer
Page number for offset pagination (1-100). Limited to first 100 pages or 10,000 records total.
string ("created_at" | "id" | "priority" | "status" | "updated_at")
Field to sort by: ‘created_at’, ‘id’, ‘priority’, ‘status’, ‘updated_at’
integer
required
The numeric ID of the user whose requested tickets to retrieve. This is the user ID found in ticket payloads (requester_id, submitter_id, assignee_id, author_id) or from user listings.
integer
Number of tickets per page (max 100).
string ("asc" | "desc")
Sort order: ‘asc’ or ‘desc’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_REQUESTSList ticket requests for a specific Zendesk user. Use when you need to retrieve all requests associated with a particular user ID. This is useful for viewing a user’s request history or monitoring their open tickets. This action is read-only and idempotent.

Input Parameters

string ("updated_at" | "created_at")
Sort field options for listing user requests.
integer
required
The numeric ID of the user whose requests to retrieve.
string ("asc" | "desc")
Sort order options for listing user requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_SKIPSList ticket skips for a specific user from Zendesk. Use when you need to retrieve all skip records associated with a particular user, such as when analyzing which tickets a user has skipped or reviewing their skip history. This action is read-only and idempotent. Note that archived tickets are not included in the results.

Input Parameters

integer
Page number for offset pagination (starts at 1). Use with per_page to control pagination. Cannot be used with cursor pagination.
integer
required
The numeric ID of the Zendesk user. This is the user ID found in ticket payloads (requester_id, submitter_id, assignee_id, author_id).
integer
Number of skips per page for offset pagination (max 100). Cannot be used with cursor pagination.
string ("asc" | "desc")
Sort order options for listing skips.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USERS_TAGSList all tags assigned to a specific Zendesk user. Use when you need to see what tags are associated with a particular user for organizing, filtering, or categorizing user data. This action is read-only and idempotent.

Input Parameters

integer
required
The numeric ID of the user whose tags to retrieve. This is the user ID found in ticket payloads (requester_id, submitter_id, assignee_id, author_id).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_USER_TICKETS_ASSIGNED_COUNTCount tickets assigned to a specific user in Zendesk. Returns an approximate count of tickets where the user is the assignee. Use when you need to know how many tickets are currently assigned to a particular user for workload analysis, reporting, or capacity planning. Note: The count is approximate and may not reflect real-time changes. The count is refreshed periodically rather than being calculated on every request.

Input Parameters

integer
required
The numeric ID of the user whose assigned tickets to count. This is the user ID found in ticket payloads (assignee_id, requester_id, submitter_id, author_id).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_VIEW_DEFINITIONSRetrieve Zendesk view filter definitions, including condition, grouping, output, and sorting options available for constructing views.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_VIEWSList shared and personal Zendesk views available to the current user, with access, active-status, and group filters. Supports page-number pagination and sorting.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive - use one format or the other, not both.
string
The sort parameter used with cursor pagination. Defaults to ‘created_at’. Prefix with ’-’ for descending order.
string ("personal" | "shared" | "account")
Only views with given access. May be ‘personal’, ‘shared’, or ‘account’.
boolean
Only active views if true, inactive views if false.
string ("alphabetical" | "created_at" | "updated_at")
The sort_by parameter used with offset pagination. Possible values are ‘alphabetical’, ‘created_at’, or ‘updated_at’. Defaults to ‘position’.
integer
Only views belonging to given group.
integer
Number of records to return per page. Default and maximum values vary by endpoint.
string ("asc" | "desc")
The sort_order parameter used with offset pagination. One of ‘asc’ or ‘desc’. Defaults to ‘asc’ for alphabetical and position sort, ‘desc’ for all others.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_VIEWS_ACTIVEList all active shared and personal views available in Zendesk. Use when you need to retrieve, audit, or present the view configuration in your Zendesk account. Views define how tickets are filtered, grouped, and displayed to agents. Supports filtering by access type (personal, shared, account), group membership, and sorting preferences.

Input Parameters

integer
Page number for offset pagination. Zendesk returns up to 100 records per page.
string ("personal" | "shared" | "account")
Possible values for view access type.
string ("alphabetical" | "created_at" | "updated_at")
Possible values for sorting views.
integer
Only views belonging to given group
integer
Number of views per page for offset pagination (max 100).
string ("asc" | "desc")
Possible values for sort order direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_VIEWS_COMPACTRetrieves a compacted list of shared and personal views available to the current user in Zendesk. Use when you need to quickly fetch a lightweight list of views without full details. This endpoint returns essential view information suitable for dropdown menus or quick selection lists. Unlike the standard /views endpoint, this compact version provides a streamlined response with the most commonly needed fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_VIEWS_COUNTCount shared and personal views in Zendesk. Returns an approximate count of all views (both shared and personal) available in the account. Use when you need to know the total number of views configured for reporting or operational purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_VIEWS_COUNT_MANYCount tickets in multiple Zendesk views. Returns the ticket count for each view ID provided in a single API call. Use when you need to quickly get counts for multiple views at once for reporting or dashboard purposes. Note: This is a read-only, idempotent operation. Counts may be cached on the server side.

Input Parameters

string
required
Comma-separated list of view IDs to get counts for (e.g., ‘1,2,3’). Each ID must be a positive integer. Maximum number of IDs per request is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_VIEWS_EXECUTEExecute a Zendesk view to retrieve its column titles and matching ticket rows. Use when you need to run a saved view and get its results - useful for checking which tickets match a view’s conditions without manually applying filters. Supports pagination, custom sorting, and optional grouping of results. Returns the view’s execution metadata alongside the matching rows.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive - use one format or the other, not both.
string
A comma-separated list of sideloads to exclude from the response
string
A comma-separated list of sideloads to include in the response
string
The ticket field used for sorting. This will either be a title or a custom field id.
integer
required
The ID of the view to execute
string
The ticket field used for grouping. This will either be a title or a custom field id.
string
The direction the tickets are sorted. May be one of ‘asc’ or ‘desc’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_VIEWS_EXPORTRequest an export of a specified Zendesk view and return the response as a downloadable file, along with the view ID and content type.

Input Parameters

integer
required
The numeric ID of the view to export. You can find view IDs in the Zendesk admin panel under Views or by listing views via the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_VIEWS_SEARCHSearch for Zendesk views by their title. Use when you need to find views in your Zendesk account by searching for keywords in their titles. Views are saved searches that display tickets matching specific conditions. This action supports filtering by access level, active status, group, and sorting results.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: traditional uses ?page=2 (integer page number); cursor uses ?page[size]=50&page[after]=cursor (deepObject with size, after, before). Mutually exclusive.
string
required
Query string used to find all views with matching title. Case-insensitive partial match on view titles.
string
Filter views by access level. Valid values are ‘personal’, ‘shared’, or ‘account’. When not specified, returns views of all access levels.
boolean
Filter views by active status. Set to true to return only active views, or false to return only inactive views. When not specified, returns both active and inactive views.
string
Sideload related data to include in the response. See Zendesk documentation for available sideloads.
string ("alphabetical" | "created_at" | "updated_at" | "position")
Field to sort results by. Options: ‘alphabetical’ (sorts A-Z), ‘created_at’ (by creation date), ‘updated_at’ (by last modification), ‘position’ (by dashboard position). If unspecified, views are sorted by relevance to the query.
integer
Filter views by group ID. Only returns views that are assigned to the specified group.
integer
Number of records to return per page. Maximum is 100 records per page for the views search endpoint.
string ("asc" | "desc")
Sort order direction. Options: ‘asc’ (ascending) or ‘desc’ (descending). Defaults to ‘asc’ for alphabetical and position sorts, ‘desc’ for created_at and updated_at sorts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_VIEWS_SHOW_MANYGet multiple Zendesk views by their IDs. Use when you need to retrieve specific views by their IDs in a single request rather than fetching them one by one. The IDs should be provided as a comma-separated string. This action is read-only and idempotent. Returns only views that exist and for which the user has permission.

Input Parameters

string
required
List of view IDs separated by commas. Example: ‘1,2,3’
boolean
Only active views if true, inactive views if false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_VIEWS_TICKETSList tickets from a specific Zendesk view, with optional sorting and cursor pagination. This read-only action can be used to analyze tickets matching the view’s conditions; retrieve additional pages as needed.

Input Parameters

string
Sort or group the tickets by a column in the View columns table. The ‘subject’ and ‘submitter’ columns are not supported for sorting.
integer
required
The ID of the view to retrieve tickets from
integer
Number of tickets per page for cursor pagination (max 100). Use cursor-based pagination for large datasets.
string
Cursor value to retrieve the next page of results. Obtained from previous response’s ‘next_page’ URL.
string ("asc" | "desc")
Sort order direction. One of ‘asc’ or ‘desc’. Defaults to ‘asc’ for alphabetical and position sort, ‘desc’ for all others.
string
Cursor value to retrieve the previous page of results. Obtained from previous response’s ‘previous_page’ URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_VIEW_TICKET_COUNTCount tickets in a specific view in Zendesk. Returns the number of tickets matching the view’s conditions. Use when you need to know how many tickets are in a particular view for reporting, routing decisions, or workload assessment. The count may be null if the system is still loading and caching new data. This action is read-only and idempotent.

Input Parameters

integer
required
The ID of the view to count tickets for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ZENDESK_ACTIVITIESList ticket activities in the last 30 days affecting your Zendesk. Activities include actions like ticket assignments, status changes, comments, and more. This action is read-only and idempotent — use it to monitor ticket activity or build activity feeds.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive.
string
Field to sort results by. Prefix with - for descending order. Example: ?sort=name or ?sort=-created_at
string
A UTC time in ISO 8601 format to return ticket activities since said date.
string
A comma-separated list of sideloads to include. Supported values: fields_metadata.
integer
Number of records to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ZENDESK_CUSTOM_ROLESList all custom roles configured in your Zendesk account. Use when you need to discover available roles, review role configurations, or understand permission structures for your agents. Returns metadata including role names, descriptions, role types, and permission configurations. This is a read-only, idempotent operation with no required parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ZENDESK_ORGANIZATIONGet metadata for a specific Zendesk organization by ID. Response fields are available under data.organization_info. Does not return member/user lists.

Input Parameters

integer
required
Numeric ID of the organization to retrieve (e.g. 123456). Must be a non-null integer; cast to int if sourced from tools that return it as a string. Do not pass null (skip the call if ticket’s organization_id is null). Obtain from ZENDESK_GET_ALL_ZENDESK_ORGANIZATIONS or ZENDESK_CREATE_ZENDESK_ORGANIZATION; never derive from organization name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ZENDESK_ORGANIZATION_MERGERetrieve the details of a specific organization merge operation in Zendesk. This action shows the merge status and the organizations involved. Use when you need to check the status of an organization merge or view details of a past merge operation. This is a read-only, idempotent operation.

Input Parameters

string
required
The ID of the organization merge to retrieve. Must be a non-null string value. This is typically a numeric string ID obtained from a previous organization merge operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ZENDESK_ORGANIZATIONS_SUBSCRIPTIONSList organization subscriptions for a specific Zendesk organization, linking users to the organization. This read-only action returns a page of subscriptions with pagination information; page numbers are limited to 100.

Input Parameters

integer
Page number for pagination (1-100). Limited to first 100 pages or 10,000 records total.
integer
Number of subscriptions per page (max 100).
integer
required
Numeric ID of the organization to retrieve subscriptions for (e.g. 123456). Must be a non-null integer; cast to int if sourced from tools that return it as a string. Do not pass null (skip the call if organization’s organization_id is null). Obtain from ZENDESK_GET_ALL_ZENDESK_ORGANIZATIONS or ZENDESK_GET_ZENDESK_ORGANIZATION_BY_ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ZENDESK_REQUESTSList a page of Zendesk ticket requests, with sorting by creation or update time. This action is read-only and idempotent.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive - use one format or the other, not both.
string ("updated_at" | "created_at")
Sort field options for listing requests.
integer
Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.
string ("asc" | "desc")
Sort order options for listing requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ZENDESK_SESSIONSList all active sessions in your Zendesk account. If authenticated as an admin, returns all the active sessions for all users. Otherwise, returns only the sessions for the authenticated user. Use this action to monitor active user sessions, track login activity, or manage session security. Use when you need to audit active user sessions, investigate security events, or retrieve session information for user activity monitoring.

Input Parameters

object
Cursor-based pagination parameters for sessions.
string
Field to sort results by. Prefix with - for descending order. When used with cursor pagination, this determines the cursor ordering. Example: ?sort=name or ?sort=-created_at

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ZENDESK_SHARING_AGREEMENTSList all sharing agreements for your Zendesk account. Sharing agreements define connections between Zendesk accounts for sharing tickets. This action is read-only and idempotent — use it to view current sharing relationships or check agreement status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ZENDESK_SUSPENDED_TICKETSList suspended tickets in Zendesk. Suspended tickets are tickets that were automatically held for review due to spam detection, banned content, or other filtering rules. This action is read-only and idempotent — use it to review suspended tickets and determine if they should be recovered or deleted.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive — use one format or the other, not both.
string
The field to sort the suspended tickets by. One of ‘author_email’, ‘cause’, ‘created_at’, or ‘subject’.
integer
Number of records to return per page.
string ("asc" | "desc")
The order in which to sort the suspended tickets. Can be ‘asc’ or ‘desc’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ZENDESK_TICKET_BY_IDGet a Zendesk ticket’s selected details and a page of its comments, including available attachments. Comment pagination can be controlled by page and per-page parameters; comment fields and ticket properties may be null.

Input Parameters

integer
Page number for paginating through ticket comments (starts at 1). Zendesk returns up to 100 comments per page by default.
integer
Number of comments to return per page (max 100). Use with ‘page’ to control pagination of ticket comments.
integer
required
ID of the ticket to get details for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ZENDESK_TICKET_FIELDS_OPTIONSList Ticket Field Options - Returns a list of custom ticket field options for dropdown and multi-select ticket fields. Use this action to retrieve the available choices users can select when filling out a custom ticket field. This action is read-only and idempotent. Note: Only works with dropdown, tagger, and multi-select custom ticket fields; standard fields like text or date do not have options.

Input Parameters

integer
required
The ID of the ticket field to retrieve options for. This is the numeric ID of the custom ticket field, not the field name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ZENDESK_TICKET_FIELDS_OPTIONS2Show Ticket Field Option - Retrieves a specific custom ticket field option for dropdown and multi-select ticket fields. Use this action when you have a ticket_field_id and a ticket_field_option_id and need to retrieve the details of that individual option. This action is read-only and idempotent. Note: Only works with dropdown, tagger, and multi-select custom ticket fields; standard fields like text or date do not have options.

Input Parameters

integer
required
The ID of the parent ticket field that contains this option. This is the numeric ID of the custom ticket field.
integer
required
The ID of the individual ticket field option to retrieve. This is the numeric ID of a specific dropdown/multi-select choice within the ticket field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ZENDESK_TICKET_FORMGet details for a specific ticket form in Zendesk by its ID. Returns the complete ticket form object including its name, display settings, visibility conditions, associated ticket fields, and brand restrictions. Use when you need to retrieve detailed information about a particular ticket form configuration. This is a read-only, idempotent operation that does not modify any data.

Input Parameters

integer
required
The ID of the ticket form to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ZENDESK_TICKETS_SIDE_CONVERSATION_IDGet details of a specific side conversation on a Zendesk ticket, including its state, participants, and metadata. For a child-ticket side conversation, external IDs may identify the child ticket.

Input Parameters

integer
required
The ID of the ticket containing the side conversation
string
required
The unique ID of the side conversation to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_GET_ZENDESK_TICKETS_TAGSList all tags associated with a specific Zendesk ticket. Use when you need to retrieve the tags assigned to a particular ticket for categorization, filtering, or reporting purposes.

Input Parameters

integer
required
The numeric ID of the ticket whose tags to retrieve. Must be a non-null integer. Obtain from ZENDESK_LIST_ZENDESK_TICKETS, ZENDESK_GET_ZENDESK_TICKET_BY_ID, or other ticket-related actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_ACTIVE_AUTOMATIONSList a page of active Zendesk automations, including their conditions and actions when returned. Supports pagination for reviewing active ticket automation rules.

Input Parameters

integer
Page number for offset pagination. Zendesk returns up to 100 records per page.
integer
Number of automations per page for offset pagination (max 100).
integer
Records per page for cursor pagination (sent as page[size], max 100).
string
Cursor for forward cursor pagination (sent as page[after]).
string
Cursor for backward cursor pagination (sent as page[before]).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_APP_INSTALLATIONSList a page of Zendesk app installations, including whether each installation is enabled. Pagination is supported, and app details can be requested through the include parameter.

Input Parameters

integer
Page number for paginating through results (starts at 1).
string
Sideload additional related data. Pass ‘app’ to include the app object for each installation.
integer
Number of installations to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_APP_LOCATIONSList all available locations where Zendesk apps can be installed. Use when you need to discover valid placement options for installing or configuring Zendesk apps. This endpoint requires admin authentication. All returned locations are read-only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_ASSIGNABLE_GROUP_MEMBERSHIPSList assignable group memberships in Zendesk. Use when you need to retrieve the group memberships that agents can be assigned to, typically for understanding agent-group assignments or building assignment interfaces. This action is read-only and idempotent. Returns a maximum of 100 group memberships per page.

Input Parameters

integer
Page number for offset pagination (starts at 1). Cannot be used with cursor pagination.
integer
Number of group memberships to return per page (max 100).
integer
Number of records per page for cursor pagination (max 100). Use with page_after. Cannot be used with offset pagination.
string
Cursor for fetching next page in cursor pagination. Use with page_size. Cannot be used with offset pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_ASSIGNABLE_GROUP_MEMBERSHIPS_BY_GROUPList assignable group memberships for a specific group in Zendesk. Use when you need to retrieve which agents can be assigned to a particular group, typically for building assignment interfaces or auditing group membership capabilities. This action is read-only and idempotent. Returns a maximum of 100 group memberships per page. Note: This action differs from ListAssignableGroupMemberships by filtering to a specific group rather than returning all assignable memberships.

Input Parameters

integer
Page number for offset pagination (starts at 1). Cannot be used with cursor pagination.
integer
required
The ID of the group to list assignable memberships for
integer
Number of group memberships to return per page (max 100).
integer
Number of records per page for cursor pagination (max 100). Use with page_after. Cannot be used with offset pagination.
string
Cursor for fetching next page in cursor pagination. Use with page_size. Cannot be used with offset pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_BOOKMARKSList the user’s Zendesk bookmarks to find saved tickets or manage bookmarked items. Archived tickets are not included; results are paginated.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: traditional uses ?page=2 (integer page number); cursor uses ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive.
integer
Number of records to return per page. Default and maximum values are determined by the Zendesk Bookmarks API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_BRAND_AGENTSList brand agent memberships to retrieve which agents are associated with which brands in Zendesk. Use this action when you need to enumerate the brand-agent relationships in a Zendesk account, such as determining which agents can access specific brands or auditing brand access permissions. This is a read-only, idempotent operation.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive - use one format or the other, not both.
string
Field to sort results by. Prefix with - for descending order. When used with cursor pagination, this determines the cursor ordering.
integer
Number of records to return per page. Default and maximum values vary by endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_CUSTOM_OBJECT_RECORD_ATTACHMENTSList all file attachments for a specific custom object record in Zendesk. Use this action when you need to retrieve the attachments associated with a particular custom object record, for example to display files, verify uploads, or manage attachments for a record. This is a read-only operation that retrieves attachment metadata without downloading file content.

Input Parameters

string
required
The unique ID of a custom object record
string
required
The key of a custom object (e.g., ‘car’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_CUSTOM_OBJECT_RECORDSList all records for a specific custom object type in Zendesk. Use this action when you need to retrieve all instances of a custom object (e.g., all car records, all product records) with optional filtering by ID, external ID, sorting, and pagination support. This is a read-only, idempotent operation that returns records with their custom field values. Note: When using pagination (page[size], page[after], page[before]), you cannot mix page[before] and page[after] in the same request.

Input Parameters

string
Sort order for results. One of ‘id’, ‘updated_at’, ‘-id’, or ‘-updated_at’. The ’-’ prefix denotes descending order.
integer
Number of records to return per page. Maximum 100 records per page.
string
Optional comma-separated list of record IDs to filter by. If specified, only records with matching IDs are returned. The IDs must be unique and are case sensitive.
string
A pagination cursor for navigating to the next page. Use the ‘after_cursor’ value from a previous response. Cannot be used with page[before] in the same request.
string
A pagination cursor for navigating to the previous page. Use the ‘before_cursor’ value from a previous response. Cannot be used with page[after] in the same request.
string
required
The key of a custom object (e.g., ‘car’, ‘product’, ‘order’). This is a user-defined unique identifier for the custom object type.
string
Optional comma-separated list of external IDs to filter by. If specified, only records with matching external IDs are returned. The IDs must be unique and are case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_DELETED_USERSTool to list deleted users in Zendesk via the Users API. Use when you need to retrieve information about users that have been deleted from the system. This is a read-only operation.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: traditional uses ?page=2 (integer page number); cursor uses ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive.
string
Field to sort results by. Prefix with - for descending order. When used with cursor pagination, this determines the cursor ordering.
integer
Number of records to return per page. Default and maximum values vary by endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_HELP_CENTER_CONTENTList one localized level of the Zendesk Help Center hierarchy.

Input Parameters

integer
Offset page number, starting at 1.
string
required
Enabled Help Center locale, such as ‘en-us’ or ‘es-419’.
string ("position" | "created_at" | "updated_at" | "title" | "edited_at")
Field to sort by. ‘title’ and ‘edited_at’ are available only for articles.
integer
Number of records to return per page, from 1 to 100.
string ("asc" | "desc")
Sort direction.
string ("categories" | "sections" | "articles")
required
Hierarchy level to list: categories, sections, or articles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_INCREMENTAL_CUSTOM_OBJECT_RECORDSExport custom object records incrementally using cursor-based pagination. Use this action when you need to retrieve all changes to custom object records since a specific time, with support for large result sets through cursor-based pagination. The start_time parameter is required for the initial request; subsequent pages use the cursor returned in previous responses. This is a read-only, idempotent operation that returns records with their custom field values and change timestamps. The action supports filtering to exclude deleted records and configurable page sizes. Rate limited to 10 requests per minute.

Input Parameters

string
The cursor pointer for pagination. Use the after_cursor value from a previous response to fetch subsequent pages of records.
integer
Number of records to return per page. Default is 1000, maximum is 1000.
integer
The Unix timestamp (in seconds) to start the incremental export from. Must be at least one minute in the past. Required on the initial export request; not required on subsequent cursor-based pagination requests. Data isn’t available for the most recent minute.
string
required
The key identifier for the custom object type. This is a user-defined unique identifier for the custom object (e.g., ‘apartment’, ‘test_car’, ‘product’).
boolean
If true, exclude deleted records from the export. When false or not specified, deleted records will be included with field values replaced by ‘[DELETED]’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_MONITORED_TWITTER_HANDLESList monitored X (Twitter) handles configured in your Zendesk account. Results are paginated.

Input Parameters

integer
Page number for pagination.
integer
Number of records to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_OBJECT_TRIGGERSList triggers for a specific Zendesk custom object, including their conditions and actions. Results are paginated and can be filtered by active status.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: traditional uses ?page=2 (integer page number); cursor uses ?page[size]=50&page[after]=cursor (deepObject with size, after, before). Mutually exclusive.
boolean
Filter by active triggers if true or inactive triggers if false
string ("alphabetical" | "created_at" | "updated_at" | "usage_1h" | "usage_24h" | "usage_7d" | "position")
Sort options for listing object triggers.
integer
Number of records to return per page. Maximum is 100 records per page for the object-triggers endpoint.
string ("asc" | "desc")
Sort order for listing object triggers.
string
required
The key of a custom object (e.g., ‘car’, ‘order’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_OBJECT_TRIGGERS_DEFINITIONSList Object Trigger Action and Condition Definitions for a custom object in Zendesk. Use when you need to discover the available trigger actions and conditions that can be used to create or configure triggers on a custom object. This returns metadata about what types of automations are possible for the specified custom object. This is a read-only, idempotent operation that returns the available trigger definitions.

Input Parameters

string
required
The key of a custom object (e.g., ‘car’). This is a user-defined unique identifier for the custom object type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_ORGANIZATION_MEMBERSHIPSList organization memberships in Zendesk. Use when you need to retrieve all organization memberships, which link users to organizations. Supports pagination and sorting options to navigate large result sets efficiently.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination. Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor. These are mutually exclusive.
string
Field to sort results by. Prefix with - for descending order. Example: ?sort=name or ?sort=-created_at
string ("users" | "organizations")
Sideloads to include in the response. Accepts a comma-separated list of values. Valid values: users, organizations.
integer
Number of records to return per page. Default and maximum values vary by endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_ORGANIZATION_MEMBERSHIPS_BY_ORGANIZATIONList organization memberships for a specific Zendesk organization, including membership metadata such as default status and ticket viewing permissions. Supports pagination and sorting.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination. Traditional: ?page=2 (integer page number). Cursor: ?page[size]=50&page[after]=cursor. These are mutually exclusive.
string
Field to sort results by. Prefix with - for descending order. Example: ?sort=name or ?sort=-created_at
string ("users" | "organizations")
Sideloads to include in the response. Accepts a comma-separated list of values. Valid values: users, organizations.
integer
Number of records to return per page. Default and maximum values vary by endpoint.
integer
required
Numeric ID of the organization to list memberships for. Must be a non-null integer; cast to int if sourced from tools that return it as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_RESOURCE_COLLECTIONSList Resource Collections for the Zendesk account. Use when you need to retrieve, audit, or review the resource collections configured in your Zendesk account. Resource collections are groups of related resources that can be managed together. This is a read-only action that returns paginated results. Use per_page to control page size.

Input Parameters

integer
Number of records to return per page. Default and maximum values vary by endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_SKIPSLists all ticket skips in Zendesk. A skip is a ticket that was skipped during routing or assignment. Use this action to retrieve information about all tickets that have been skipped. This action is read-only and idempotent. Note that archived tickets are not included in the results.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: traditional uses ?page=2 (integer page number); cursor uses ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive.
integer
Number of records to return per page. Maximum is 100 records per page for the skips endpoint.
string ("asc" | "desc")
Sort order options for listing skips.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_SUPPORT_ADDRESSESList Zendesk support addresses, including their default status, verification status and brand associations. This read-only action accepts an offset page and per-page size, along with sorting and sideload parameters.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: traditional uses ?page=2 (integer page number), cursor uses ?page[size]=50&page[after]=cursor (deepObject with size, after, before). These are mutually exclusive - use one format or the other, not both.
string
Field to sort results by. Prefix with - for descending order. When used with cursor pagination, this determines the cursor ordering.
string
A comma-separated list of sideloads to include in the response.
integer
Number of records to return per page. Default and maximum values vary by endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_TICKET_AUDITSList all ticket audits from Zendesk. Returns a paginated list of audit records, each containing events that describe changes made to tickets. Audits capture all changes including comments, status changes, assignments, and field updates. Archived tickets are not included in the results. Use cursor pagination (page_after, page_before, page_size) to navigate through results efficiently.

Input Parameters

integer
Specifies how many records to return per page. You can specify up to 100 records per page.
string
A pagination cursor that tells the endpoint which page to start on. It should be a after_cursor value from a previous request. Note: page[before] and page[after] cannot be used together.
string
A pagination cursor that tells the endpoint which page to start on. It should be a before_cursor value from a previous request. Note: page[before] and page[after] cannot be used together.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_TICKET_CONTENT_PINSList Ticket Content Pins returns all content pins for a specified ticket. Use when you need to retrieve all pinned content items on a ticket. ticket_id is required — Zendesk has no account-wide listing mode. _tags = [“readOnlyHint”, “idempotentHint”]

Input Parameters

string
required
The id of the ticket for which to list content pins. Required — Zendesk returns a 400 if this is omitted; there is no account-wide listing mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_USER_IDENTITIESTool to list all identities for a specific Zendesk user. Use when you need to retrieve all email addresses, phone numbers, or other contact methods associated with a user. Supports filtering by identity type and cursor-based pagination.

Input Parameters

object
Cursor-based pagination parameters for the request.
string
Field to sort results by. Prefix with ’-’ for descending order. Example: ‘name’ or ‘-created_at’
integer
required
The numeric ID of the user whose identities to retrieve
array
Filter results by one or more identity types (email, phone, etc.)
boolean
When true, includes cursor values for each item in the pagination response
boolean
When true, includes ‘has_more’ indicator in the cursor pagination response meta

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_ZENDESK_ACCESS_RULESList all access rules for a Zendesk custom object. Access rules control which users and roles can perform specific operations on custom object records. Use this action when you need to audit existing permissions or understand what access controls are in place for a custom object type. This is a read-only operation.

Input Parameters

string
required
The key of a custom object to retrieve access rules for. You can find custom object keys by listing custom objects first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_ZENDESK_CUSTOM_OBJECT_FIELDSList field definitions for a Zendesk custom object. The request supports pagination and can include or exclude standard fields; each call returns the requested page.

Input Parameters

string
Pagination parameter. Supports both traditional offset and cursor-based pagination: traditional uses ?page=2 (integer page number); cursor uses ?page[size]=50&page[after]=cursor (deepObject with size, after, before). Mutually exclusive.
integer
Number of records to return per page. Maximum is 100 records per page for the custom-object-fields endpoint.
string
required
The key of a custom object (e.g., ‘car’)
boolean
Include standard fields if true. Exclude them if false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_ZENDESK_CUSTOM_OBJECTSList all custom object definitions in Zendesk. Use this action when you need to discover available custom object types, understand their structure, or retrieve metadata about custom objects for further operations. Returns metadata including keys, titles, and configuration options for each custom object.

Input Parameters

boolean
Include UI path in the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_ZENDESK_PERMISSION_POLICIESList all permission policies for a custom object in Zendesk. Use this action when you need to discover the access control configuration for a custom object, understand what roles have permissions, or retrieve permission metadata for access control management. This is a read-only, idempotent operation. This action is useful for reviewing permission policies applied to custom objects in Zendesk.

Input Parameters

string
required
The key of a custom object (e.g., ‘car’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_ZENDESK_TICKETSList Zendesk tickets with pagination and filtering. Only server-side filter available is external_id; status, priority, tags, assignee_id, and date-range filters must be applied client-side. Timestamps (created_at, updated_at) are ISO 8601 UTC. ticket.subject may be null — coerce to string before filtering. Attachments are not included; retrieve via ZENDESK_GET_ZENDESK_TICKET_BY_ID. HTTP 429 rate limit responses include Retry-After header; apply exponential backoff. Paginate by following next_page until null to avoid missing tickets.

Input Parameters

integer
Page number for offset pagination (1-100). Limited to first 100 pages or 10,000 records total. For larger datasets, use cursor pagination (page_size) instead.
string
Field to sort by: ‘assignee’, ‘assignee.name’, ‘created_at’, ‘group’, ‘id’, ‘requester’, ‘requester.name’, ‘status’, ‘subject’, ‘updated_at’ Omitting sort_by provides no guaranteed ordering; set explicitly when ticket order matters.
integer
Number of tickets per page for offset pagination (max 100). Note: page * per_page cannot exceed 10,000. Set to 100 for large accounts to minimize requests before client-side filtering.
integer
Number of tickets per page for cursor pagination (max 100). Use this for large datasets instead of page/per_page.
string
Cursor value to retrieve the next page of results. Obtained from previous response’s ‘after_cursor’ or ‘next’ link.
string ("asc" | "desc")
Sort order: ‘asc’ or ‘desc’
string
Filter tickets by external ID
string
Cursor value to retrieve the previous page of results. Obtained from previous response’s ‘before_cursor’ or ‘prev’ link.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_LIST_ZENDESK_USERSTool to list/enumerate Zendesk users via the Users API. Use when you need to export or iterate through the user directory without a specific name/email filter. Supports both cursor and offset pagination.

Input Parameters

integer
Page number for offset pagination (starts at 1). Cannot be used with cursor pagination.
string ("end-user" | "agent" | "admin")
Filter results by a single role. Use ‘end-user’, ‘agent’, or ‘admin’.
integer
Number of users per page for offset pagination (max 100). Cannot be used with cursor pagination.
integer
Number of users per page for cursor pagination (max 100). Use with page_after. Cannot be used with offset pagination.
array
Filter results by multiple roles. Provide a list of roles to include users matching any of them.
string
Cursor for fetching next page in cursor pagination. Use with page_size. Cannot be used with offset pagination.
string
Filter by external ID. Must be unique per user under the same account.
integer
Filter by custom role ID (Enterprise plan only). Only one role ID per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_MAKE_COMMENT_PRIVATEMake a public ticket comment private in Zendesk. This action changes the visibility of a comment from public to internal-only, so only agents can view it. Use this action when you need to convert a customer-facing comment to an internal note after the fact. Note: Only agents can make comments private; end users cannot use this endpoint.

Input Parameters

integer
required
ID of the ticket containing the comment to make private.
integer
required
ID of the ticket comment to make private.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_MAKE_DEFAULT_ORGANIZATION_MEMBERSHIPSet a specific organization membership as the default for a user in Zendesk. Use when you need to change which organization is the primary/default for a user. Only one organization can be the default at a time. This action is idempotent - setting the same membership as default multiple times will succeed without side effects.

Input Parameters

integer
required
The numeric ID of the Zendesk user whose organization membership you want to set as default. Obtain from ZENDESK_LIST_USERS or ZENDESK_SEARCH_USERS; do not guess or fabricate IDs.
integer
required
The numeric ID of the organization membership to set as the user’s default. Obtain from ZENDESK_GET_USERS_ORGANIZATION_MEMBERSHIPS; do not guess or fabricate IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_MAKE_END_USER_IDENTITY_PRIMARYSet a specified identity as the primary identity for an end user in Zendesk. This is a collection-level operation - after making an identity primary, you should reload the entire identities collection to get the updated state. An end user can only make an email identity primary if the email is verified. Use when a user wants to change their primary email or phone number for notifications.

Input Parameters

integer
required
The numeric ID of the end user
integer
required
The numeric ID of the user identity to make primary

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_MAKE_TICKET_COMMENT_PRIVATEChange a public comment to private on a Zendesk ticket audit. Use when you need to convert a previously public-facing comment to an internal note that is not visible to the end user. This action makes the comment private by updating the ticket audit. This is useful when information was shared publicly by mistake and needs to be restricted to agents only. Note: This action only works on existing audits and cannot be undone once the comment is made private.

Input Parameters

integer
required
The ID of the ticket containing the audit.
integer
required
The ID of the ticket audit containing the comment to make private.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_MAKE_USER_IDENTITY_PRIMARYTool to set a user identity as the primary identity for a Zendesk user. Use when you need to change which email address or identifier is the primary contact method for a user. This action may affect which email notifications the user receives.

Input Parameters

integer
required
The ID of the user who owns the identity
integer
required
The ID of the user identity to make primary

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_MARK_MANY_TICKETS_AS_SPAMMarks multiple tickets as spam in Zendesk. This action is irreversible — the tickets will be marked as spam and moved to the suspended tickets queue. The submitter will also be marked as spam and blocked from submitting further tickets. Use when cleaning up spam or unwanted tickets to protect your support queue. Returns a job_status payload for tracking the bulk operation. Note: Tickets marked as spam are moved to the suspended tickets queue and cannot be recovered through normal means.

Input Parameters

string
required
Comma-separated list of ticket IDs to mark as spam. Maximum 100 IDs allowed per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_MERGE_USERSMerges two Zendesk end users together. The user specified in the path parameter (user_id) is the primary user (target) that will be kept. The user specified in the request body (id) is the source user that will be deleted and its data transferred to the primary user. Use when you need to consolidate duplicate end-user accounts in Zendesk. This action is irreversible — the source user and all their associated data (tickets, comments, etc.) will be merged into the primary user and the source user cannot be recovered.

Input Parameters

object
required
User object containing the ID of the user to merge from. The ‘id’ field is mandatory - the source user will be deleted. The ‘name’ field is optional to rename the primary user.
integer
required
The numeric ID of the primary user (target) to merge another user into

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_MERGE_ZENDESK_TICKETSMerges multiple tickets into a target ticket in Zendesk. The source tickets are merged into the target ticket and then deleted. This is an asynchronous operation that returns a job status. Use when you need to consolidate duplicate or related tickets into a single ticket. Important: This action is irreversible - source tickets are permanently merged and deleted once the operation completes. Always verify the target_ticket_id and source_ticket_ids before executing.

Input Parameters

string
Private comment to add to the source tickets before they are merged.
string
Private comment to add to the target ticket after the merge.
integer
required
The ID of the target ticket to merge other tickets into. This ticket will be retained after the merge.
array
required
Array of ticket IDs to merge into the target ticket. These tickets will be merged and then deleted.
boolean
Whether the comment added to source tickets is public or private. Defaults to false (private).
boolean
Whether the comment added to the target ticket is public or private. Defaults to false (private).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_OPEN_USERS_PROFILE_IN_AGENT_BROWSEROpen a Zendesk user’s profile in a specified agent’s browser. Use when an agent needs to view a specific user’s profile during an active call or session. This action triggers the Zendesk Talk dashboard to display the user’s information in the agent’s interface.

Input Parameters

integer
required
The numeric ID of the Zendesk user whose profile should be displayed in the agent’s browser. You can find this in the user’s profile URL or from user search results.
integer
required
The numeric ID of the Zendesk agent whose browser should display the user profile. You can find this in the agent’s profile URL or from agent listings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_RECOVER_MANY_SUSPENDED_TICKETSRecover multiple suspended tickets in Zendesk. Use when you need to restore tickets that have been suspended (e.g., auto-replied emails, bounced messages). Takes up to 100 ticket IDs as input and restores them to normal ticket status. This action is irreversible — recovered tickets return to normal processing.

Input Parameters

string
required
Comma-separated list of suspended ticket IDs to recover (max 100). Use the auto-generated numeric IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_RENEW_SESSIONRenew the current Zendesk session and obtain a new authenticity token. Use when the current session token is expiring or needs to be refreshed to maintain an active authenticated connection. This action extends the session lifetime without requiring full re-authentication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_REORDER_CUSTOM_OBJECT_FIELDSReorder Custom Fields of an Object. Updates the display order of custom object fields based on the provided field IDs. Use when you need to change the order of fields displayed in a custom object’s record layout. This action is idempotent — re-running with the same field IDs in the same order will produce the same result.

Input Parameters

string
required
The key of a custom object. This is a user-defined unique identifier for the custom object type.
array
required
An array of custom object field IDs specifying the new order. The order of IDs in the array determines the display order of the fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_REORDER_LOCATION_INSTALLATIONSReorder App Installations For Location. Creates or updates the relevant location installation with a specified installation order. This action requires admin-level access. Use when you need to change the display order of apps in a specific Zendesk location (e.g., nav bar, ticket sidebar).

Input Parameters

array
required
An array of app installation IDs in the desired order. The order of IDs determines the display order in that location.
string
required
The location name where the installations are located. Common values: ‘nav_bar’, ‘ticket_sidebar’, ‘user_sidebar’, ‘organization_sidebar’, ‘new_ticket_sidebar’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_REORDER_ORGANIZATION_FIELDSReorder Organization Fields. Updates the display order of organization fields based on the provided field IDs. Use when you need to change the order of organization fields displayed in Zendesk. This action is idempotent — re-running with the same field IDs in the same order will produce the same result.

Input Parameters

array
required
An array of organization field IDs specifying the new order. The order of IDs in the array determines the display order of the fields in the organization field list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_REORDER_TICKET_FIELDSReorder Ticket Fields. Updates the display order of ticket fields based on the provided field IDs. Use when you need to change the order of standard ticket fields displayed in the ticket form. This action is idempotent — re-running with the same field IDs in the same order will produce the same result. This action requires admin permissions.

Input Parameters

array
required
An array of ticket field IDs specifying the new display order. The order of IDs in the array determines the order of the fields. Only those provided are assigned to first positions; missing IDs get incremental positions automatically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_REORDER_TRIGGERSReorder Ticket Triggers. Updates the firing order of ticket triggers based on the provided trigger IDs. Use when you need to change the priority or execution order of ticket triggers in your Zendesk account. Important constraints: You must include EVERY ticket trigger ID in your account. Omitting any trigger ID returns 404 Forbidden. Additionally, reordering is not permitted if you have more than one ticket trigger category (returns LimitOneCategory error). This action is idempotent - re-running with the same trigger IDs in the same order will produce the same result.

Input Parameters

array
required
An array of ticket trigger IDs in the desired firing order. The order of IDs in the array determines the execution order. You must include every ticket trigger ID in your account - omitting any trigger ID returns 404 Forbidden.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_REORDER_USER_FIELDSReorder User Fields. Updates the display order of custom user fields based on the provided field IDs. Use when you need to change the order of user fields displayed in user profiles or forms. This action requires admin-level access. This action is idempotent — re-running with the same field IDs in the same order will produce the same result.

Input Parameters

array
required
An array of user field IDs specifying the new display order. The order of IDs in the array determines the position of each field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_REPLY_ZENDESK_TICKETAdd a public or private comment to a Zendesk ticket, optionally changing its assignee. Comments are public by default.

Input Parameters

string
Comment content Must contain only the final reply text — do not include draft reasoning or mixed content.
boolean
Whether the comment is public or internal Public comments are customer-facing and trigger email notifications to the requester; set to false for internal agent notes to prevent unintended customer visibility.
integer
required
ID of the ticket to reply to. Note: Closed tickets cannot be updated.
integer
The ID of the agent to assign the ticket to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_REQUEST_END_USER_VERIFICATIONSend a verification email to an end user to verify ownership of their email address identity. The end user receives an email with a link to confirm their identity. Use when you need to verify an end user’s email address identity in Zendesk, such as when creating new end users or resolving identity verification issues. Note: This action can only be performed by verified end users.

Input Parameters

integer
required
The numeric ID of the end user
integer
required
The numeric ID of the user identity to verify

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_REQUEST_USER_CREATESend a request to create a user in Zendesk. This sends the owner a reminder email to update their user profile information. Use when you want to prompt a user to complete their profile through the request flow rather than creating directly. This action is useful for onboarding flows where you want to collect user information through an email-based request rather than creating the user directly.

Input Parameters

object
required
User object containing attributes for the user request. The name field is mandatory. This action sends the owner a reminder email to complete their user profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_REQUEST_USER_VERIFICATIONSend a verification email to a user to verify ownership of their email address identity. The user receives an email with a link to confirm their identity. Use when you need to verify a user’s email address identity in Zendesk, such as when creating new users or resolving identity verification issues. Note: This action sends a verification email to the user’s identity address.

Input Parameters

integer
required
The numeric ID of the user
integer
required
The numeric ID of the user identity to verify

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_RESTORE_MANY_TICKETSRestore multiple deleted Zendesk tickets by ID. The returned counts and results reflect only results present in the immediate response; a job response without results yields empty counts and results.

Input Parameters

string
required
Comma-separated list of Zendesk ticket IDs to restore. Example: ‘1,2,3’ to restore tickets with IDs 1, 2, and 3. Maximum 100 tickets per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_RESTORE_ZENDESK_TICKETRestores a previously deleted ticket in Zendesk. Use when a ticket was accidentally deleted and needs to be recovered. The restored ticket will return to its previous state with all associated data intact. This action is reversible — tickets can be deleted again after restoration if needed.

Input Parameters

integer
required
ID of the deleted ticket to restore.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_SEARCH_CUSTOM_OBJECT_RECORDSSearch and filter custom object records in Zendesk using text queries and field filters. Returns paginated results with cursor-based navigation. Use when you need to find specific records within a custom object type, apply text searches or structured filters, and navigate through large result sets. This is a read-only operation. This action is useful for discovering records, running filtered queries on custom objects, and implementing paginated browsing through custom object data.

Input Parameters

string ("name" | "created_at" | "updated_at" | "-name" | "-created_at" | "-updated_at")
Sorting order for custom object records search.
string
Search text-based fields for records matching specific terms. Supports fuzzy search on Text, Multi Line Text, and RegExp fields. Multiple words or numbers can be searched (e.g., ‘Tesla Honda 2020’ matches records containing any of these terms).
object
Filter object to narrow down search results based on specific field conditions. Structure depends on the custom object’s field definitions.
integer
Number of records to return per page (max 100).
string
Pagination cursor for fetching records after a given point. Use ‘meta.after_cursor’ from a previous response. Cannot be used with page[before].
string
Pagination cursor for fetching records before a given point. Use ‘meta.before_cursor’ from a previous response. Cannot be used with page[after].
string
required
The key of a custom object (e.g., ‘car’, ‘test_car’). Use ZENDESK_LIST_ZENDESK_CUSTOM_OBJECTS to discover available custom object keys.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_SEARCH_HELP_CENTER_ARTICLESSearch localized Zendesk Help Center articles by text and filters.

Input Parameters

integer
Offset page number, starting at 1.
string
required
Text to match in Help Center articles.
string
Enabled locale to search, such as ‘en-us’, or ’*’ for every locale.
string
One or more comma-separated section IDs.
string ("created_at" | "updated_at")
Sort by creation or update time. Omit to sort by relevance.
string
Brand ID to search, as a string.
string
One or more comma-separated category IDs.
integer
Number of results to return per page, from 1 to 100.
boolean
Search all brands when true and brand_id is omitted.
string ("asc" | "desc")
Sort direction. Zendesk defaults to descending when a sort field is used.
string
Comma-separated article labels. An article matching any label is returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_SEARCH_OBJECT_TRIGGERSSearch triggers for a specific Zendesk custom object by title, description, or active status, with sorting options.

Input Parameters

string
Cursor-based pagination only. Possible values are ‘alphabetical’, ‘created_at’, ‘updated_at’, or ‘position’.
string
Query string used to find all triggers with matching title
boolean
Filter by active triggers if true or inactive triggers if false
string
JSON-encoded trigger attribute filters for the search. Example: {“json”:{“description”:“Close a ticket”}}
string
A sideload to include in the response
string
Offset pagination only. Possible values are ‘alphabetical’, ‘created_at’, ‘updated_at’, ‘usage_1h’, ‘usage_24h’, or ‘usage_7d’. Defaults to ‘position’
string
One of ‘asc’ or ‘desc’. Defaults to ‘asc’ for alphabetical and position sort, ‘desc’ for all others
string
required
The key of a custom object to search triggers for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_SEARCH_ZENDESKTool to search for tickets, users, organizations, and groups in Zendesk using query syntax. Use when you need to find resources across Zendesk using flexible search criteria.

Input Parameters

integer
Page number for offset pagination.
string
required
The search query string. Supports Zendesk query syntax for filtering by type, status, priority, etc. Example: ‘type:ticket status:open priority:urgent’ or ‘assignee:me status:pending’.
string
Sideloads to include in the response, returned as top-level arrays alongside results. Zendesk’s search endpoint requires nested syntax: <result_type>(<resource1>,<resource2>). Combine multiple result types with commas. Common sideloads: users, groups, organizations. A flat comma list (e.g. ‘users,groups’) is silently ignored by Zendesk.
string
Field to sort results by. Options: ‘updated_at’, ‘created_at’, ‘priority’, ‘status’, ‘ticket_type’. Defaults to sorting by relevance if not specified.
integer
Number of results per page. Default: 10, max: 100.
string
Sort order direction. Options: ‘asc’ (ascending) or ‘desc’ (descending). Defaults to ‘desc’ if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_SEARCH_ZENDESK_ORGANIZATIONSSearch organizations in Zendesk by external ID or name. Returns an array of organizations matching the provided criteria. Use when you need to find specific organizations by their identifier or name. An empty organizations array with count=0 means no matches found. Multiple organizations may share similar names — verify the correct organization via external_id or domain_names before proceeding with operations.

Input Parameters

string
The name of an organization to search for. Supports exact and partial matching.
integer
The external id of an organization to search for. Case-insensitive external identifier for linking to external records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_SEARCH_ZENDESK_USERSSearch for Zendesk users by query or external ID. Supports flexible user search criteria using Zendesk search syntax, including names, email, notes, and phone numbers.

Input Parameters

integer
Page number for offset-based pagination (non-negative integer).
string
The query parameter supports the Zendesk search syntax for more advanced user searches. It can specify a partial or full value of any user property, including name, email address, notes, or phone. Example: query='jdoe'. See the Search API.
string
A comma-separated list of sideloads to include in the response.
integer
Number of records to return per page. Default and maximum values vary by endpoint.
string
The external_id parameter does not support the search syntax. It only accepts exact ID values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_SET_DEFAULT_CUSTOM_STATUSSets one or more custom ticket statuses as the default for their respective categories. Use this action when you need to specify which custom status should be the default (fallback) status for a given category (open, pending, solved, etc.). This operation is idempotent — running it multiple times with the same IDs will produce the same result. Allowed for: Admins only. Note: The IDs should be valid custom ticket status IDs that exist in your Zendesk account.

Input Parameters

string
required
Comma-separated list of custom status IDs to set as default for their respective categories. Each custom status will become the default for its status category (e.g., open, pending, solved).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_SET_GROUP_MEMBERSHIP_AS_DEFAULTSet a group membership as the default for a specific user in Zendesk. Use when you need to mark a user’s group membership as the default, meaning tickets assigned directly to the agent will assume this membership’s group. Requires both the user ID and the group membership ID. This action is useful for managing default routing preferences for agents in your Zendesk instance. Note that only one group membership can be the default at a time - setting a new default will automatically unset the previous default.

Input Parameters

integer
required
The numeric ID of the user. This is the user ID, not a membership ID.
integer
required
The numeric ID of the group membership to set as default. This is the group membership ID, not a group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_SET_USERS_ORGANIZATION_AS_DEFAULTSet an organization as the default for a user in Zendesk. Use when you need to change which organization is the primary/default for a user by specifying the organization ID directly. Only one organization can be the default at a time. This action is idempotent - setting the same organization as default multiple times will succeed without side effects.

Input Parameters

integer
required
The numeric ID of the Zendesk user whose default organization to set. Obtain from ZENDESK_LIST_USERS or ZENDESK_SEARCH_USERS; do not guess or fabricate IDs.
integer
required
The numeric ID of the organization to set as the user’s default. Obtain from ZENDESK_GET_ALL_ORGANISATIONS or ZENDESK_GET_ZENDESK_ORGANIZATION; do not guess or fabricate IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_SHOW_ACCESS_RULEShow a custom object access rule by its ID. Use when you have a custom_object_key and access_rule_id and need to retrieve the access rule’s details including its conditions, title, description, and timestamps. This is a read-only operation that does not modify any data. This action is useful for reviewing access control rules applied to custom objects in Zendesk.

Input Parameters

string
required
The access rule ID
string
required
The key of a custom object

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_SHOW_CUSTOM_OBJECTGet details of a specific Zendesk custom object by its key. Use when you have a custom object key and need to retrieve its metadata including name, description, attachment settings, visibility settings, and creation/update timestamps. This is a read-only, idempotent operation that returns the full custom object definition.

Input Parameters

boolean
Include UI path in the response. Set to true to retrieve the direct link to the custom object in the Zendesk UI.
string
required
The key of a custom object. This is a user-defined unique identifier for the custom object type.
boolean
Include permission metadata in the response. Set to true to retrieve additional permission information for the custom object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_SHOW_CUSTOM_OBJECT_RECORDGet details of a specific Zendesk custom object record by its key and record ID. Use when you have a custom object key and record ID and need to retrieve the record’s metadata including name, custom fields, timestamps, and photo. This is a read-only, idempotent operation that returns the full custom object record definition. Photo is only available if allows_photos is enabled on the custom object.

Input Parameters

string
required
The key of a custom object. This is a user-defined unique identifier for the custom object type.
string
required
The id of a custom object record. This is the unique identifier for a specific record within the custom object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_SHOW_MANY_JOB_STATUSESShow many job statuses by their IDs in Zendesk. Use this action when you have multiple job status IDs from bulk operations (like ticket updates, user merges, or ticket merges) and need to check their status in a single request. Each ID in the comma-separated list will return its corresponding job status object if found. Endpoint: GET /api/v2/job_statuses/show_many

Input Parameters

string
required
Comma-separated list of job status IDs to retrieve. Each id is a 32-char hex token returned by the original async job submission response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_SHOW_MANY_TICKETSShow multiple tickets by their IDs. Use when you need to retrieve specific tickets by their IDs to display ticket details, compare tickets, or bulk fetch ticket information. The ids parameter accepts a comma-separated list of ticket IDs (e.g., ‘35436,35437’). Returns tickets for valid IDs only; non-existent IDs result in an empty tickets array without error.

Input Parameters

string
required
Comma-separated list of ticket IDs to retrieve (e.g., ‘35436,35437’ or ‘35436,35437,35438’). Maximum 100 IDs per request.
string
A comma-separated list of sideloads to include. Available sideloads depend on the endpoint (e.g., ‘users,groups,organizations’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_SHOW_MANY_USERSRetrieve multiple Zendesk users by their numeric IDs or external IDs. Use when you have a list of user IDs (from ticket payloads, search results, etc.) and need to fetch full user details for multiple users at once. Accepts up to 100 IDs per request. Provide either ids or external_ids, not both.

Input Parameters

string
Comma-separated list of up to 100 user IDs to retrieve (e.g., ‘1,2,3’). Provide either ids or external_ids, not both.
string
A comma-separated list of sideloads to include. Available sideloads: ‘roles’, ‘organizations’, ‘fields’, ‘photo’. See Zendesk docs for sideloading details.
string
Comma-separated list of up to 100 external IDs to retrieve users by. Provide either ids or external_ids, not both.
boolean
If true, returns inactive or deleted users in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_SHOW_PERMISSION_POLICYGet details of a specific permission policy for a Zendesk custom object by its ID. Use when you have a custom_object_key and permission policy ID and need to retrieve the policy’s details including the role name and record operation permissions (create, read, update, delete). This is a read-only, idempotent operation that does not modify any data. This action is useful for reviewing permission policies that control access to custom object records in Zendesk.

Input Parameters

string
required
The permission policy ID. Use format ‘custom-role-{custom_role_id}’ for custom roles (e.g., ‘custom-role-6678128886399’) or ‘end-user’ for the end user system role.
string
required
The key of a custom object. This is a user-defined unique identifier for the custom object type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_SHOW_REQUESTShow a single request in Zendesk. Use when you need to retrieve details of a specific request by its ID, including subject, description, status, priority, requester information, and other metadata. This action is read-only and idempotent.

Input Parameters

integer
required
The ID of the request to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UNASSIGN_USER_ORGANIZATIONImmediately removes a user from an organization in Zendesk. Use when you need to unassign a user from an organization membership. This action is irreversible - the user will no longer be associated with the organization.

Input Parameters

integer
required
The ID of the user
integer
required
The ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_ACCESS_RULEUpdate an existing access rule for a custom object in Zendesk. Access rules control which records of a custom object users can access based on conditions. Use this action when you need to: - Change an access rule’s title or description - Modify the conditions that determine when the rule applies - Update access permissions for custom object records This action is idempotent — re-running with the same parameters will produce the same result.

Input Parameters

string
required
The access rule ID
string
The title of the access rule
object
Conditions object for access rules - defines when the rule applies.
string
A description of what this access rule does
string
required
The key of the custom object

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_APPS_INSTALLATIONUpdate an app installation in Zendesk. Use when you need to modify app installation settings such as enabling/disabling the app, restricting access by groups or roles, or updating app-specific settings.

Input Parameters

boolean
If true, the app installation is enabled. Set to false to disable the app for all users.
object
Installation settings for the app, formatted as a flat key-value object. These are app-specific configuration values.
array
Installation settings for the app, formatted as an array of objects. Each object should have a ‘key’ and ‘value’ field.
array
List of role names (as strings) that are allowed to use the app. If empty or null, all roles can use the app.
array
List of group IDs (as strings) that are allowed to use the app. If empty or null, all groups can use the app.
integer
required
The ID of the app installation to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_AUTOMATIONUpdate an existing automation in Zendesk. Automations are business rules that automatically perform actions on tickets when certain conditions are met. Use this action when you need to: - Change an automation’s title, active status, or position - Modify the conditions that trigger the automation - Update the actions the automation performs - Deactivate an automation without deleting it This action is idempotent — re-running with the same parameters will produce the same result.

Input Parameters

string
The new title/name of the automation. Must be unique among all automations.
boolean
Whether the automation is active and will execute. Set to false to deactivate the automation.
array
List of actions the automation will perform when triggered. Each action specifies a field to modify and the value to set.
integer
The position of the automation which specifies the order it will be executed. Lower numbers execute first.
object
Conditions object for automation - defines when the automation should execute.
integer
required
The ID of the automation to update. You can find automation IDs from the List Automations action or from the automation URL in Zendesk admin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_CUSTOM_OBJECTUpdate an existing custom object in Zendesk. Custom objects are user-defined data structures that allow you to store and manage custom data types. Use this action when you need to: - Change a custom object’s title, description, or pluralized title - Update visibility settings (include_in_list_view) - Enable or disable attachments and photos for the custom object This action is idempotent — re-running with the same parameters will produce the same result.

Input Parameters

string
User-defined display name for the object.
string
User-defined description of the object.
boolean
If true, photos can be uploaded to the records of the object. If false, new photos cannot be uploaded but existing photos can still be viewed and removed.
string
User-defined pluralized version of the object’s title.
string
required
The unique key identifier of the custom object. This is a path parameter that identifies which custom object to update.
boolean
If true, file attachments can be added to the object’s records. If false, new attachments can’t be added to the object’s records, but existing attachments on records can still be viewed and downloaded.
boolean
A flag setting the visibility of the object in the agent’s list view. If true, all agents and admins have viewing access to the object in the Custom objects record page in the Agent Workspace. If false, only admins have viewing access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_CUSTOM_OBJECT_RECORDUpdate an existing record for a custom object in Zendesk. Use when you need to modify an existing custom object record. This action updates fields on a custom object record. You can update the name, external_id, and custom_object_fields as needed.

Input Parameters

string
User-defined display name for the object. If autonumbering is selected for the custom object’s name field, the name isn’t allowed because it’s automatically generated. If uniqueness is enabled, the name must be unique.
string
An id you can use to link custom object records to external data. Set to null to remove.
string
required
The key of a custom object (e.g., ‘car’)
object
A dictionary of custom field key-value pairs. The available fields are defined in the custom object’s field definitions. Keys must match field keys from the custom object definition.
string
required
The ID of the custom object record to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_CUSTOM_STATUSUpdate an existing custom ticket status in Zendesk. Custom ticket statuses allow you to define additional statuses beyond the standard statuses (new, open, pending, solved, closed) for your ticket workflow. Use this action when you need to: - Change the labels shown to agents or end users for a custom status - Update the descriptions explaining when to use the status - Activate or deactivate a custom status - Modify how a custom status appears in the ticket interface This action is idempotent — re-running with the same parameters will produce the same result. Requires admin permissions in Zendesk.

Input Parameters

boolean
If true, the custom status is set to active. If false, the custom status is deactivated.
string
The dynamic content placeholder or the label displayed to agents. Maximum length is 48 characters.
string
The description of when the user should select this custom ticket status. Shown to agents.
string
The dynamic content placeholder or the label displayed to end users. Maximum length is 48 characters.
integer
required
The unique ID of the custom ticket status to update. You can find custom status IDs from the List Custom Ticket Statuses action or from the custom status URL in Zendesk admin.
string
The description displayed to end users. Shown to customers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_DELETION_SCHEDULEUpdate an existing deletion schedule in Zendesk. Deletion schedules define automated rules for deleting tickets, users, attachments, or other records based on specified conditions. Use this action when you need to: - Change a deletion schedule’s title, description, or active status - Modify the conditions that determine which records are deleted - Pause or reactivate a deletion schedule This action is idempotent — re-running with the same parameters will produce the same result. Note: The ‘object’ field cannot be modified after schedule creation.

Input Parameters

string
The new title/name of the deletion schedule.
boolean
Whether the deletion schedule is active. Set to false to pause the schedule.
object
Conditions object for deletion schedule - defines criteria for matching records.
string
The description of the deletion schedule.
integer
required
The unique ID of the deletion schedule to update. You can find this ID from the deletion schedule URL in Zendesk admin or from listing deletion schedules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_DYNAMIC_CONTENT_ITEMS_VARIANTUpdate a specific Zendesk dynamic content item variant by item and variant ID. Content and locale ID are required; active and default status can also be supplied.

Input Parameters

boolean
Whether the variant is active and usable
string
required
The new content for the variant
boolean
Whether the variant is the default for the item it belongs to
integer
required
An active locale ID for this variant
integer
required
The ID of the dynamic content item containing the variant to update
integer
required
The ID of the variant to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_DYNAMIC_CONTENT_ITEMS_VARIANTSSubmit a bulk update of variants for a Zendesk dynamic content item, specifying variant IDs or locale IDs and changes to content or status. The response contains a job status for tracking the operation.

Input Parameters

array
required
List of variants to update. Each variant must include either an ‘id’ or ‘locale_id’, and can optionally include ‘content’, ‘active’, and ‘default’.
integer
required
The ID of the dynamic content item whose variants you want to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_MACROUpdate an existing Zendesk macro by ID. The title and actions are required and sent on every update; description, active status, and access restrictions can also be supplied.

Input Parameters

string
required
The title of the macro.
boolean
Whether the macro should be displayed in the UI. Use false to hide the macro without deleting it.
array
required
List of actions the macro will perform. Each action specifies a field to modify and the value to set.
integer
required
The ID of the macro to update. You can find macro IDs from the List Macros action or from the macro URL in Zendesk admin.
string
The description of the macro explaining what it does.
object
Who may access the macro. Null when everyone in the account can access it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_MANY_AUTOMATIONSUpdate multiple automations in Zendesk in a single request. Use when you need to bulk update automation settings such as position, active status, or title for multiple automations at once. Note: You might be restricted from updating some default automations. If included in a bulk update, the unrestricted automations will be updated. This action is idempotent — re-running with the same parameters will produce the same result.

Input Parameters

array
required
List of automations to update. Each automation must include an ‘id’ and can optionally include ‘position’, ‘active’, and ‘title’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_MANY_MACROSUpdate multiple macros in Zendesk in a single request. Use when you need to bulk update macro settings such as position or active status for multiple macros at once. This action is idempotent — re-running with the same parameters will produce the same result.

Input Parameters

array
required
List of macros to update. Each macro must include an ‘id’ and can optionally include ‘position’ and ‘active’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_MANY_OBJECT_TRIGGERSUpdate the position or active status of multiple Zendesk custom object triggers in a single request.

Input Parameters

array
required
List of custom object triggers to update. Each trigger must include an ‘id’ and can optionally include ‘position’ and ‘active’.
string
required
The key of a custom object (e.g., ‘car’, ‘order’). This is a path parameter that identifies which custom object’s triggers to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_MANY_ORGANIZATIONSBulk update multiple Zendesk organizations in a single request. Use when you need to update organization details such as name, notes, details, domain names, or tags for multiple organizations at once. The action is queued as a background job - use the job_status URL to poll for completion. Maximum 100 organizations per request. Note: Agents without permission restrictions can only update ‘notes’ on organizations.

Input Parameters

string
Comma-separated list of organization IDs to update (max 100). Required if external_ids is not provided.
string
Comma-separated list of external organization IDs to update (max 100). Required if ids is not provided.
array
required
List of organizations to update. Each organization must include an ‘id’ and can optionally include ‘name’, ‘notes’, ‘details’, ‘external_id’, ‘domain_names’, and ‘tags’. Agents without permission restrictions can only update ‘notes’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_MANY_TICKETSUpdate multiple tickets in Zendesk in a single request. Use when you need to bulk update ticket fields such as status, priority, tags, assignee, or group for multiple tickets at once. The API accepts up to 100 ticket objects per request. Changes are processed asynchronously and return a job_status object for tracking progress.

Input Parameters

string
Comma-separated list of ticket IDs to update. Can be used as an alternative to passing ticket objects in the body. When provided, tickets matching these IDs will be updated with the values from the ticket objects.
array
required
List of ticket update objects. Each object must include an ‘id’ field and can optionally include ‘status’, ‘priority’, ‘tags’, ‘custom_status_id’, ‘assignee_id’, and ‘group_id’. Maximum 100 tickets per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_MANY_TRIGGERSUpdate multiple ticket triggers in Zendesk in a single request. Use when you need to bulk update trigger settings such as position, active status, or category for multiple triggers at once. This action allows you to update the order (position) or activate/deactivate multiple triggers efficiently. This action is idempotent — re-running with the same parameters will produce the same result.

Input Parameters

array
required
List of triggers to update. Each trigger must include an ‘id’ and can optionally include ‘active’, ‘position’, and ‘category_id’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_MANY_USERSBulk update multiple Zendesk users in a single request. Use when you need to apply the same or different updates to up to 100 users at once. Provide either a single user object to apply identical changes to all specified users, or an array of users objects for individual updates per user. The operation is asynchronous and returns a job_status that you can poll to track completion. This action is idempotent — re-running with the same parameters will apply the same updates again.

Input Parameters

string
Comma-separated list of Zendesk user IDs to update (max 100). Use this when you have the numeric user IDs. Required if external_ids is not provided.
object
Individual user fields to update for bulk operation.
array
Array of user objects to update each user individually. Use this when you need to apply different updates to different users. The number of user objects should match the number of IDs provided.
string
Comma-separated list of external user IDs to update (max 100). Use this when you have external IDs assigned to users. Required if ids is not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_MANY_VIEWSUpdate multiple views in Zendesk in a single request. Use when you need to bulk update view settings such as position, active status, or title for multiple views at once. Note: You might be restricted from updating some default views. If included in a bulk update, the unrestricted views will be updated. This action is idempotent — re-running with the same parameters will produce the same result.

Input Parameters

array
required
List of views to update. Each view must include an ‘id’ and can optionally include ‘position’, ‘active’, and ‘title’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_OBJECT_TRIGGERUpdate an existing custom object trigger in Zendesk. Triggers define automated actions that execute when specific conditions are met on custom object records. Use this action when you need to: - Change a trigger’s title or description - Enable or disable a trigger - Modify the conditions that cause the trigger to fire - Update the actions the trigger performs This action is idempotent — re-running with the same parameters will produce the same result.

Input Parameters

string
The title of the trigger. Required in the trigger object for updates.
boolean
Whether the trigger is active. Active triggers will execute when their conditions are met.
array
An array of actions the trigger performs when its conditions are met. Each action defines what happens when the trigger fires.
object
An object that describes the circumstances under which the trigger performs its actions. Contains ‘all’ and/or ‘any’ arrays of condition objects with ‘field’, ‘operator’, and ‘value’.
integer
required
The unique identifier of the trigger to update. This is a path parameter.
string
A description of what the trigger does.
string
required
The unique key identifier of the custom object that owns the trigger. This is a path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_ORGANIZATION_FIELDUpdate a custom organization field in Zendesk. Use when you need to modify an existing organization field’s properties such as title, type, description, options, or other settings. All existing custom_field_options must be included on update — omitted options will be deleted. Returns the updated organization field object.

Input Parameters

string
required
A unique key that identifies this custom field. Must consist of only letters, numbers, and underscores. Cannot be only numbers.
string
Optional tag for checkbox type fields
string ("checkbox" | "date" | "decimal" | "dropdown" | "integer" | "lookup" | "multiselect" | "regexp" | "text" | "textarea")
required
The custom field type. Must be one of: checkbox, date, decimal, dropdown, integer, lookup, multiselect, regexp, text, or textarea
string
required
The title of the custom field
boolean
If true, this field is available for use. If false, the field is hidden from users.
integer
Ordering of the field relative to other fields. Lower values appear first.
string
User-defined description of the field’s purpose
object
Filter definition for autocomplete in lookup fields.
array
Required for dropdown or multiselect types. For updates: all existing options must be included (omitted options will be deleted). Pass null id for new options, include id for existing options.
integer
required
The ID of the organization field to update
string
Regular expression pattern for validating regexp type fields
string ("zen:user" | "zen:organization" | "zen:ticket")
Object type referenced for lookup fields. Can be zen:user, zen:organization, zen:ticket, or zen:custom_object:{key}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_ORGANIZATIONS_TAGSAdd organization tags in Zendesk. Use when you need to tag an organization for categorization, filtering, or automation purposes. Tags are appended to the organization’s existing tags. This action is idempotent — adding the same tag multiple times will not create duplicates in the organization’s tag list.

Input Parameters

array
required
An array of tag names to add to the organization. Tags will be appended to the existing tags list.
integer
required
The ID of the organization to add tags to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_PERMISSION_POLICYUpdate a Zendesk custom object’s permission policy, including record access and exceptions. When any record operation is supplied, the request includes all four operations; omitted operations or omitted allowed settings are sent as allowed, with a null rule ID unless specified.

Input Parameters

string
required
The permission policy ID. Use ‘custom-role-{custom_role_id}’ for custom roles or ‘end-user’ for the end user system role.
object
Permission settings for different record operations.
string
required
The key of the custom object

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_RESOURCE_COLLECTIONUpdate an existing resource collection in Zendesk. Resource collections are groups of related resources (like triggers, automations, or ticket fields) that can be managed together. Use this action when you need to: - Rename a resource collection - Modify the resources included in a collection - Update the configuration of an existing collection This action is idempotent - re-running with the same parameters will produce the same result.

Input Parameters

string
The new name for the resource collection. Must be unique among all resource collections.
array
List of resources to include in the collection. Each resource object should include ‘type’ (e.g., ‘triggers’, ‘ticket_fields’) and ‘resource_id’ or ‘identifier’.
integer
required
The ID of the resource collection to update. This is a required path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_SIDE_CONVERSATIONUpdate a side conversation on a ticket in Zendesk. Use this action to modify the state (open/closed) or subject of an existing side conversation attached to a ticket. Use when you need to: - Close a side conversation that has been resolved - Reopen a closed side conversation - Update the subject line of a side conversation This action is idempotent — re-running with the same parameters will produce the same result.

Input Parameters

string
The new state of the side conversation. Allowed values: ‘open’ or ‘closed’.
string
The updated subject of the side conversation.
integer
required
The ticket identifier. Must be a valid ticket ID that exists in your Zendesk account.
string
required
The side conversation identifier (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_SUPPORT_ADDRESSUpdate an existing support address in Zendesk. Support addresses are email addresses that receive customer inquiries and can be configured per brand. Use this action when you need to: - Change the name of a support address - Set or change the default support address for the account - Associate a support address with a different brand Note: You cannot change the email address of an existing support address.

Input Parameters

string
The new name for the support address. This is the display name used to identify the address in Zendesk.
boolean
Whether to set this address as the account’s default support address. Set to true to make it the default, false otherwise.
integer
The ID of the brand to associate with this support address. Use this to link the address to a specific brand.
integer
required
The ID of the support address to update. This is a required path parameter that identifies the specific recipient address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_TARGETUpdate an existing target in Zendesk. Targets are endpoints that receive data when triggers fire (e.g., HTTP targets, email targets, webhook targets). Use this action when you need to: - Change a target’s title - Activate or deactivate a target - Update target-specific properties This action is idempotent — re-running with the same parameters will produce the same result.

Input Parameters

object
Additional target data to update. Provide any target-specific fields to modify. This allows updating target-type-specific properties beyond title and active status.
string
The new title of the target
boolean
Whether the target is active
integer
required
The numeric ID of the target to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_TICKET_FIELDUpdate an existing ticket field in Zendesk. Ticket fields define the structure and properties of custom fields on tickets. Use this action when you need to: - Rename a ticket field or update its title - Update the description or agent-only description - Change the field’s position in the ticket form - Enable or disable a ticket field - Set visibility and editability for portal and agents - Make fields required for solving tickets or creating requests - Configure validation patterns for regexp fields - Set tags for checkbox fields This action is idempotent — re-running with the same parameters will produce the same result. Requires admin permissions.

Input Parameters

string
For checkbox fields only. A tag added to tickets when the checkbox field is selected
string
The title of the ticket field
boolean
Whether this field is available
boolean
If true, displays the creator_user_id and creator_app_name properties in the response. If the ticket field is created by an app, creator_app_name is the name of the app and creator_user_id is -1. If the ticket field is not created by an app, then creator_app_name is null.
integer
The relative position of the ticket field on a ticket. Note that for accounts with ticket forms, positions are controlled by the different forms
boolean
If true, agents must enter a value in the field to change the ticket status to solved
string
Describes the purpose of the ticket field to users
integer
For system ticket fields of type priority and status. Defaults to 0. A priority sub type of 1 removes the Low and Urgent options. A status sub type of 1 adds the On-Hold option
boolean
Whether this field is editable by agents
integer
required
The ID of the ticket field to update
string
The title of the ticket field for end users in Help Center
string
A description of the ticket field that only agents can see
boolean
Whether this field is visible to end users in Help Center
boolean
Whether this field is editable by end users in Help Center
boolean
If true, end users must enter a value in the field to create the request
boolean
If true, the field is shown to agents by default. If false, the field is hidden alongside infrequently used fields. Classic interface only
string
For regexp fields only. The validation pattern for a field value to be deemed valid

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_TICKETS_TAGSUpdate tags on a Zendesk ticket via PUT request to /api/v2/tickets/{ticket_id}/tags. Use when you need to add, replace, or manage tags on an existing ticket. This operation replaces all existing tags with the provided list.

Input Parameters

array
required
An array of tag names to set on the ticket. Using this endpoint replaces all existing tags on the ticket with the provided tags.
integer
required
The ID of the ticket to update tags for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_TICKET_TRIGGERUpdate an existing ticket trigger in Zendesk. Triggers are business rules that automatically perform actions on tickets when certain conditions are met. Use this action when you need to: - Change a trigger’s title, active status, position, or description - Modify the conditions that trigger the action - Update the actions the trigger performs - Reassign a trigger to a different category - Deactivate a trigger without deleting it This action is idempotent — re-running with the same parameters will produce the same result.

Input Parameters

string
The new title/name of the trigger. Must be unique among all triggers.
boolean
Whether the trigger is active and will execute.
array
List of actions the trigger will perform when triggered. Each action specifies a field to modify and the value to set.
integer
The position of the trigger which specifies the order it will be executed. Lower numbers execute first.
object
Conditions object for trigger - defines when the trigger should execute.
integer
required
The ID of the trigger to update. You can find trigger IDs from the List Triggers action or from the trigger URL in Zendesk admin.
string
The ID of the category to assign the trigger to. Categories help organize triggers in the Zendesk admin interface.
string
A description of what the trigger does.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_TRIGGER_CATEGORYUpdate an existing trigger category in Zendesk. Trigger categories are used to organize ticket triggers in the Zendesk admin interface. Use this action when you need to: - Rename a trigger category - Change the display order of a trigger category - Update both name and position of a trigger category This action is idempotent — re-running with the same parameters will produce the same result.

Input Parameters

string
The new name of the trigger category. Must be unique among all trigger categories.
integer
The new position of the trigger category which specifies the order it will be displayed. Lower numbers appear first.
string
required
The ID of the ticket trigger category to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_USERUpdate selected core fields on one Zendesk user by numeric user ID.

Input Parameters

object
required
Core user fields to update. At least one field is required.
string
required
ID of the Zendesk user to update, as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_USER_FIELDUpdate an existing user field in Zendesk. Use when you need to modify the title, description, options, or other properties of a custom user field. Supports updating text, checkbox, dropdown, multiselect, date, integer, decimal, regexp validation, and lookup types. Only administrators can update user fields.

Input Parameters

string
Tag value for checkbox fields
string
The new title (label) displayed for this custom field
boolean
If true, this field is available for use
integer
Ordering of the field relative to other user fields
string
Dynamic content placeholder for title (supports i18n placeholders)
string
New user-defined description of this field’s purpose
integer
required
The numeric ID of the user field to update. This is the field’s unique numeric identifier in Zendesk, not the field key.
string
Dynamic content placeholder for description (supports i18n placeholders)
object
Filter configuration for relationship-type user fields.
array
Updated options for dropdown or multiselect fields. Each option has a name (display) and value (internal tag).
string
Regular expression pattern for validating field values
string
Target type for ‘lookup’ fields. Options: ‘zen:user’, ‘zen:organization’, ‘zen:ticket’, ‘zen:custom_object:{key}‘

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_USER_PROFILEPartially updates a user profile in Zendesk by identifier. Use when you need to modify specific fields of an existing profile without replacing the entire profile. This action uses JSON merge patch semantics — only provided fields are updated. Use this action when you have an existing profile identifier and need to update specific profile attributes, identifiers, or the profile name. The identifier must follow the format source:type:identifier_type:identifier_value.

Input Parameters

string
Person’s name to set on the profile
string
Profile type (e.g., ‘contact’, ‘user’, ‘account’)
string
Source application/system for the profile (e.g., ‘company’). Cannot be ‘zendesk’ as it is reserved.
object
JSON schema compliant object containing profile attributes/details
string
required
Profile identifier in format source:type:identifier_type:identifier_value (e.g., company:contact:email:john@example.com). All identifiers must belong to a single user and profile.
array
List of identifiers for the profile. Each identifier must have a type and value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_USER_PROFILE_BY_IDPartially updates a user profile in Zendesk by profile ID. Use when you need to modify specific fields of an existing profile without replacing the entire profile. This action uses JSON merge patch semantics — only provided fields are updated. Use this action when you have a profile ID and need to update specific profile attributes, identifiers, name, source, or type. This is different from UpdateUserProfile which uses identifier lookup instead.

Input Parameters

string
Person’s name to set on the profile
string
Profile type (e.g., ‘contact’, ‘user’, ‘account’)
string
Source application/system for the profile (e.g., ‘company’). Cannot be ‘zendesk’ as it is reserved.
object
JSON schema compliant object containing profile attributes/details
string
required
The unique ID of the Sunshine profile to update. This is the profile ID returned when the profile was created.
array
List of identifiers for the profile. Each identifier must have a type and value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_USERS_IDENTITYUpdate the verified status of a specific Zendesk user identity by user ID and identity ID.

Input Parameters

integer
required
The numeric ID of the user who owns the identity
boolean
If true, marks the identity as verified. Deprecated - use verification_method instead for more accurate verification states.
integer
required
The numeric ID of the user identity to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_USERS_ME_SETTINGSUpdate the settings for the currently authenticated Zendesk user. Use when modifying UI preferences like keyboard shortcuts, onboarding tooltips, theme preferences, or shared views order. This action modifies the caller’s own settings only.

Input Parameters

object
required
User settings to update. Can include lotus, admin_center, and shared_views_order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_USERS_PROFILESCreate or update a profile for a specified Zendesk user, identified by user ID and a profile lookup identifier. Supply the profile’s name and identifiers, with optional custom attributes, to establish or modify the user’s profile.

Input Parameters

object
required
Profile object containing the profile data with name, identifiers, and optional attributes
string
required
The Zendesk user ID (numeric string) of the user to associate with the profile
string
required
Profile lookup identifier in format ‘source:type:identifier_type:identifier_value’ (e.g., ‘company:contact:email:user@example.com’). This identifies which profile to create or update for the specified user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_USERS_TAGSUpdate (replace) tags for a specific Zendesk user. Use when you need to assign or modify tags on a user account for organizing, filtering, or categorizing user data. This action replaces all existing tags on the user with the provided list.

Input Parameters

array
required
An array of tag strings to assign to the user. This will replace all existing tags on the user with the provided list. Tags are used to categorize and organize users.
integer
required
The numeric ID of the user whose tags to update. This is the user ID found in ticket payloads or user search results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_VIEWUpdate an existing Zendesk view’s title, description, active status, position, or default status. Views are saved ticket filters used to organize agent workflows.

Input Parameters

string
The title of the view
boolean
Whether the view is active
boolean
If true, the view is a default view
integer
required
The ID of the view to update
integer
The position of the view in the list
string
The description of the view

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_ZENDESK_ACCOUNT_SETTINGSUpdate Zendesk account-level settings including tickets, branding, localization, routing, and more. Use when you need to configure or modify account-wide settings that affect all agents and end users. Requires admin privileges to update most settings. Settings changes are persistent and affect all users.

Input Parameters

object
required
The account settings to update. Must include at least one setting category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_ZENDESK_ATTACHMENTUpdates an attachment’s malware access override setting. Use when you need to enable or restrict agent access to attachments that have been flagged for malware.

Input Parameters

integer
required
The unique ID of the attachment to update
boolean
required
If true, allows agents to access attachments with detected malware. If false, restricts access to malware-detected attachments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_ZENDESK_CUSTOM_OBJECT_FIELDUpdate an existing custom object field in Zendesk. Custom object fields define the structure and properties of data within a custom object. Use this action when you need to: - Rename a custom object field - Update the description or display properties - Change the field’s position in the UI - Enable or disable a field - Set validation patterns or make fields required This action is idempotent — re-running with the same parameters will produce the same result.

Input Parameters

string
User-defined display name for the field.
boolean
If true, the field is active and can be used. If false, the field is inactive and hidden in the UI.
integer
Position of the field in the UI. Lower values are displayed first.
boolean
If true, the field is required when creating or updating records. If false, the field is optional.
string
User-defined description of the field.
string
required
The key of a custom object (e.g., ‘car’). This is a path parameter that identifies the parent custom object.
string
A regular expression pattern used to validate the field value. Only applies to text-type fields.
string
required
The key or id of a custom object field. This can be either the human-readable key (e.g., ‘make’) or the numeric ID of the field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_ZENDESK_DYNAMIC_CONTENT_ITEMUpdate a dynamic content item in Zendesk. The only attribute that can be changed is the name. Use when you need to rename an existing dynamic content item after confirming its ID. Note: Dynamic content items are used to store multilingual content for use in triggers, automations, and macros. Updating the name affects all references to this item.

Input Parameters

string
required
The new name for the dynamic content item. The name must be unique and is used as the identifier when referencing this item in triggers, automations, or dynamic content templates.
integer
required
The unique ID of the dynamic content item to update. You can get this ID from the item’s URL or by listing dynamic content items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_ZENDESK_ORGANIZATIONUpdate an organization in Zendesk. After updating, re-fetch via ZENDESK_GET_ZENDESK_ORGANIZATION if downstream logic depends on current data.

Input Parameters

object
required
New data for the organization Must use valid Zendesk organization field names (e.g., name, notes, domain_names, external_id); invalid fields may be silently ignored. domain_names must be an array and is treated as a full replacement — always include existing domains alongside new ones to avoid removing them. Zendesk trims whitespace from name, so near-identical strings may collide on uniqueness validation.
integer
required
ID of the organization to update Verify the exact ID before updating — multiple organizations may share similar names and updates are persistent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_ZENDESK_REQUESTSUpdate a Zendesk ticket request by ID, including fields such as status, priority, assignment, tags, and custom fields, or add a comment.

Input Parameters

array
Tags to set on the request. Using this replaces all existing tags.
boolean
Whether or not the request is solved. An end user can set this if ‘can_be_solved_by_me’ is true for that user.
string ("new" | "open" | "pending" | "hold" | "solved" | "closed")
The state of the request after the update. Allowed values: ‘new’, ‘open’, ‘pending’, ‘hold’, ‘solved’, ‘closed’.
object
Comment object for adding a comment to the request.
integer
The ID of the group to assign the request to.
string ("urgent" | "high" | "normal" | "low")
The priority of the request. Allowed values: ‘urgent’, ‘high’, ‘normal’, ‘low’.
integer
required
The ID of the request to update. Find this ID from the request URL or from a list requests action.
integer
The ID of the agent to assign the request to. The agent must be a member of the group the request is assigned to.
array
Custom field values to set on the request. Each item should include ‘id’ (field ID) and ‘value’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPDATE_ZENDESK_TICKETTool to update a ticket in Zendesk. Use when you need to modify ticket fields like status, priority, or subject after confirming the ticket ID.

Input Parameters

object
Optional raw ticket update object. Provide this to send fields under the ‘ticket’ wrapper directly. Alternatively, use the un-nested fields above.
array
Tags to set on the ticket. Using tags here replaces all existing tags.
string
Due date/time for task-type tickets (ISO 8601).
string ("new" | "open" | "pending" | "hold" | "solved")
Ticket status category. Allowed values: new, open, pending, hold, solved. Note: If your account has custom statuses enabled, use custom_status_id instead.
string
Ticket subject/title to set during update.
integer
The numeric ID of the group to assign the ticket to.
object
Custom metadata to attach to this update’s audit (approximately up to 1 KB).
string ("urgent" | "high" | "normal" | "low")
Ticket priority. Allowed values: urgent, high, normal, low. Values are case-sensitive.
array
Email CCs to add/remove. Each object includes user_id or user_email, optional user_name, and action (‘put’|‘delete’).
array
Followers to add/remove. Each object should include user_id or user_email, with optional action (‘put’|‘delete’).
integer
required
ID of the ticket to update.
integer
The numeric ID of the agent to assign the ticket to. The agent must be a member of the group the ticket is assigned to. Use this parameter directly rather than passing through data to avoid 400 errors.
boolean
Enable optimistic locking to prevent overwrites during collisions. Must be paired with updated_stamp to take effect.
string
Text body of the comment to add.
array
Collaborators to set (replaces existing). Accepts user IDs, emails, or {name, email} objects.
array
List of custom field values. Each item: {id: number, value: any}.
string
Last-known updated_at timestamp (ISO 8601) used together with safe_update.
boolean
Whether the added comment is public (visible to requester) or internal. Defaults to true (public); set false to create an internal note.
array
Upload tokens to attach files to the comment.
array
Collaborator user IDs to set (replaces existing).
integer
The ID of a custom ticket status. Required for accounts with custom statuses enabled. Use this instead of ‘status’ when custom statuses are active. Retrieve available custom status IDs from the Custom Ticket Statuses API.
integer
Author ID for the comment, if different from the authenticated user.
string
HTML body of the comment to add.
array
Add collaborators without removing existing ones.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_UPSERT_CUSTOM_OBJECT_RECORD_BY_EXTERNAL_ID_OR_NAMECreate or update a Zendesk custom object record by external ID or name, with external ID taking precedence when both are supplied. If no name is supplied in the request or record data, the payload uses “Untitled Record” as the name.

Input Parameters

string
The name of a custom object record. If a record with this name exists (and no external_id matches), it will be updated. If no record is found and external_id is provided, a new record will be created.
string
The external id of a custom object record. If a record with this external_id exists, it will be updated. If not found and name is provided, a new record will be created with this external_id.
object
Schema for a custom object record.
string
required
The key of a custom object. This is a user-defined unique identifier for the custom object type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_VERIFY_SUBDOMAIN_AVAILABILITYVerify if a subdomain name is available for use in Zendesk. Returns a success boolean indicating whether the subdomain can be registered. Use when checking if a desired subdomain name is available before creating a new Zendesk account or subdomain.

Input Parameters

string
required
The subdomain name to verify. The name cannot contain underscores, hyphens, or spaces.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_VERIFY_SUPPORT_ADDRESSVerify a support address forwarding in Zendesk. This action sends a verification request for the specified support address to confirm that the address is properly configured and can receive email forwarding. Use this action when you need to: - Verify a newly created support address is working correctly - Re-verify an existing support address after configuration changes - Confirm email forwarding is properly set up for a support address This action is idempotent — verifying an already-verified address will return success.

Input Parameters

integer
required
The ID of the support address to verify. You can find this ID from the support address listing or from the address details in Zendesk admin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZENDESK_VERIFY_USER_IDENTITYSet a user identity as verified in Zendesk. This action marks an email address or other identity as confirmed, indicating the user has proven ownership. Use when you need to manually verify a user’s identity after they have completed an out-of-band verification process or when you want to override the verification status for administrative purposes. Note: This action cannot verify the account owner’s email identity due to security restrictions.

Input Parameters

integer
required
The numeric ID of the user
integer
required
The numeric ID of the user identity to verify

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: ZENDESK_NEW_USER_TRIGGERType: webhookTriggered when a new user is created in Zendesk.

Configuration

array
required
The events to subscribe to.
string
required
Name of the webhook.

Payload

integer
required
The Zendesk account ID
object
required
Detailed information about the user
object
Additional event information
string
required
The event UUID
string
required
The subject of the event
string
required
The timestamp of the event
string
required
The type of the event
string
required
The version of the Zendesk event
Slug: ZENDESK_NEW_ZENDESK_TICKET_TRIGGERType: pollTriggers when a new ticket is created in a specified Zendesk view.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload

string
Type of Zendesk ticket event
object
required
Ticket details