Zendesk Connector

Zendesk is a 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.

API Documentation

This component was built using the Zendesk API Reference.

Connections

API Token

Authenticate requests using an API token.

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

Configure the Connection

• 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 Sub Domain enter the Zendesk sub domain. The subdomain can be found inside of the Zendesk URL: https://YOUR-DOMAIN-HERE.zendesk.com/

Input	Comments	Default
Zendesk Sub Domain	The Zendesk sub domain. For example, if the Zendesk URL is https://acme-inc.zendesk.com, the sub domain is acme-inc.
Username	The Zendesk username. This is the email address used to sign in to Zendesk.
API Token	The API token generated in Zendesk.

OAuth 2.0

Authenticate using OAuth 2.0.

The Zendesk component authenticates requests with OAuth 2.0.

Setup Steps

To configure an application inside Zendesk follow the directions in this guide. Then, create a new Zendesk connection.

Configure the 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 Redirect URL/Callback URL in the Zendesk app settings, enter https://oauth2.integrations.acme.com/callback.
• For Scopes refer to the guide linked above. It contains detailed information on picking the correct scope.

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

Input	Comments	Default
Zendesk Sub Domain	The Zendesk sub domain. For example, if the Zendesk URL is https://acme-inc.zendesk.com, the sub domain is acme-inc.
Client ID	The Client ID of the OAuth application registered in Zendesk.
Client Secret	The Client Secret of the OAuth application registered in Zendesk.
Scopes	A space-delimited set of one or more scopes to get the user's permission to access.	read write

OAuth 2.0 (Deprecated)

Authenticate using OAuth 2.0. (Deprecated)

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).

Setup Steps

To configure an application inside Zendesk follow the directions in this guide. Then, create a new Zendesk connection.

Configure the 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 Redirect URL/Callback URL in the Zendesk app settings, enter https://oauth2.integrations.acme.com/callback.
• For Authorize URL enter https://YOUR-ZENDESK-DOMAIN.zendesk.com/oauth/authorizations/new, replacing the placeholder with the Zendesk sub domain.
• For Token URL enter https://YOUR-ZENDESK-DOMAIN.zendesk.com/oauth/tokens, replacing the placeholder with the Zendesk sub domain.
• For Scopes refer to the guide linked above. It contains detailed information on picking the correct scope.

The sub domain used in both URLs above can be found inside the Zendesk URL: https://YOUR-ZENDESK-DOMAIN.zendesk.com/

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

Input	Comments	Default
Authorize URL	The OAuth 2.0 Authorization URL for Zendesk.	https://YOUR-ZENDESK-DOMAIN.zendesk.com/oauth/authorizations/new
Token URL	The OAuth 2.0 Token URL for Zendesk.	https://YOUR-ZENDESK-DOMAIN.zendesk.com/oauth/tokens
Client ID	The Client ID of the OAuth application registered in Zendesk.
Client Secret	The Client Secret of the OAuth application registered in Zendesk.
Scopes	A space-delimited set of one or more scopes to get the user's permission to access.	read write

Triggers

New and Updated Tickets

Retrieves existing and ongoing tickets from Zendesk. Load history once, check for changes on a schedule, or both.

Input	Comments	Default
Connection	The Zendesk connection to use.
Look-back Date	The date the initial sync starts from, in YYYY-MM-DD format. Cannot be a future date. Leave empty to start from the first recurrence with no backfill. When set, the initial sync seeds each ticket created or updated on or after this date once, ignoring the visibility filters.
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

Webhook

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

Input	Comments	Default
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.

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

Create Article

Create a new article in the Help Center.

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

Create Article Attachment

Create an attachment for an article in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Locale	The Help Center locale used to populate the article picker. Defaults to 'en-us'.	en-us
Article ID	The unique identifier for the article.
File	The File Attachment to upload.
File Name	The display name to use for the uploaded file.
Inline	When true, the attachment is rendered inline within the content.	false

Create Article Subscription

