Zendesk Component

Manage tickets and users in Zendesk.

Component key: zendesk ·

Description

Zendesk is a public company headquartered in San Francisco, California. It provides software-as-a-service products related to customer support, sales, and other customer communications. The Zendesk component allows managing Users and Tickets inside a Zendesk domain.

Zendesk webhooks

The Zendesk API supports two types of webhooks - one for when something has changed for a user or an organization, and one when something has changed on a support ticket.

Zendesk user and support webhooks

To be alerted when a change to a user or organization has occurred, create a new webhook using the Create Webhook action. Select the events that will cause the webhook to fire. For example, selecting the zen:event-type:user.deleted event will cause the webhook to fire whenever a user is deleted. A full list of webhook event types are available in the Zendesk developer docs.

Zendesk ticket webhooks

To be alerted when a ticket has changed, first create a webhook using the Create Webhook action. When selecting webhook events, choose conditional_ticket_events (and only that value). This will create a webhook, pointed at an integration flow, that can be triggered conditionally.

Next, a trigger must be created that will send data via the webhook just created. Fetch the webhook's id from the step where the webhook was created, and feed it into a Create Trigger action. The default conditional and webhook body values will cause the webhook to be triggered whenever a ticket is changed, and will send all data related to the ticket to the webhook. Keeping the default values is recommended. The conditions under which the trigger fires can be changed - see the Zendesk conditions reference for details.

Connections

API Token

key: apiToken

To use the API Token connection for Zendesk, provide the following parameters:

For Username enter the email of the Zendesk account.
For API Token enter the generated API Token under Admin Center (https://YOUR-DOMAIN-HERE.zendesk.com/admin/home) -> App and Registrations -> Zendesk API -> Token access.
For Zendesk Domain enter the Zendesk Subdomain. The subdomain can be found inside of the Zendesk URL: https://YOUR-DOMAIN-HERE.zendesk.com/

Input	Notes	Example
API Token	Your generated API token from Zendesk.	your-api-token
Zendesk Domain		https://{{#zendeskDomain}}.zendesk.com
Username	Your Zendesk username. (Email address used to login to Zendesk).	john.doe@example.com
Zendesk Sub Domain	Your Zendesk sub domain. (e.g. if your Zendesk URL is https://acme-inc.zendesk.com, then your sub domain is acme-inc).	acme-inc

OAuth 2.0 (Deprecated)

key: oauth2

The Zendesk component authenticates requests with OAuth 2.0. This connection (OAuth 2.0 (Deprecated)) is retained for backward compatibility; new connections should use OAuth 2.0 (oauth2DynamicInputs). To configure an application inside Zendesk follow the directions in this guide. Then, create a new Zendesk connection.

For Client ID enter the unique identifier of the app inside the Zendesk admin dashboard.
For Client Secret enter the generated client secret received from the Zendesk admin dashboard.
For Scopes refer to the guide linked above. It contains detailed information on picking the correct scope.

The subdomain can be found inside of the Zendesk URL: https://YOUR-DOMAIN-HERE.zendesk.com/

Input	Notes	Example
Authorize URL	The OAuth 2.0 Authorization URL for Zendesk.	https://acme-inc.zendesk.com/oauth/authorizations/new
Client ID
Client Secret
Scopes	A space-delimited set of one or more scopes to get the user's permission to access.	read write
Token URL	The OAuth 2.0 Token URL for Zendesk.	https://acme-inc.zendesk.com/oauth/tokens

OAuth 2.0

key: oauth2DynamicInputs

The Zendesk component authenticates requests with OAuth 2.0. To configure an application inside Zendesk follow the directions in this guide. Then, create a new Zendesk connection.

For Zendesk Sub Domain enter the Zendesk sub domain (e.g. if the Zendesk URL is https://acme-inc.zendesk.com, then the sub domain is acme-inc).
For Client ID enter the unique identifier of the app inside the Zendesk admin dashboard.
For Client Secret enter the generated client secret received from the Zendesk admin dashboard.
For Scopes refer to the guide linked above. It contains detailed information on picking the correct scope.

Input	Notes	Example
Authorize URL	The OAuth 2.0 Authorization URL for Zendesk.	https://{{#domain}}.zendesk.com/oauth/authorizations/new
Client ID
Client Secret
Zendesk Sub Domain	Your Zendesk sub domain. (e.g. if your Zendesk URL is https://acme-inc.zendesk.com, then your sub domain is acme-inc).	acme-inc
Scopes		read write
Token URL	The OAuth 2.0 Token URL for Zendesk.	https://{{#domain}}.zendesk.com/oauth/tokens

Triggers

New and Updated Tickets

Checks for new and updated tickets in Zendesk on a configured schedule. | key: pollChangesTrigger

Input	Notes	Example
Connection	The Zendesk connection to use.
Show New Records	When true, newly created tickets are included in the trigger output.	true
Show Updated Records	When true, tickets updated since the last poll are included in the trigger output.	true

The New and Updated Tickets polling trigger checks Zendesk on a configured schedule for tickets that were created or modified since the last poll. Unlike webhook-based triggers, polling does not require webhook subscription management and works reliably for low-frequency monitoring scenarios.

The trigger uses Zendesk's Incremental Tickets Export endpoint with cursor-based pagination. This guarantees that no tickets are missed between runs and avoids re-processing old data, because Zendesk returns a stable cursor that points to the exact position in the ticket change stream.

How It Works

On each scheduled execution, the trigger:

Reads lastPolledAt and afterCursor from the polling state. On the first run, start_time is set to 60 seconds before the current time, because Zendesk requires start_time to be at least one minute in the past.
Calls the Zendesk Incremental Tickets Export endpoint, resuming from the persisted afterCursor when available, or using start_time on the first run. The trigger drains all pages until end_of_stream is reached.
Partitions the collected tickets into created and updated buckets by comparing each ticket's created_at against the lastPolledAt cutoff. Tickets whose created_at is after the cutoff land in created, all others land in updated.
Persists both the new afterCursor and the current execution time as lastPolledAt for the next run.
Emits the partitioned results filtered by the Show New Records and Show Updated Records toggles.

Returned Data

The trigger emits a payload with two arrays, created and updated, each containing ticket resources from the Zendesk Incremental Tickets Export endpoint.

Example Payload

{
  "data": {
    "created": [
      {
        "id": 35437,
        "subject": "New ticket received",
        "status": "new",
        "priority": "normal",
        "created_at": "2026-05-20T14:00:00Z",
        "updated_at": "2026-05-20T14:00:00Z",
        "requester_id": 114092137191
      }
    ],
    "updated": [
      {
        "id": 35436,
        "subject": "Re: Billing question",
        "status": "open",
        "priority": "high",
        "created_at": "2009-07-20T22:55:29Z",
        "updated_at": "2026-05-20T15:00:00Z",
        "requester_id": 114092137191
      }
    ]
  }
}

Fields shown are representative. The full response object includes additional properties.

Example Payload for New and Updated Tickets⤓

Loading…

Webhook

Receive and validate webhook requests from Zendesk for manually configured webhook subscriptions. | key: webhook

Input	Notes	Example
Connection	The Zendesk connection to use.

Example Payload for Webhook⤓

Loading…

Data Sources

Select Article Subscription

Select a subscription for an article in the Zendesk Help Center. | key: selectArticleSubscription | type: picklist

Input	Notes	Example
Article ID	The unique identifier for the article.	123123213
Connection	The Zendesk connection to use.

Select Articles

Select an article from a dropdown menu. | key: listArticlesDataSource | type: picklist

Input	Notes	Example
Locale	The locale code for the resource.	en-us
Connection	The Zendesk connection to use.

Select Categories

Select a category from a dropdown menu. | key: listCategoriesDataSource | type: picklist

Input	Notes	Example
Locale	The locale code for the resource.	en-us
Connection	The Zendesk connection to use.

Select Management Permission Groups

Select a management permission group from a dropdown menu. | key: listPermissionGroupsDataSource | type: picklist

Input	Notes	Example
Connection	The Zendesk connection to use.

Select Post

Select a post from the Zendesk Help Center. | key: selectPost | type: picklist

Input	Notes	Example
Connection	The Zendesk connection to use.

Example Payload for Select Post⤓

Loading…

Select Post Subscription

Select a subscription for a post in the Zendesk Help Center. | key: selectPostSubscription | type: picklist

Input	Notes	Example
Post ID	The unique identifier for the post.	12
Connection	The Zendesk connection to use.

Select Section Subscription

Select a subscription for a section in the Zendesk Help Center. | key: selectSectionSubscription | type: picklist

Input	Notes	Example
Section ID	The unique identifier for the section.	123123213
Connection	The Zendesk connection to use.

Select Sections

Select a section from a dropdown menu. | key: listSectionsDataSource | type: picklist

Input	Notes	Example
Locale	The locale code for the resource.	en-us
Connection	The Zendesk connection to use.

Select Tags

Select a tag from a dropdown menu. | key: listTagsDataSource | type: picklist

Input	Notes	Example
Connection	The Zendesk connection to use.

Select Ticket

Select a ticket from your Zendesk account. | key: selectTicket | type: picklist

Input	Notes	Example
Connection	The Zendesk connection to use.

Example Payload for Select Ticket⤓

Loading…

Select Topic

Select a topic from the Zendesk Help Center. | key: selectTopic | type: picklist

Input	Notes	Example
Connection	The Zendesk connection to use.

Example Payload for Select Topic⤓

Loading…

Select Topic Subscription

Select a subscription for a topic in the Zendesk Help Center. | key: selectTopicSubscription | type: picklist

Input	Notes	Example
Topic ID	The unique identifier for the topic.	12
Connection	The Zendesk connection to use.

Select User

Select a user from your Zendesk account. | key: selectUser | type: picklist

Input	Notes	Example
Connection	The Zendesk connection to use.

Example Payload for Select User⤓

Loading…

Select User Segments

Select a user segment from a dropdown menu. | key: listUserSegmentsDataSource | type: picklist

Input	Notes	Example
Connection	The Zendesk connection to use.

Actions

Associate Attachments to Article

Associate attachments in bulk to a single article, with a maximum of 20 attachments per request. | key: associateAttachmentsInBulkToArticle

Input	Notes	Example
Article ID	The unique identifier for the article.	123123213
Attachment IDs	The list of attachment IDs to attach to the object.
Locale	The locale code for the resource.	en-us
Connection	The Zendesk connection to use.

Example Payload for Associate Attachments to Article⤓

Loading…

Create Article

Create a new article in the Help Center. | key: createArticle

Input	Notes	Example
Body	The main content of the article.	Example Body
Title	The headline displayed for the article.	Example Title
Draft	When true, the article is saved as a draft instead of published.	false
Locale	The locale code for the resource.	en-us
Notify Subscribers	When false, suppresses the article creation email to subscribers. Useful when creating many articles at once.	false
Permission Group ID	The unique identifier for the permission group.	15
Section ID	The unique identifier for the section.	123123213
User Segment ID	The unique identifier for the user segment.	15
Connection	The Zendesk connection to use.

Example Payload for Create Article⤓

Loading…

Create Article Attachment

Create an attachment for an article in the Help Center. | key: createArticleAttachment

Input	Notes	Example
Article ID	The unique identifier for the article.	123123213
File	The File Attachment to upload.
File Name	The display name to use for the uploaded file.	file.jpg
Inline	When true, the attachment is rendered inline within the content.	false
Connection	The Zendesk connection to use.

Example Payload for Create Article Attachment⤓

Loading…

Create Article Subscription

Create a subscription to an article in the Help Center. | key: createArticleSubscription

Input	Notes	Example
Article ID	The unique identifier for the article.	123123213
Locale	The locale of the article. If not provided, the default locale is used.
User ID	The ID of the user to subscribe to the section. If none provided, the API assumes the current user.	488042375842
Connection	The Zendesk connection to use.

Example Payload for Create Article Subscription⤓

Loading…

Create Category

Create a category in the Help Center. | key: createCategory

Input	Notes	Example
Category Description	The descriptive text shown below the category title.	Example Description
Category Name	The display name of the category.	Example Category
Locale	The locale code for the resource.	en-us
Position	The position of the category to be created.	42
Connection	The Zendesk connection to use.

Example Payload for Create Category⤓

Loading…

Create Post

Create a new post in the Help Center. | key: createPost

Input	Notes	Example
Content Tag IDs	The list of content tag IDs to attach to the object.
Featured	When true, the post is featured prominently in the community.	false
Pinned	When true, the post is pinned to the top of its topic.	false
Notify Subscribers	When false, suppresses the article creation email to subscribers. Useful when creating many articles at once.	false
Details	The main body content of the post.
Status	The current workflow state of the post.
Title	The headline displayed for the post.	Example Title
Topic ID	The ID of the topic to create the post in.	12
Connection	The Zendesk connection to use.

Example Payload for Create Post⤓

Loading…

Create Post Subscription

Create a post subscription in the Help Center. | key: createPostSubscription

Input	Notes	Example
Post ID	The unique identifier for the post.	12
User ID	The ID of the user to subscribe to the post. If none provided, the API assumes the current user.	488042375842
Connection	The Zendesk connection to use.

Example Payload for Create Post Subscription⤓

Loading…

Create Section

Create a section in the Help Center. | key: createSection

Input	Notes	Example
Category ID	The unique identifier for the category.	12
Locale	The locale code for the resource.	en-us
Position	The position of the section.	42
Section Description	The descriptive text shown below the section title.	Example Description
Section Name	The display name of the section.	Example Section
Connection	The Zendesk connection to use.

Example Payload for Create Section⤓

Loading…

Create Section Subscription

Create a section subscription in the Help Center. | key: createSectionSubscription

Input	Notes	Example
Include Comments	When true, the subscription also includes notifications for comments.	false
Locale	The locale of the section. If not provided, the default locale is used.
Section ID	The unique identifier for the section.	123123213
User ID	The ID of the user to subscribe to the section. If none provided, the API assumes the current user.	488042375842
Connection	The Zendesk connection to use.

Example Payload for Create Section Subscription⤓

Loading…

Create Ticket

Create a new ticket. | key: createTicket

Input	Notes	Example
Assignee ID	The unique identifier for the user assigned to the ticket.	403598029853443232
External ID	The ID of this issue from an external system
Followers	The list of user IDs to add as followers on the issue.	488042375842
Recipient Email	The email address of the ticket recipient.	Jane.Doe@example.com
Requester Email	The email address of the person requesting the ticket.	John.Doe@example-email.com
Requester Name	The full name of the person requesting the ticket.	John Doe
Requester Organization ID	The unique identifier for the organization the requester belongs to.	488042375842
Tags	The list of tags to attach to the resource.	Engineering
Ticket Comment Body	The plain text description used as the initial comment on the ticket, attributed to the assignee.	This is an example Comment.
Ticket Comment HTML Body	The HTML-formatted description used as the initial comment on the ticket, attributed to the assignee.	<p>This is an example Comment.</p>
Ticket Priority	The urgency level assigned to the ticket.
Ticket Status	The current workflow status of the ticket.
Ticket Subject	The summary line shown at the top of the ticket.	This is an example ticket subject.
Ticket Type	The classification of the ticket.
Connection	The Zendesk connection to use.

Example Payload for Create Ticket⤓

Loading…

Create Topic

Create a new topic in the Help Center. | key: createTopic

Input	Notes	Example
Topic Description	The descriptive text shown below the topic title.	Example Description
Topic Name	The display name of the topic.	Example Topic
Connection	The Zendesk connection to use.

Example Payload for Create Topic⤓

Loading…

Create Topic Subscription

Create a new topic subscription in the Help Center. | key: createTopicSubscription

Input	Notes	Example
Include Comments	When true, the subscription also includes notifications for comments.	false
Topic ID	The unique identifier for the topic.	12
User ID	The ID of the user to subscribe to the topic. If none provided, the API assumes the current user.	488042375842
Connection	The Zendesk connection to use.

Example Payload for Create Topic Subscription⤓

Loading…

Create User

Create a new user. | key: createUser

Input	Notes	Example
External ID	A unique identifier from another system. The API treats the ID as case sensitive — for example, "ian1" and "Ian1" are different users.
Moderator	When true, the user is granted moderator permissions.	false
Verified	When true, marks at least one of the user's identities as verified.	false
Organization ID	The unique identifier for the organization.
Alias	The display alias shown for the user instead of the real name.	Example Alias
Details	Additional details attached to the user record, visible to agents.	These are some example user details
Email Address	The email address for the user. Must be unique within the Zendesk domain.	someone@example.com
Name	The full name of the user.	John Doe
Notes	Free-form notes attached to the user record, visible to agents.	These are some example notes.
Phone Number	The phone number associated with the user.	15554008989
User Role	The permission level granted to the user.
Connection	The Zendesk connection to use.

Example Payload for Create User⤓

Loading…

Create Webhook

Create a webhook in Zendesk to receive notifications of changes to users, organizations, or tickets. | key: createWebhook

Input	Notes	Example
Allow Duplicates?		false
Callback URL	The URL to send data to
Events	The list of events that trigger the webhook to fire.
Webhook Name	A unique name to assign this webhook
Connection	The Zendesk connection to use.

Example Payload for Create Webhook⤓

Loading…

Create Webhook Trigger

Create a Zendesk trigger that fires a webhook. | key: createWebhookTrigger

Input	Notes	Example
Allow Duplicates?	Allow a duplicate trigger with the same title to be created?	false
Trigger Conditions	The conditions under which this trigger will fire. Leave the default to fire under any change.	`{ "all": [], "any": [ { "field": "status", "operator": "changed" }, { "field": "status", "operator": "not_changed" } ] }`
Connection	The Zendesk connection to use.
Webhook Message Body	The body to send to the webhook. See Zendesk Support documentation for placeholder references.	{ "current_user": { "details": "{{current_user.details}}", "email": "{{current_user.email}}", "external_id": "{{current_user.external_id}}", "first_name": "{{current_user.first_name}}", "language": "{{current_user.language}}", "name": "{{current_user.name}}", "notes": "{{current_user.notes}}", "organization.details": "{{current_user.organization.details}}", "organization.name": "{{current_user.organization.name}}", "organization.notes": "{{current_user.organization.notes}}", "phone": "{{current_user.phone}}", "tags": "{{current_user.tags}}" }, "ticket": { "account": "{{ticket.account}}", "assignee": { "first_name": "{{ticket.assignee.first_name}}", "last_name": "{{ticket.assignee.last_name}}", "name": "{{ticket.assignee.name}}" }, "brand": { "name": "{{ticket.brand.name}}" }, "cc_names": "{{ticket.cc_names}}", "ccs": "{{ticket.ccs}}", "comments_formatted": "{{ticket.comments_formatted}}", "description": "{{ticket.description}}", "due_date": "{{ticket.due_date}}", "email_cc_names": "{{ticket.email_cc_names}}", "email_ccs": "{{ticket.email_ccs}}", "external_id": "{{ticket.external_id}}", "follower_names": "{{ticket.follower_names}}", "follower_reply_type_message": "{{ticket.follower_reply_type_message}}", "followers": "{{ticket.followers}}", "group": { "name": "{{ticket.group.name}}" }, "id": "{{ticket.id}}", "in_business_hours": "{{ticket.in_business_hours}}", "latest_comment_formatted": "{{ticket.latest_comment_formatted}}", "latest_public_comment_formatted": "{{ticket.latest_public_comment_formatted}}", "link": "{{ticket.link}}", "organization": { "external_id": "{{ticket.organization.external_id}}", "name": "{{ticket.organization.name}}" }, "priority": "{{ticket.priority}}", "public_comments_formatted": "{{ticket.public_comments_formatted}}", "requester": { "email": "{{ticket.requester.email}}", "external_id": "{{ticket.requester.external_id}}", "first_name": "{{ticket.requester.first_name}}", "language": "{{ticket.requester.language}}", "last_name": "{{ticket.requester.last_name}}", "name": "{{ticket.requester.name}}", "phone": "{{ticket.requester.phone}}" }, "status": "{{ticket.status}}", "tags": "{{ticket.tags}}", "ticket_field_ID": "{{ticket.ticket_field_ID}}", "ticket_field_option_title_ID": "{{ticket.ticket_field_option_title_ID}}", "ticket_form": "{{ticket.ticket_form}}", "ticket_type": "{{ticket.ticket_type}}", "title": "{{ticket.title}}", "via": "{{ticket.via}}" } }
Trigger Name
Webhook ID		01GK7R2DBS16XB76SPDEXAMPLE

Example Payload for Create Webhook Trigger⤓

Loading…

Delete Article Attachment

Delete an existing article attachment. | key: deleteArticleAttachment

Input	Notes	Example
Article Attachment ID	The unique identifier for the article attachment.	12
Connection	The Zendesk connection to use.

Example Payload for Delete Article Attachment⤓

Loading…

Delete Article Subscription

Delete a subscription to an article in the Help Center. | key: deleteArticleSubscription

Input	Notes	Example
Article ID	The unique identifier for the article.	123123213
Locale	The locale of the article. If not provided, the default locale is used.
Subscription ID	The unique identifier for the subscription.	12
Connection	The Zendesk connection to use.

Example Payload for Delete Article Subscription⤓

Loading…

Delete Category

Delete a category in the Help Center. | key: deleteCategory

Input	Notes	Example
Category ID	The unique identifier for the category.	12
Connection	The Zendesk connection to use.

Example Payload for Delete Category⤓

Loading…

Delete Instance Webhooks

Delete all webhooks pointing to this instance. | key: deleteInstanceWebhooks

Input	Notes	Example
Connection	The Zendesk connection to use.

Example Payload for Delete Instance Webhooks⤓

Loading…

Delete Post

Delete a post in the Help Center. | key: deletePost

Input	Notes	Example
Post ID	The unique identifier for the post.	12
Connection	The Zendesk connection to use.

Example Payload for Delete Post⤓

Loading…

Delete Post Subscription

Delete a post subscription in the Help Center. | key: deletePostSubscription

Input	Notes	Example
Post ID	The unique identifier for the post.	12
Subscription ID	The unique identifier for the subscription.	12
Connection	The Zendesk connection to use.

Example Payload for Delete Post Subscription⤓

Loading…

Delete Section

Delete a section in the Help Center. (warning: deleting a section also deletes all its articles). | key: deleteSection

Input	Notes	Example
Locale	The locale code for the resource.	en-us
Section ID	The unique identifier for the section.	123123213
Connection	The Zendesk connection to use.

Example Payload for Delete Section⤓

Loading…

Delete Section Subscription

Delete a section subscription in the Help Center. | key: deleteSectionSubscription

Input	Notes	Example
Section ID	The unique identifier for the section.	123123213
Subscription ID	The unique identifier for the subscription.	12
Connection	The Zendesk connection to use.

Example Payload for Delete Section Subscription⤓

Loading…

Delete Ticket

Delete a ticket by ID. | key: deleteTicket

Input	Notes	Example
Ticket ID	The unique identifier for the ticket.	ExampleTicketId
Connection	The Zendesk connection to use.

Example Payload for Delete Ticket⤓

Loading…

Delete Topic

Delete a topic from the Help Center. | key: deleteTopic

Input	Notes	Example
Topic ID	The unique identifier for the topic.	12
Connection	The Zendesk connection to use.

Example Payload for Delete Topic⤓

Loading…

Delete Topic Subscription

Delete a topic subscription in the Help Center. | key: deleteTopicSubscription

Input	Notes	Example
Subscription ID	The unique identifier for the subscription.	12
Topic ID	The unique identifier for the topic.	12
Connection	The Zendesk connection to use.

Example Payload for Delete Topic Subscription⤓

Loading…

Delete User

Delete a user by ID. | key: deleteUser

Input	Notes	Example
User ID	The unique identifier for the user.	488042375842
Connection	The Zendesk connection to use.

Example Payload for Delete User⤓

Loading…

Delete Webhook

Delete a webhook by ID. | key: deleteWebhook

Input	Notes	Example
Webhook ID		01GK59HW1XMB8WVZ43RPVAPXRM
Connection	The Zendesk connection to use.

Example Payload for Delete Webhook⤓

Loading…

Get Article

Get an article from the Help Center. | key: showArticle

Input	Notes	Example
Article ID	The unique identifier for the article.	123123213
Locale	The locale of the articles to retrieve. Defaults to 'en-us'.	en-us
Connection	The Zendesk connection to use.

Example Payload for Get Article⤓

Loading…

Get Article Attachment

Get the properties of an attachment on an article in the Help Center. | key: getArticleAttachment

Input	Notes	Example
Article Attachment ID	The unique identifier for the article attachment.	12
Article ID	The unique identifier for the article.	123123213
Connection	The Zendesk connection to use.

Example Payload for Get Article Attachment⤓

Loading…

Get Article Subscription

Get an article subscription from the Help Center. | key: getArticleSubscription

Input	Notes	Example
Article ID	The unique identifier for the article.	123123213
Locale	The locale of the article. If not provided, the default locale is used.
Subscription ID	The unique identifier for the subscription.	12
Connection	The Zendesk connection to use.

Example Payload for Get Article Subscription⤓

Loading…

Get Category

Get a category from the Help Center. | key: getCategory

Input	Notes	Example
Category ID	The unique identifier for the category.	12
Locale	The locale code for the resource.	en-us
Connection	The Zendesk connection to use.

Example Payload for Get Category⤓

Loading…

Get Post

Get a post from the Help Center. | key: getPost

Input	Notes	Example
Post ID	The unique identifier for the post.	12
Connection	The Zendesk connection to use.

Example Payload for Get Post⤓

Loading…

Get Post Subscription

Get a post subscription from the Help Center. | key: getPostSubscription

Input	Notes	Example
Post ID	The unique identifier for the post.	12
Subscription ID	The unique identifier for the subscription.	12
Connection	The Zendesk connection to use.

Example Payload for Get Post Subscription⤓

Loading…

Get Section

Get a section from the Help Center. | key: getSection

Input	Notes	Example
Locale	The locale code for the resource.	en-us
Section ID	The unique identifier for the section.	123123213
Connection	The Zendesk connection to use.

Example Payload for Get Section⤓

Loading…

Get Section Subscription

Get a section subscription from the Help Center. | key: getSectionSubscription

Input	Notes	Example
Section ID	The unique identifier for the section.	123123213
Subscription ID	The unique identifier for the subscription.	12
Connection	The Zendesk connection to use.

Example Payload for Get Section Subscription⤓

Loading…

Get Ticket

Get a ticket by ID. | key: showTicket

Input	Notes	Example
Ticket ID	The unique identifier for the ticket.	ExampleTicketId
Connection	The Zendesk connection to use.

Example Payload for Get Ticket⤓

Loading…

Get Ticket By External ID

Get a ticket by external ID. | key: getByExternalId

Input	Notes	Example
External ID	The identifier for the issue from an external system.
Connection	The Zendesk connection to use.

Example Payload for Get Ticket By External ID⤓

Loading…

Get Topic

Get a topic from the Help Center. | key: getTopic

Input	Notes	Example
Topic ID	The unique identifier for the topic.	12
Connection	The Zendesk connection to use.

Example Payload for Get Topic⤓

Loading…

Get Topic Subscription

Get a topic subscription from the Help Center. | key: getTopicSubscription

Input	Notes	Example
Subscription ID	The unique identifier for the subscription.	12
Topic ID	The unique identifier for the topic.	12
Connection	The Zendesk connection to use.

Example Payload for Get Topic Subscription⤓

Loading…

Get User

Get a user by ID. | key: showUser

Input	Notes	Example
User ID	The unique identifier for the user.	488042375842
Connection	The Zendesk connection to use.

Example Payload for Get User⤓

Loading…

List Article Attachments

List all attachments for an article in the Help Center. | key: listArticleAttachments

Input	Notes	Example
Article ID	The unique identifier for the article.	123123213
Fetch All	When true, automatically fetches all pages of results instead of returning a single page.	false
Page Limit	The number of results to return per page. The maximum is 100; any greater value is capped at 100.	100
Connection	The Zendesk connection to use.

Example Payload for List Article Attachments⤓

Loading…

List Article Subscriptions

List all subscriptions for an article in the Help Center. | key: listArticleSubscriptions

Input	Notes	Example
Article ID	The unique identifier for the article.	123123213
Pagination Cursor	The pagination cursor from a previous request. If omitted, the first page is returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Page Limit	The number of results to return per page. The maximum is 100; any greater value is capped at 100.	100
Connection	The Zendesk connection to use.

Example Payload for List Article Subscriptions⤓

Loading…

List Articles

List all articles in the Help Center. | key: listArticles

Input	Notes	Example
Label Names	Restrict results to articles with the specified labels. A maximum of 10 labels can be supplied. See label names for more information.	examplelabel1
Pagination Cursor	The pagination cursor from a previous request. If omitted, the first page is returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Fetch All	When true, automatically fetches all pages of results instead of returning a single page.	false
Locale	The locale of the articles to retrieve. Defaults to 'en-us'.	en-us
Page Limit	The number of results to return per page. The maximum is 100; any greater value is capped at 100.	100
Sort By	The field to sort the articles by.
Sort Order	The direction used to order the results.	asc
Start Time	The start time to filter articles by.	1779831652199
Connection	The Zendesk connection to use.

Example Payload for List Articles⤓

Loading…

List all categories in the Help Center. | key: listCategories

Input	Notes	Example
Fetch All	When true, automatically fetches all pages of results instead of returning a single page.	false
Locale	The locale code for the resource.	en-us
Page Limit	The number of results to return per page. The maximum is 100; any greater value is capped at 100.	100
Sort By	The field used to sort the results.
Sort Order	The direction used to order the results.	asc
Connection	The Zendesk connection to use.

Example Payload for List Categories⤓

Loading…

List Post Subscriptions

List all post subscriptions in the Help Center. | key: listPostSubscriptions

Input	Notes	Example
Pagination Cursor	The pagination cursor from a previous request. If omitted, the first page is returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Page Limit	The number of results to return per page. The maximum is 100; any greater value is capped at 100.	100
Post ID	The unique identifier for the post.	12
Connection	The Zendesk connection to use.

Example Payload for List Post Subscriptions⤓

Loading…

List Posts

List all posts in the Help Center. | key: listPosts

Input	Notes	Example
Pagination Cursor	The pagination cursor from a previous request. If omitted, the first page is returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Fetch All	When true, automatically fetches all pages of results instead of returning a single page.	false
Filter By	The field used to filter the results.
Page Limit	The number of results to return per page. The maximum is 100; any greater value is capped at 100.	100
Sort By	The field used to sort the results.
Topic ID	The unique identifier for the topic.	12
Connection	The Zendesk connection to use.

Example Payload for List Posts⤓

Loading…

List Section Subscriptions

List all section subscriptions in the Help Center. | key: listSectionSubscriptions

Input	Notes	Example
Pagination Cursor	The pagination cursor from a previous request. If omitted, the first page is returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Page Limit	The number of results to return per page. The maximum is 100; any greater value is capped at 100.	100
Section ID	The unique identifier for the section.	123123213
Connection	The Zendesk connection to use.

Example Payload for List Section Subscriptions⤓

Loading…

List Sections

Lists all the sections in the Help Center or in a specific category. | key: listSections

Input	Notes	Example
Category ID	Input a categoryId to filter out sections by the ID provided.	12
Fetch All	When true, automatically fetches all pages of results instead of returning a single page.	false
Locale	The locale code for the resource.	en-us
Page Limit	The number of results to return per page. The maximum is 100; any greater value is capped at 100.	100
Sort By	The field used to sort the results.
Sort Order	The direction used to order the results.	asc
Connection	The Zendesk connection to use.

Example Payload for List Sections⤓

Loading…

List Tickets

List all tickets. | key: listTickets

Input	Notes	Example
Connection	The Zendesk connection to use.

Example Payload for List Tickets⤓

Loading…

List Tickets Assigned To User

List all of the tickets that have been assigned to a particular user. | key: listTicketsToUser

Input	Notes	Example
User ID	The unique identifier for the user.	488042375842
Connection	The Zendesk connection to use.

Example Payload for List Tickets Assigned To User⤓

Loading…

List Tickets Requested By User

List all of the tickets that a particular user has requested. | key: listTicketsByUser

Input	Notes	Example
User ID	The unique identifier for the user.	488042375842
Connection	The Zendesk connection to use.

Example Payload for List Tickets Requested By User⤓

Loading…

List Topic Subscriptions

List all topic subscriptions in the Help Center. | key: listTopicSubscriptions

Input	Notes	Example
Pagination Cursor	The pagination cursor from a previous request. If omitted, the first page is returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Page Limit	The number of results to return per page. The maximum is 100; any greater value is capped at 100.	100
Topic ID	The unique identifier for the topic.	12
Connection	The Zendesk connection to use.

Example Payload for List Topic Subscriptions⤓

Loading…

List Topics

List all topics in the Help Center. | key: listTopics

Input	Notes	Example
Pagination Cursor	The pagination cursor from a previous request. If omitted, the first page is returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Fetch All	When true, automatically fetches all pages of results instead of returning a single page.	false
Page Limit	The number of results to return per page. The maximum is 100; any greater value is capped at 100.	100
Connection	The Zendesk connection to use.

Example Payload for List Topics⤓

Loading…

List Triggers

List all workflow triggers configured in Zendesk. | key: listTriggers

Input	Notes	Example
Connection	The Zendesk connection to use.

Example Payload for List Triggers⤓

Loading…

List Users

List all users. | key: listUsers

Input	Notes	Example
Connection	The Zendesk connection to use.

Example Payload for List Users⤓

Loading…

List Webhooks

List all webhooks configured in Zendesk. | key: listWebhooks

Input	Notes	Example
Show only instance webhooks	Show only webhooks that point to this instance	true
Connection	The Zendesk connection to use.

Example Payload for List Webhooks⤓

Loading…

Raw Request

Send a raw HTTP request to Zendesk. | key: rawRequest

Input	Notes	Example
Connection	The Zendesk connection to use.
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request	Enabling this flag will log out the current request.	false
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Method	The HTTP method to use.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Timeout	The maximum time that a client will await a response to its request	2000
URL	Input the path only (/users), The base URL is already included with your proper Zendesk domain (https://YOUR-ZENDESK-DOMAIN.zendesk.com/api/v2). For example, to connect to https://YOUR-ZENDESK-DOMAIN.zendesk.com/api/v2/users, only /users is entered in this field.	/users
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

The Raw Request action allows interaction with API endpoints that are not covered by other actions. For example, to list groups, which has an endpoint of /api/v2/groups, enter /groups as the endpoint and select the GET verb.

Example Payload for Raw Request⤓

Loading…

Search Articles

Search for articles in the Help Center. | key: searchArticles

Input	Notes	Example
Brand IDs	Restrict the search to articles or posts within these brands.	63
Category IDs	Restrict the search to articles or posts within these categories.	63
Created After	The lower bound used to filter results by creation date. Format: YYYY-MM-DD.	2024-05-01
Created At	The exact creation date used to filter the results. Format: YYYY-MM-DD.	2024-05-01
Created Before	The upper bound used to filter results by creation date. Format: YYYY-MM-DD.	2024-05-01
Label Names	The list of label names used to filter the results.	examplelabel1
Locales	The locale to filter the results by.	en-us
Section ID	The unique identifier for the section used to filter the results.	12
Updated After	The lower bound used to filter results by update date. Format: YYYY-MM-DD.	2024-05-01
Updated At	The exact update date used to filter the results. Format: YYYY-MM-DD.	2024-05-01
Updated Before	The upper bound used to filter results by update date. Format: YYYY-MM-DD.	2024-05-01
Search Query	The text or search string used to match results.	carrot
Multibrand	When true, results are filtered across all brands in the account.	false
Sort By	The field used to sort the results.
Sort Order	The direction used to order the results.	asc
Connection	The Zendesk connection to use.

Example Payload for Search Articles⤓

Loading…

Search Posts

Search posts in the Help Center. | key: searchPosts

Input	Notes	Example
Created After	The lower bound used to filter results by creation date. Format: YYYY-MM-DD.	2024-05-01
Created At	The exact creation date used to filter the results. Format: YYYY-MM-DD.	2024-05-01
Created Before	The upper bound used to filter results by creation date. Format: YYYY-MM-DD.	2024-05-01
Updated After	The lower bound used to filter results by update date. Format: YYYY-MM-DD.	2024-05-01
Updated At	The exact update date used to filter the results. Format: YYYY-MM-DD.	2024-05-01
Updated Before	The upper bound used to filter results by update date. Format: YYYY-MM-DD.	2024-05-01
Search Query	The text or search string used to match results.	carrot
Sort By	The field used to sort the results.
Sort Order	The direction used to order the results.	asc
Topic ID	The ID of the topic to filter posts by.	12
Connection	The Zendesk connection to use.

Example Payload for Search Posts⤓

Loading…

Search Users

Return an array of users who meet the search criteria. | key: searchUsers

Input	Notes	Example
External ID	The external_id parameter does not support the search syntax. It only accepts ids.
Query	The search query supporting Zendesk search syntax. Accepts a partial or full value of any user property, including name, email address, notes, or phone. Example: query="jdoe".
Connection	The Zendesk connection to use.

Example Payload for Search Users⤓

Loading…

Unified Search

Search for knowledge base articles, community posts, and external records in the Help Center. | key: unifiedSearch

Input	Notes	Example
Brand IDs	Restrict the search to articles or posts within these brands.	63
Category IDs	Restrict the search to articles or posts within these categories.	63
Content Types	Restrict the search to one of these content types: ARTICLE, POST.
Pagination Cursor	The pagination cursor from a previous request. If omitted, the first page is returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
External Source IDs	Restrict the search results to the specified external source or sources.	63
Locales	Restrict the search to articles or posts within these locales.	en-us
Page Limit	The number of results to return per page. The maximum is 100; any greater value is capped at 100.	100
Search Query	The text or search string used to match results.	carrot
Section IDs	Restrict the search to articles or posts within these sections.	63
Topic IDs	Restrict the search to posts within these topics.	63
Connection	The Zendesk connection to use.

Example Payload for Unified Search⤓

Loading…

Update Article

Update an existing article's metadata in the Help Center. | key: updateArticle

Input	Notes	Example
Body	The main content of the article.	Example Body
Article ID	The unique identifier for the article.	123123213
Title	The headline displayed for the article.	Example Title
Author ID	The unique identifier for the author.	12
Comments Disabled	When true, prevents users from leaving comments on the object.
Content Tag IDs	The list of content tag IDs to attach to the object.
Label Names	The list of label names to attach to the object.
Locale	The locale code for the resource.	en-us
Permission Group ID	The unique identifier for the permission group.	15
Position	The numeric ordering position of the object within its list.	42
Promoted	When true, the object is highlighted at the top of its list.
Section ID	The unique identifier for the section.	123123213
User Segment ID	The unique identifier for the user segment.	15
Connection	The Zendesk connection to use.

Example Payload for Update Article⤓

Loading…

Update Category

Update a category in the Help Center. | key: updateCategory

Input	Notes	Example
Category Description	The description of the category to be updated.	Example Description
Category ID	The unique identifier for the category.	12
Category Name	The name of the category to be updated.	Example Category
Locale	The locale of the category to be updated.	en-us
Position	The position of the category to be updated.	42
Connection	The Zendesk connection to use.

Example Payload for Update Category⤓

Loading…

Update Post

Update a post in the Help Center. | key: updatePost

Input	Notes	Example
Content Tag IDs	The list of content tag IDs to attach to the object.
Closed	When true, the post is closed to new comments.
Featured	When true, the post is featured prominently in the community.
Pinned	When true, the post is pinned to the top of its topic.
Details	The main body content of the post.
Post ID	The unique identifier for the post.	12
Status	The current workflow state of the post.
Title	The headline displayed for the post.	Example Title
Topic ID	The unique identifier for the topic.	12
Connection	The Zendesk connection to use.

Example Payload for Update Post⤓

Loading…

Update Section

Update a section in the Help Center. | key: updateSection

Input	Notes	Example
Category ID	Category ID of the Section to update.	12
Locale	The locale code for the resource.	en-us
Parent Section ID	Parent Section ID of the Section to update.	12
Position	Position of the Section to update.	42
Section Description	Description of the Section to update.	Example Description
Section ID	The unique identifier for the section.	123123213
Section Name	Name of the Section to update.	Example Section
Connection	The Zendesk connection to use.

Example Payload for Update Section⤓

Loading…

Update Ticket

Update a ticket by ID. | key: updateTicket

Input	Notes	Example
Assignee Email	The email address of the user assigned to the ticket.	Jane.Doe@example.com
Assignee ID	The unique identifier for the user assigned to the ticket.	403598029853443232
File	The file contents to attach to the comment, accepted as either a string or a binary payload.
File Name	The display name to use for the uploaded file.
Requester Organization ID	The unique identifier for the organization the requester belongs to.	488042375842
Tags	The list of tags to attach to the resource.	Engineering
Ticket Comment Body	The plain text description used as the initial comment on the ticket, attributed to the assignee.	This is an example Comment.
Ticket Comment HTML Body	The HTML-formatted description used as the initial comment on the ticket, attributed to the assignee.	<p>This is an example Comment.</p>
Ticket ID	The unique identifier for the ticket.	ExampleTicketId
Ticket Priority	The urgency level assigned to the ticket.
Ticket Status	The current workflow status of the ticket.
Ticket Subject	The summary line shown at the top of the ticket.	This is an example ticket subject.
Ticket Type	The classification of the ticket.
Connection	The Zendesk connection to use.

Example Payload for Update Ticket⤓

Loading…

Update Topic

Update a topic in the Help Center. | key: updateTopic

Input	Notes	Example
Manageable By	The user segment allowed to manage the topic.
Position	The position of the topic in the list of topics.	42
Topic Description	The descriptive text shown below the topic title.	Example Description
Topic ID	The unique identifier for the topic.	12
Topic Name	The display name of the topic.	Example Topic
User Segment ID	The user segment ID to associate with the topic.	15
Connection	The Zendesk connection to use.

Example Payload for Update Topic⤓

Loading…

Update User

Update a user by ID. | key: updateUser

Input	Notes	Example
External ID	A unique identifier from another system. The API treats the ID as case sensitive — for example, "ian1" and "Ian1" are different users.
Moderator	When true, the user is granted moderator permissions.
Verified	When true, marks at least one of the user's identities as verified.
Organization ID	The unique identifier for the organization.
Alias	The display alias shown for the user instead of the real name.	Example Alias
Details	Additional details attached to the user record, visible to agents.	These are some example user details
Email Address	The email address for the user. Must be unique within the Zendesk domain.	someone@example.com
User ID	The unique identifier for the user.	488042375842
Name	The full name of the user.	John Doe
Notes	Free-form notes attached to the user record, visible to agents.	These are some example notes.
Phone Number	The phone number associated with the user.	15554008989
User Role	The permission level granted to the user.
Time Zone	The time zone the user operates in.	Berlin
Connection	The Zendesk connection to use.

Updating a user's 'User Role' from an end-user to administrator may cause a failed execution. For more information refer to the user permissions guide in the Zendesk docs.

Example Payload for Update User⤓

Loading…

Changelog

2026-05-26

Added the New and Updated Tickets polling trigger using the Zendesk Incremental Tickets Export cursor stream. The trigger drains pages until end_of_stream and persists both the cursor and the last polled timestamp for accurate created vs. updated partitioning

2026-04-30

Various modernizations and documentation updates

2026-03-16

Improved input field documentation with formatted URL links for better readability

2026-03-13

Enhanced OAuth 2.0 connections with PKCE S256 support for improved authorization security. Removed the Debug Request input from all action inputs.

2026-03-05

Added inline data sources for topic, article, section, and post subscriptions to enable dynamic dropdown selection

2026-02-26

Added inline data sources for users, tickets, topics, and posts to enable dynamic dropdown selection

2025-11-19

Enhanced webhook triggers to support simulated test executions

2025-08-04

Security improvements to the API token connection

Manage tickets and users in Zendesk.

Description​

Zendesk webhooks​

Zendesk user and support webhooks​

Zendesk ticket webhooks​

Connections​

API Token​

OAuth 2.0 (Deprecated)​

OAuth 2.0​

Triggers​

New and Updated Tickets​

How It Works​

Returned Data​

Webhook​

Data Sources​

Select Article Subscription​

Select Articles​

Select Categories​

Select Management Permission Groups​

Select Post​

Select Post Subscription​

Select Section Subscription​

Select Sections​

Select Tags​

Select Ticket​

Select Topic​

Select Topic Subscription​

Select User​

Select User Segments​

Actions​

Associate Attachments to Article​

Create Article​

Create Article Attachment​

Create Article Subscription​

Create Category​

Create Post​

Create Post Subscription​

Create Section​

Create Section Subscription​

Create Ticket​

Create Topic​

Create Topic Subscription​

Create User​

Create Webhook​

Create Webhook Trigger​

Delete Article Attachment​

Delete Article Subscription​

Delete Category​

Delete Instance Webhooks​

Delete Post​

Delete Post Subscription​

Delete Section​

Delete Section Subscription​

Delete Ticket​

Delete Topic​

Delete Topic Subscription​

Delete User​

Delete Webhook​

Get Article​

Get Article Attachment​

Get Article Subscription​

Get Category​

Get Post​

Get Post Subscription​

Get Section​

Get Section Subscription​

Get Ticket​

Get Ticket By External ID​

Get Topic​

Get Topic Subscription​

Get User​

List Article Attachments​

List Article Subscriptions​

List Articles​

List Categories​

List Post Subscriptions​

List Posts​

List Section Subscriptions​

List Sections​

List Tickets​

Description

Zendesk webhooks

Zendesk user and support webhooks

Zendesk ticket webhooks

Connections

API Token

OAuth 2.0 (Deprecated)

OAuth 2.0

Triggers

New and Updated Tickets

How It Works

Returned Data

Webhook

Data Sources

Select Article Subscription

Select Articles

Select Categories

Select Management Permission Groups

Select Post

Select Post Subscription

Select Section Subscription

Select Sections

Select Tags

Select Ticket

Select Topic

Select Topic Subscription

Select User

Select User Segments

Actions

Associate Attachments to Article

Create Article

Create Article Attachment

Create Article Subscription

Create Category

Create Post

Create Post Subscription

Create Section

Create Section Subscription

Create Ticket

Create Topic

Create Topic Subscription

Create User

Create Webhook

Create Webhook Trigger

Delete Article Attachment

Delete Article Subscription

Delete Category

Delete Instance Webhooks

Delete Post

Delete Post Subscription

Delete Section

Delete Section Subscription

Delete Ticket

Delete Topic

Delete Topic Subscription

Delete User

Delete Webhook

Get Article

Get Article Attachment

Get Article Subscription

Get Category

Get Post

Get Post Subscription

Get Section

Get Section Subscription

Get Ticket

Get Ticket By External ID

Get Topic

Get Topic Subscription

Get User

List Article Attachments

List Article Subscriptions

List Articles

List Categories

List Post Subscriptions

List Posts

List Section Subscriptions

List Sections

List Tickets

List Tickets Assigned To User