Create a subscription to an article in the Help Center.

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

Create Category

Create a category in the Help Center.

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

Create Post

Create a new post in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Topic ID	The ID of the topic to create the post in.
Title	The headline displayed for the post.
Details	The main body content of the post.
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
Status	The current workflow state of the post.
Notify Subscribers	When false, suppresses the article creation email to subscribers. Useful when creating many articles at once.	false
Content Tag IDs	The list of content tag IDs to attach to the object.

Create Post Subscription

Create a post subscription in the Help Center.

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

Create Section

Create a section in the Help Center.

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

Create Section Subscription

Create a section subscription in the Help Center.

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

Create Ticket

Create a new ticket.

Input	Comments	Default
Requester Name	The full name of the person requesting the ticket.
Requester Email	The email address of the person requesting the ticket.
Assignee ID	The unique identifier for the user assigned to the ticket.
Recipient Email	The email address of the ticket recipient.
Ticket Subject	The summary line shown at the top of the ticket.
Classification	Priority, status, and type of the record.
Ticket Priority	The urgency level assigned to the ticket.
Ticket Status	The current workflow status of the ticket.
Ticket Type	The classification of the ticket.
Ticket Comment Body	The plain text description used as the initial comment on the ticket, attributed to the assignee.
Ticket Comment HTML Body	The HTML-formatted description used as the initial comment on the ticket, attributed to the assignee.
Tags	The list of tags to attach to the resource.
Requester Organization ID	The unique identifier for the organization the requester belongs to.
Followers	The list of user IDs to add as followers on the ticket.
Connection	The Zendesk connection to use.
External ID	The identifier for the ticket from an external system.

Create Topic

Create a new topic in the Help Center.

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

Create Topic Subscription

Create a new topic subscription in the Help Center.

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

Create User

Create a new user.

Input	Comments	Default
Name	The full name of the user.
Email Address	The email address for the user. Must be unique within the Zendesk domain.
Account Settings	Role, moderator permission, and verification state for the record.
User Role	The permission level granted to the user.
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
Phone Number	The phone number associated with the user.
External ID	A unique identifier from another system. The API treats the ID as case sensitive — for example, "ian1" and "Ian1" are different users.
Profile Details	Alias, notes, and other descriptive attributes for the record.
Alias	The display alias shown for the user instead of the real name.
Notes	Free-form notes attached to the user record, visible to agents.
Details	Additional details attached to the user record, visible to agents.
Organization ID	The unique identifier for the organization.
Connection	The Zendesk connection to use.

Create Webhook

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

Input	Comments	Default
Connection	The Zendesk connection to use.
Callback URL	The URL of the endpoint that receives the webhook payload.
Webhook Name	A unique name used to identify the webhook in the Zendesk admin UI.
Events	The list of events that trigger the webhook to fire.
Allow Duplicates?	When true, a webhook is created even if one with the same name already exists.	false

Create Webhook Trigger

Create a Zendesk trigger that fires a webhook.

Input	Comments	Default
Connection	The Zendesk connection to use.
Trigger Name	The name shown for the trigger in the Zendesk admin UI.
Webhook ID	The unique identifier for the webhook this trigger fires.
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 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" } ] }
Allow Duplicates?	Allow a duplicate trigger with the same title to be created?	false

Delete Article Attachment

Delete an existing article attachment.

Input	Comments	Default
Connection	The Zendesk connection to use.
Article Attachment ID	The unique identifier for the article attachment.

Delete Article Subscription

Delete a subscription to an article in the Help Center.

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

Delete Category

Delete a category in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Locale	The Help Center locale used to populate the category picker. Defaults to 'en-us'.	en-us
Category ID	The unique identifier for the category.

Delete Instance Webhooks

Delete all webhooks pointing to this instance.

Input	Comments	Default
Connection	The Zendesk connection to use.

Delete Post

Delete a post in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Post ID	The unique identifier for the post.

Delete Post Subscription

Delete a post subscription in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Post ID	The unique identifier for the post.
Subscription ID	The unique identifier for the subscription.

Delete Section

Delete a section in the Help Center. Deleting a section also deletes all of its articles.

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

Delete Section Subscription

Delete a section subscription in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Locale	The Help Center locale used to populate the section picker. Defaults to 'en-us'.	en-us
Section ID	The unique identifier for the section.
Subscription ID	The unique identifier for the subscription.

Delete Ticket

Delete a ticket by ID.

Input	Comments	Default
Ticket ID	The unique identifier for the ticket.
Connection	The Zendesk connection to use.

Delete Topic

Delete a topic from the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Topic ID	The unique identifier for the topic.

Delete Topic Subscription

Delete a topic subscription in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Topic ID	The unique identifier for the topic.
Subscription ID	The unique identifier for the subscription.

Delete User

Delete a user by ID.

Input	Comments	Default
User ID	The unique identifier for the user.
Connection	The Zendesk connection to use.

Delete Webhook

Delete a webhook by ID.

Input	Comments	Default
Connection	The Zendesk connection to use.
Webhook ID	The unique identifier for the webhook to delete.

Get Article

Get an article from the Help Center.

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

Get Article Attachment

Get the properties of an attachment on an article in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Locale	The Help Center locale used to populate the article picker. Defaults to 'en-us'.	en-us
Article ID	The unique identifier for the article.
Article Attachment ID	The unique identifier for the article attachment.

Get Article Subscription

Get an article subscription from the Help Center.

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

Get Category

Get a category from the Help Center.

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

Get Post

Get a post from the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Post ID	The unique identifier for the post.

Get Post Subscription

Get a post subscription from the Help Center.

Input	Comments	Default
Post ID	The unique identifier for the post.
Subscription ID	The unique identifier for the subscription.
Connection	The Zendesk connection to use.

Get Section

Get a section from the Help Center.

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

Get Section Subscription

Get a section subscription from the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Locale	The Help Center locale used to populate the section picker. Defaults to 'en-us'.	en-us
Section ID	The unique identifier for the section.
Subscription ID	The unique identifier for the subscription.

Get Ticket

Get a ticket by ID.

Input	Comments	Default
Ticket ID	The unique identifier for the ticket.
Connection	The Zendesk connection to use.

Get Ticket By External ID

Get a ticket by external ID.

Input	Comments	Default
Connection	The Zendesk connection to use.
External ID	The identifier for the ticket from an external system.

Get Topic

Get a topic from the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Topic ID	The unique identifier for the topic.

Get Topic Subscription

Get a topic subscription from the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Topic ID	The unique identifier for the topic.
Subscription ID	The unique identifier for the subscription.

Get User

Get a user by ID.

Input	Comments	Default
User ID	The unique identifier for the user.
Connection	The Zendesk connection to use.

List Article Attachments

List all attachments for an article in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Locale	The Help Center locale used to populate the article picker. Defaults to 'en-us'.	en-us
Article ID	The unique identifier for the article.
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.

List Articles

List all articles in the Help Center.

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

List Article Subscriptions

List all subscriptions for an article in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Locale	The Help Center locale used to populate the article picker. Defaults to 'en-us'.	en-us
Article ID	The unique identifier for the article.
Pagination	Cursor and page-size controls for paging through results.
Cursor	The pagination cursor from a previous request. If omitted, the first page is returned.
Page Limit	The number of results to return per page. The maximum is 100; any greater value is capped at 100.

List Categories

List all categories in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Locale	The locale code for the resource.	en-us
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.
Sort By	The field used to sort the results.
Sort Order	The direction used to order the results.

List Posts

List all posts in the Help Center.

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

List Post Subscriptions

List all post subscriptions in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Post ID	The unique identifier for the post.
Pagination	Cursor and page-size controls for paging through results.
Cursor	The pagination cursor from a previous request. If omitted, the first page is returned.
Page Limit	The number of results to return per page. The maximum is 100; any greater value is capped at 100.

List Sections

Lists all the sections in the Help Center or in a specific category.

Input	Comments	Default
Connection	The Zendesk connection to use.
Locale	The locale code for the resource.	en-us
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.
Filters	Optional query controls to sort and refine the results.
Category ID	Input a categoryId to filter out sections by the ID provided.
Sort By	The field used to sort the results.
Sort Order	The direction used to order the results.

List Section Subscriptions

List all section subscriptions in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Locale	The Help Center locale used to populate the section picker. Defaults to 'en-us'.	en-us
Section ID	The unique identifier for the section.
Pagination	Cursor and page-size controls for paging through results.
Cursor	The pagination cursor from a previous request. If omitted, the first page is returned.
Page Limit	The number of results to return per page. The maximum is 100; any greater value is capped at 100.

List Tickets

List all tickets.

Input	Comments	Default
Connection	The Zendesk connection to use.

List Tickets Assigned To User

List all of the tickets that have been assigned to a particular user.

Input	Comments	Default
User ID	The unique identifier for the user.
Connection	The Zendesk connection to use.

List Tickets Requested By User

List all of the tickets that a particular user has requested.

Input	Comments	Default
User ID	The unique identifier for the user.
Connection	The Zendesk connection to use.

List Topics

List all topics in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Fetch All	When true, automatically fetches all pages of results instead of returning a single page.	false
Pagination	Cursor and page-size controls for paging through results.
Cursor	The pagination cursor from a previous request. If omitted, the first page is returned.
Page Limit	The number of results to return per page. The maximum is 100; any greater value is capped at 100.

List Topic Subscriptions

List all topic subscriptions in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Topic ID	The unique identifier for the topic.
Pagination	Cursor and page-size controls for paging through results.
Cursor	The pagination cursor from a previous request. If omitted, the first page is returned.
Page Limit	The number of results to return per page. The maximum is 100; any greater value is capped at 100.

List Triggers

List all workflow triggers configured in Zendesk.

Input	Comments	Default
Connection	The Zendesk connection to use.

List Users

List all users.

Input	Comments	Default
Connection	The Zendesk connection to use.

List Webhooks

List all webhooks configured in Zendesk.

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

Raw Request

Send a raw HTTP request to Zendesk.

Input	Comments	Default
Connection	The Zendesk connection to use.
URL	Input the path only (/users), The base URL is already included with the configured 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.
Method	The HTTP method to use.
Data	The HTTP body payload to send to the URL.
Form Data	The Form Data to be sent as a multipart form upload.
File Data	File Data to be sent as a multipart form upload.
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
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.
Header	A list of headers to send with the request.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Timeout	The maximum time that a client will await a response to its request
Debug Request	Enabling this flag will log out the current request.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
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
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

Search Articles

Search for articles in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Search Query	The text or search string used to match results.
Locales	The locale to filter the results by.
Brand IDs	Restrict the search to articles or posts within these brands.
Category IDs	Restrict the search to articles or posts within these categories.
Filters	Optional query controls to sort and refine the results.
Section ID	The unique identifier for the section used to filter the results.
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.
Date Range Filters	Optional date filters. Narrow results by exact creation or update date, or by inclusive before and after bounds.
Created At	The exact creation date used to filter the results. Format: YYYY-MM-DD.
Created After	The lower bound used to filter results by creation date. Format: YYYY-MM-DD.
Created Before	The upper bound used to filter results by creation date. Format: YYYY-MM-DD.
Updated At	The exact update date used to filter the results. Format: YYYY-MM-DD.
Updated After	The lower bound used to filter results by update date. Format: YYYY-MM-DD.
Updated Before	The upper bound used to filter results by update date. Format: YYYY-MM-DD.
Label Names	The list of label names used to filter the results.

Search Posts

Search posts in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Search Query	The text or search string used to match results.
Filters	Optional query controls to sort and refine the results.
Topic ID	The ID of the topic to filter posts by.
Sort By	The field used to sort the results.
Sort Order	The direction used to order the results.
Date Range Filters	Optional date filters. Narrow results by exact creation or update date, or by inclusive before and after bounds.
Created At	The exact creation date used to filter the results. Format: YYYY-MM-DD.
Created After	The lower bound used to filter results by creation date. Format: YYYY-MM-DD.
Created Before	The upper bound used to filter results by creation date. Format: YYYY-MM-DD.
Updated At	The exact update date used to filter the results. Format: YYYY-MM-DD.
Updated After	The lower bound used to filter results by update date. Format: YYYY-MM-DD.
Updated Before	The upper bound used to filter results by update date. Format: YYYY-MM-DD.

Search Users

Return an array of users who meet the search criteria.

Input	Comments	Default
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.

Unified Search

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

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

Update Article

Update an existing article's metadata in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Locale	The locale code for the resource.	en-us
Article ID	The unique identifier for the article.
Assignment IDs	Write-action IDs that associate a record with related entities (sections, authors, permission groups, segments).
Section ID	The unique identifier for the section.
Author ID	The unique identifier for the author.
Permission Group ID	The unique identifier for the permission group.
User Segment ID	The unique identifier for the user segment.
Title	The headline displayed for the article.
Body	The main content of the article.
Display Options	Whether the record is promoted, its ordering position, and whether comments are disabled.
Promoted	When true, the object is highlighted at the top of its list.
Position	The numeric ordering position of the object within its list.
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.

Update Category

Update a category in the Help Center.

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

Update Post

Update a post in the Help Center.

Input	Comments	Default
Connection	The Zendesk connection to use.
Post ID	The unique identifier for the post.
Title	The headline displayed for the post.
Details	The main body content of the post.
Status	The current workflow state of the post.
Topic ID	The unique identifier for the topic.
Moderation Flags	Whether the record is featured, pinned, or 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.
Closed	When true, the post is closed to new comments.
Content Tag IDs	The list of content tag IDs to attach to the object.

Update Section

Update a section in the Help Center.

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

Update Ticket

Update a ticket by ID.

Input	Comments	Default
Ticket ID	The unique identifier for the ticket.
Ticket Comment Body	The plain text description used as the initial comment on the ticket, attributed to the assignee.
Ticket Comment HTML Body	The HTML-formatted description used as the initial comment on the ticket, attributed to the assignee.
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.
Classification	Priority, status, and type of the record.
Ticket Priority	The urgency level assigned to the ticket.
Ticket Status	The current workflow status of the ticket.
Ticket Type	The classification of the ticket.
Assignee Email	The email address of the user assigned to the ticket.
Assignee ID	The unique identifier for the user assigned to the ticket.
Tags	The list of tags to attach to the resource.
Ticket Subject	The summary line shown at the top of the ticket.
Requester Organization ID	The unique identifier for the organization the requester belongs to.
Connection	The Zendesk connection to use.

Update Topic

Update a topic in the Help Center.

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

Update User

Update a user by ID.

Input	Comments	Default
User ID	The unique identifier for the user.
Account Settings	Role, moderator permission, and verification state for the record.
User Role	The permission level granted to the user.
Moderator	When true, the user is granted moderator permissions.
Verified	When true, marks at least one of the user's identities as verified.
Name & Contact Information	Name, email, phone, and other contact channel details.
Name	The full name of the user.
Email Address	The email address for the user. Must be unique within the Zendesk domain.
Phone Number	The phone number associated with the user.
External ID	A unique identifier from another system. The API treats the ID as case sensitive — for example, "ian1" and "Ian1" are different users.
Profile Details	Alias, notes, and other descriptive attributes for the record.
Alias	The display alias shown for the user instead of the real name.
Notes	Free-form notes attached to the user record, visible to agents.
Details	Additional details attached to the user record, visible to agents.
Time Zone	The time zone the user operates in.
Organization ID	The unique identifier for the organization.
Connection	The Zendesk connection to use.