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 you to manage Users and Tickets inside your 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

If you would like 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 a 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

If you would like 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 a Prismatic instance flow, that can be triggered conditionally.

Next, you need to create a trigger that will send data via the webhook you created. Fetch your webhook's id from the step where you created the webhook, 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. We recommend keeping the default values. You can change the conditions under which the trigger fires - see the Zendesk conditions reference for details.

Connections

API Token

In order to use the API Token connection for Zendesk, you'll need to 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 your Zendesk Subdomain. You can find your subdomain inside of your 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

OAuth2 (Deprecated)

The Zendesk component authenticates requests with OAuth 2.0. To configure an application inside zendesk follow the directions in this guide Now, you will have to create a new Zendesk connection.

For Client ID enter in the unique identifier of your app inside the Zendesk admin dashboard.
For Client Secret enter the generated client secret you received from the Zendesk admin dashboard.
For Scopes refer to the guide that was linked above. There is detailed information on picking the correct scope.

You can find your subdomain inside of your 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

The Zendesk component authenticates requests with OAuth 2.0. To configure an application inside zendesk follow the directions in this guide Now, you will have to create a new Zendesk connection.

For Client ID enter in the unique identifier of your app inside the Zendesk admin dashboard.
For Client Secret enter the generated client secret you received from the Zendesk admin dashboard.
For Scopes refer to the guide that was linked above. There is detailed information on picking the correct scope.

You can find your subdomain inside of your Zendesk URL: https://YOUR-DOMAIN-HERE.zendesk.com/

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

Webhook

Receive and validate webhook requests from Zendesk for webhooks you configure. | key: webhook

Input	Notes	Example
Connection

Data Sources

Select Articles

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

Input	Notes	Example
Locale	The desired locale.	en-us
Connection

Select Categories

Select a Category from a dropdown menu | key: listCategoriesDataSource | type: picklist

Input	Notes	Example
Locale	The desired locale.	en-us
Connection

Select Management Permission Groups

Select a Management Permission Group from a dropdown menu | key: listPermissionGroupsDataSource | type: picklist

Input	Notes	Example
Connection

Select Sections

Select a Section from a dropdown menu | key: listSectionsDataSource | type: picklist

Input	Notes	Example
Locale	The desired locale.	en-us
Connection

Select Tags

Select a Tag from a dropdown menu | key: listTagsDataSource | type: picklist

Input	Notes	Example
Connection

Select User Segments

Select a User Segment from a dropdown menu | key: listUserSegmentsDataSource | type: picklist

Input	Notes	Example
Connection

Actions

Associate Attachments in Bulk to Article

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

Input	Notes	Example
Article Id	The unique identifier of the article.	123123213
Attachment Ids	Attachment IDs to be attached to the Object.
Locale	The desired locale.	en-us
Connection

{
  "data": null
}

Create Article

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

Input	Notes	Example
Body	The body of the article.	Example Body
Title	The title of the article.	Example Title
Draft	Whether the article is a draft or not.	false
Locale	The desired locale.	en-us
Notify Subscribers	Supplying a notify_subscribers with a value of false will prevent subscribers to the article from receiving an article creation email notification. This can be helpful when creating many articles at a time.	false
Permission Group Id	The unique identifier of the permission group.	15
Section Id	The unique identifier of the section.	123123213
User Segment Id	The unique identifier of the user segment.	15
Connection

{
  "data": {
    "article": {
      "author_id": 3465,
      "comments_disabled": true,
      "content_tag_ids": [
        "01GT23D51Y",
        "01GT23FWWN"
      ],
      "id": 37486578,
      "locale": "en_us",
      "permission_group_id": 123,
      "position": 42,
      "promoted": false,
      "title": "Article title",
      "user_segment_id": 12
    }
  }
}

Create Article Attachment

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

Input	Notes	Example
Article Id	The unique identifier of the article.	123123213
File	The File Attachment to upload.
File Name	The name of the file to upload	file.jpg
Inline	Whether to inline the attachment or not.	false
Connection

{
  "data": {
    "article_attachment": {
      "article_id": 23,
      "content_type": "application/jpeg",
      "content_url": "https://company.zendesk.com/hc/article_attachments/200109629/logo.jpg",
      "file_name": "logo.jpg",
      "id": 1428,
      "inline": true,
      "size": 1428
    }
  }
}

Create Article Subscription

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

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

{
  "data": {
    "subscription": {
      "content_id": 8748733,
      "id": 35467,
      "locale": "en",
      "user_id": 888887
    }
  }
}

Create Category

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

Input	Notes	Example
Category Description	The description of the category.	Example Description
Category Name	The name of the category.	Example Category
Locale	The desired locale.	en-us
Position	The position of the category to be created.	42
Connection

{
  "data": {
    "category": {
      "description": "This category contains a collection of Super Hero tricks",
      "id": 37486578,
      "locale": "en-us",
      "name": "Super Hero Tricks"
    }
  }
}

Create Post

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

Input	Notes	Example
Content Tag Ids	Content Tag IDs to be attached to the Object.
Featured	Whether the post is featured or not.	false
Pinned	Whether the post is pinned or not.	false
Notify Subscribers	Supplying a notify_subscribers with a value of false will prevent subscribers to the article from receiving an article creation email notification. This can be helpful when creating many articles at a time.	false
Details	The details of the post.
Status	The status of the post.
Title	The title of the post.	Example Title
Topic Id	The ID of the topic to create the post in.	12
Connection

{
  "data": {
    "post": {
      "author_id": 888887,
      "content_tag_ids": [
        6776,
        4545
      ],
      "featured": true,
      "id": 35467,
      "title": "Post title"
    }
  }
}

Create Post Subscription

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

Input	Notes	Example
Post Id	The unique identifier of the post.	12
UserId	The ID of the user to subscribe to the post. If none provided, the API assumes the current user.	488042375842
Connection

{
  "data": {
    "subscription": {
      "content_id": 8748733,
      "id": 35467,
      "locale": "en",
      "user_id": 888887
    }
  }
}

Create Section

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

Input	Notes	Example
Category Id	The unique identifier of the category.	12
Locale	The desired locale.	en-us
Position	The position of the section.	42
Section Description	The description of the section.	Example Description
Section Name	The name of the section.	Example Section
Connection

{
  "data": {
    "section": {
      "description": "This section contains articles on flight instruments",
      "id": 3457836,
      "locale": "en-us",
      "name": "Avionics",
      "position": 2
    }
  }
}

Create Section Subscription

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

Input	Notes	Example
Include Comments	Whether to be subscribed to comments or not.	false
Locale	The locale of the section. If not provided, the default locale is used.
Section Id	The unique identifier of the section.	123123213
UserId	The ID of the user to subscribe to the section. If none provided, the API assumes the current user.	488042375842
Connection

{
  "data": {
    "subscription": {
      "content_id": 8748733,
      "id": 35467,
      "locale": "en",
      "user_id": 888887
    }
  }
}

Create Ticket

Create a new ticket. | key: createTicket

Input	Notes	Example
Assignee Id	Provide a valid user id for the assignee of the ticket.	403598029853443232
External ID	The ID of this issue from an external system
Followers	For each item provide a unique identifier of the follower you want to add to the issue.	488042375842
Recipient Email	Provide a string value for the name of the recipient.	Jane.Doe@example.com
Requester Email	Provide a string value for the email of the requester.	John.Doe@example-email.com
Requester Name	Provide a string value for the name of the requester.	John Doe
Requester Organization Id	Provide an integer value to specify the Organization of the requester.	488042375842
Tags	For each item, provide a string value for the tag.	Engineering
Ticket Comment Body	When creating a ticket, this field can be used to give a ticket description. It will also leave a comment on the ticket from the assignee.	This is an example Comment.
Ticket Comment HTML Body	When creating a ticket, this field can be used to give a ticket description using HTML. It will also leave a comment on the ticket from the assignee.	<p>This is an example Comment.</p>
Ticket Priority	Provide a string value for the priority of the ticket.
Ticket Status	Provide a string value for the status of the ticket.
Ticket Subject	Provide a string value for the subject of the ticket	This is an example ticket subject.
Ticket Type	Provide a string value for the type of the ticket.
Connection

Create Topic

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

Input	Notes	Example
Topic Description	The description of the topic.	Example Description
Topic Name	The name of the topic.	Example Topic
Connection

{
  "data": {
    "topic": {
      "name": "How to make fish stew",
      "id": 37486578,
      "description": "A guide to making the perfect fish stew"
    }
  }
}

Create Topic Subscription

Create a new Topic subscription In The Help Center. | key: createTopicSubscription

Input	Notes	Example
Include Comments	Whether to be subscribed to comments or not.	false
Topic Id	The unique identifier of the topic.	12
UserId	The ID of the user to subscribe to the topic. If none provided, the API assumes the current user.	488042375842
Connection

{
  "data": {
    "subscription": {
      "content_id": 8748733,
      "id": 35467,
      "locale": "en",
      "user_id": 888887
    }
  }
}

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. Example: "ian1" and "Ian1" are different users
Moderator	This flag specifies whether or not the user will have moderator permissions.	false
Verified	Flip this flag to true if any of the user's identities is verified.	false
Organization Id	Provide the unique identifier of the organization.
Alias	Provide a string value that represents an alias to give to a user.	Example Alias
Details	Provide a string value that represents details to be attached to the user.	These are some example user details
Email Address	Provide a valid email address for the user. Make sure this value does not conflict with any other users in your Zendesk Domain	someone@example.com
Name	Provide a string value for the name of the user.	John Doe
Notes	Provide a string value that represents notes to be attached to the user.	These are some example notes.
Phone Number	Provide a valid phone number for the user.	15554008989
User Role	Provide which level of permissions the user is granted.
Connection

Create Webhook

Create a webhook in Zendesk to notify you of changes to your users, organization, or tickets | key: createWebhook

Input	Notes	Example
Allow Duplicates?		false
Callback URL	The URL to send data to
Events	Determines what events trigger a webhook to fire
Webhook Name	A unique name to assign this webhook
Connection

{
  "data": {
    "webhook": {
      "id": "01GK8E6BKWMJZD2T8Y5AXJQMG5",
      "name": "Test from Acme",
      "status": "active",
      "subscriptions": [
        "conditional_ticket_events"
      ],
      "created_at": "2022-12-02T03:31:00Z",
      "created_by": "7272236579355",
      "endpoint": "https://hooks.example.com/trigger/EXAMPLE",
      "http_method": "POST",
      "request_format": "json"
    }
  }
}

Create Webhook Trigger

Create a trigger to cause a webhook to fire | 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.
Connection
Webhook Message Body	The body to send to the webhook. See https://support.zendesk.com/hc/en-us/articles/4408886858138-Zendesk-Support-placeholders-reference
Trigger Name
Webhook ID		01GK7R2DBS16XB76SPDEXAMPLE

{
  "data": {
    "trigger": {
      "url": "https://example.zendesk.com/api/v2/triggers/10849292971419.json",
      "id": 10849292971419,
      "title": "Trigger for 01GK8E6BKWMJZD2TEXAMPLE",
      "active": true,
      "updated_at": "2022-12-02T03:36:44Z",
      "created_at": "2022-12-02T03:36:44Z",
      "default": false,
      "actions": [
        {
          "field": "notification_webhook",
          "value": [
            "01GK8E6BKWMJZD2TEXAMPLE",
            "{\"current_user\": \"{{current_user.details}}\"}"
          ]
        }
      ],
      "conditions": {
        "all": [],
        "any": [
          {
            "field": "status",
            "operator": "changed",
            "value": null
          },
          {
            "field": "status",
            "operator": "not_changed",
            "value": null
          }
        ]
      },
      "description": null,
      "position": 10,
      "raw_title": "01GK8E6BKWMJZD2TEXAMPLE",
      "category_id": "4558610559259"
    }
  }
}

Delete Article Attachment

Deletes an existing article attachment. | key: deleteArticleAttachment

Input	Notes	Example
Article Attachment Id	The unique identifier of the article attachment.	12
Connection

{
  "data": null
}

Delete Article Subscription

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

Input	Notes	Example
Article Id	The unique identifier of the article.	123123213
Locale	The locale of the article. If not provided, the default locale is used.
Subscription Id	The unique identifier of the subscription.	12
Connection

{
  "data": null
}

Delete Category

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

Input	Notes	Example
Category Id	The unique identifier of the category.	12
Connection

{
  "data": null
}

Delete Instance Webhooks

Delete all webhooks pointed at this instance | key: deleteInstanceWebhooks

Input	Notes	Example
Connection

Delete Post

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

Input	Notes	Example
Post Id	The unique identifier of the post.	12
Connection

{
  "data": null
}

Delete Post Subscription

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

Input	Notes	Example
Post Id	The unique identifier of the post.	12
Subscription Id	The unique identifier of the subscription.	12
Connection

{
  "data": null
}

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 desired locale.	en-us
Section Id	The unique identifier of the section.	123123213
Connection

{
  "data": null
}

Delete Section Subscription

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

Input	Notes	Example
Section Id	The unique identifier of the section.	123123213
Subscription Id	The unique identifier of the subscription.	12
Connection

{
  "data": null
}

Delete Ticket

Delete the information and metadata of a ticket by Id. | key: deleteTicket

Input	Notes	Example
Ticket Id	Provide the unique identifier for the ticket you would like to show.	ExampleTicketId
Connection

Delete Topic

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

Input	Notes	Example
Topic Id	The unique identifier of the topic.	12
Connection

{
  "data": null
}

Delete Topic Subscription

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

Input	Notes	Example
Subscription Id	The unique identifier of the subscription.	12
Topic Id	The unique identifier of the topic.	12
Connection

{
  "data": null
}

Delete User

Delete the information and metadata of a user by Id. | key: deleteUser

Input	Notes	Example
UserId	Provide an integer value for the unique identifier of the user.	488042375842
Connection

Delete Webhook

Delete a webhook by ID | key: deleteWebhook

Input	Notes	Example
Webhook ID		01GK59HW1XMB8WVZ43RPVAPXRM
Connection

Get Article

Shows the properties of the specified article in the Help Center. | key: showArticle

Input	Notes	Example
Article Id	The unique identifier of the article.	123123213
Locale	The locale of the articles to retrieve. Defaults to 'en-us'.	en-us
Connection

{
  "data": {
    "article": {
      "id": 28523513715859,
      "url": "https://sampleSubdomain.zendesk.com/api/v2/help_center/en-us/articles/28523513715859.json",
      "html_url": "https://sampleSubdomain.zendesk.com/hc/en-us/articles/28523513715859-Acme-Testing",
      "author_id": 28226296456851,
      "comments_disabled": false,
      "draft": true,
      "promoted": false,
      "position": 0,
      "vote_sum": 0,
      "vote_count": 0,
      "section_id": 28523491991699,
      "created_at": "2024-04-17T17:18:10Z",
      "updated_at": "2024-04-17T17:18:10Z",
      "name": "Acme Testing",
      "title": "Acme Testing",
      "source_locale": "en-us",
      "locale": "en-us",
      "outdated": false,
      "outdated_locales": [],
      "edited_at": "2024-04-17T17:18:10Z",
      "user_segment_id": 28523370353171,
      "permission_group_id": 28523398501139,
      "content_tag_ids": [],
      "label_names": [],
      "body": "<p>testing knowledge base</p>"
    }
  }
}

Get Article Attachment

Shows the properties of the specified attachment on an Article located in the Help Center. | key: getArticleAttachment

Input	Notes	Example
Article Attachment Id	The unique identifier of the article attachment.	12
Article Id	The unique identifier of the article.	123123213
Connection

{
  "data": {
    "article_attachment": {
      "article_id": 23,
      "content_type": "application/jpeg",
      "content_url": "https://company.zendesk.com/hc/article_attachments/200109629/logo.jpg",
      "file_name": "logo.jpg",
      "id": 1428,
      "inline": true,
      "size": 1428
    }
  }
}

Get Article Subscription

Get an Article Subscription in the Help Center. | key: getArticleSubscription

Input	Notes	Example
Article Id	The unique identifier of the article.	123123213
Locale	The locale of the article. If not provided, the default locale is used.
Subscription Id	The unique identifier of the subscription.	12
Connection

{
  "data": {
    "subscription": {
      "content_id": 8748733,
      "id": 35467,
      "locale": "en",
      "user_id": 888887
    }
  }
}

Get Category

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

Input	Notes	Example
Category Id	The unique identifier of the category.	12
Locale	The desired locale.	en-us
Connection

{
  "data": {
    "category": {
      "description": "This category contains a collection of Super Hero tricks",
      "id": 37486578,
      "locale": "en-us",
      "name": "Super Hero Tricks"
    }
  }
}

Get Post

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

Input	Notes	Example
Post Id	The unique identifier of the post.	12
Connection

{
  "data": {
    "post": {
      "author_id": 888887,
      "content_tag_ids": [
        6776,
        4545
      ],
      "featured": true,
      "id": 35467,
      "title": "Post title"
    }
  }
}

Get Post Subscription

Get a Post subscription in the Help Center. | key: getPostSubscription

Input	Notes	Example
Post Id	The unique identifier of the post.	12
Subscription Id	The unique identifier of the subscription.	12
Connection

{
  "data": {
    "subscription": {
      "content_id": 8748733,
      "id": 35467,
      "locale": "en",
      "user_id": 888887
    }
  }
}

Get Section

Retrieve a section in the Help Center. | key: getSection

Input	Notes	Example
Locale	The desired locale.	en-us
Section Id	The unique identifier of the section.	123123213
Connection

{
  "data": {
    "section": {
      "description": "This section contains articles on flight instruments",
      "id": 3457836,
      "locale": "en-us",
      "name": "Avionics",
      "position": 2
    }
  }
}

Get Section Subscription

Get a Section subscription in the Help Center. | key: getSectionSubscription

Input	Notes	Example
Section Id	The unique identifier of the section.	123123213
Subscription Id	The unique identifier of the subscription.	12
Connection

{
  "data": {
    "subscription": {
      "content_id": 8748733,
      "id": 35467,
      "locale": "en",
      "user_id": 888887
    }
  }
}

Get Ticket By External ID

Get a ticket by external ID. | key: getByExternalId

Input	Notes	Example
External ID	The ID of this issue from an external system
Connection

Get Topic

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

Input	Notes	Example
Topic Id	The unique identifier of the topic.	12
Connection

{
  "data": {
    "topic": {
      "name": "How to make fish stew",
      "id": 37486578,
      "description": "A guide to making the perfect fish stew"
    }
  }
}

Get Topic Subscription

Get a Topic subscription in the Help Center. | key: getTopicSubscription

Input	Notes	Example
Subscription Id	The unique identifier of the subscription.	12
Topic Id	The unique identifier of the topic.	12
Connection

{
  "data": {
    "subscription": {
      "content_id": 8748733,
      "id": 35467,
      "locale": "en",
      "user_id": 888887
    }
  }
}

List Article Attachments

Lists all the article's attachments in the Help Center. | key: listArticleAttachments

Input	Notes	Example
Article Id	The unique identifier of the article.	123123213
Fetch All	Whether to make the actions handle pagination and fetch all the records at once or not.	false
Page Limit	The number of results to return per page, maximum is 100. If a greater value than 100 is provided, it will default to 100.	100
Connection

{
  "data": {
    "meta": {
      "has_more": true,
      "after_cursor": "xxx",
      "before_cursor": "yyy"
    },
    "links": {
      "next": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[after]=xxx",
      "prev": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[before]=yyy"
    },
    "article_attachments": [
      {
        "article_id": 23,
        "content_type": "application/jpeg",
        "content_url": "https://company.zendesk.com/hc/article_attachments/200109629/logo.jpg",
        "file_name": "logo.jpg",
        "id": 1428,
        "inline": true,
        "size": 1428
      }
    ]
  }
}

List Article Subscriptions

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

Input	Notes	Example
Article Id	The unique identifier of the article.	123123213
Pagination Cursor	The cursor to use for pagination. If not provided, the first page will be returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Page Limit	The number of results to return per page, maximum is 100. If a greater value than 100 is provided, it will default to 100.	100
Connection

{
  "data": {
    "meta": {
      "has_more": true,
      "after_cursor": "xxx",
      "before_cursor": "yyy"
    },
    "links": {
      "next": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[after]=xxx",
      "prev": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[before]=yyy"
    },
    "subscriptions": [
      {
        "content_id": 8748733,
        "id": 35467,
        "locale": "en",
        "user_id": 888887
      }
    ]
  }
}

List Articles

Retrieve a list of all articles in the Help Center. | key: listArticles

Input	Notes	Example
Label Names	You can specify that only articles with specific labelsshould be returning by adding the label names here, Max is 10. More info: https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#label-names	examplelabel1
Pagination Cursor	The cursor to use for pagination. If not provided, the first page will be returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Fetch All	Whether to make the actions handle pagination and fetch all the records at once or not.	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, maximum is 100. If a greater value than 100 is provided, it will default to 100.	100
Sort By	The field to sort the articles by.
Sort Order	The order to sort the results by.	asc
Start Time	The start time to filter articles by.	1755185852981
Connection

{
  "data": {
    "meta": {
      "has_more": true,
      "after_cursor": "xxx",
      "before_cursor": "yyy"
    },
    "links": {
      "next": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[after]=xxx",
      "prev": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[before]=yyy"
    },
    "articles": [
      {
        "id": 28523513715859,
        "url": "https://sampleSubdomain.zendesk.com/api/v2/help_center/en-us/articles/28523513715859.json",
        "html_url": "https://sampleSubdomain.zendesk.com/hc/en-us/articles/28523513715859-Acme-Testing",
        "author_id": 28226296456851,
        "comments_disabled": false,
        "draft": true,
        "promoted": false,
        "position": 0,
        "vote_sum": 0,
        "vote_count": 0,
        "section_id": 28523491991699,
        "created_at": "2024-04-17T17:18:10Z",
        "updated_at": "2024-04-17T17:18:10Z",
        "name": "Acme Testing",
        "title": "Acme Testing",
        "source_locale": "en-us",
        "locale": "en-us",
        "outdated": false,
        "outdated_locales": [],
        "edited_at": "2024-04-17T17:18:10Z",
        "user_segment_id": 28523370353171,
        "permission_group_id": 28523398501139,
        "content_tag_ids": [],
        "label_names": [],
        "body": "<p>testing knowledge base</p>"
      }
    ]
  }
}

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

Input	Notes	Example
Fetch All	Whether to make the actions handle pagination and fetch all the records at once or not.	false
Locale	The desired locale.	en-us
Page Limit	The number of results to return per page, maximum is 100. If a greater value than 100 is provided, it will default to 100.	100
Sort By	The field to sort the results by.
Sort Order	The order to sort the results by.	asc
Connection

{
  "data": {
    "meta": {
      "has_more": true,
      "after_cursor": "xxx",
      "before_cursor": "yyy"
    },
    "links": {
      "next": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[after]=xxx",
      "prev": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[before]=yyy"
    },
    "categories": [
      {
        "description": "This category contains a collection of Super Hero tricks",
        "id": 37486578,
        "locale": "en-us",
        "name": "Super Hero Tricks"
      },
      {
        "description": "All the cool tricks!",
        "id": 354675463,
        "locale": "en-us",
        "name": "Tips & Tricks"
      }
    ]
  }
}

List Post Subscriptions

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

Input	Notes	Example
Pagination Cursor	The cursor to use for pagination. If not provided, the first page will be returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Page Limit	The number of results to return per page, maximum is 100. If a greater value than 100 is provided, it will default to 100.	100
Post Id	The unique identifier of the post.	12
Connection

{
  "data": {
    "meta": {
      "has_more": true,
      "after_cursor": "xxx",
      "before_cursor": "yyy"
    },
    "links": {
      "next": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[after]=xxx",
      "prev": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[before]=yyy"
    },
    "subscriptions": [
      {
        "content_id": 8748733,
        "id": 35467,
        "locale": "en",
        "user_id": 888887
      }
    ]
  }
}

List Posts

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

Input	Notes	Example
Pagination Cursor	The cursor to use for pagination. If not provided, the first page will be returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Fetch All	Whether to make the actions handle pagination and fetch all the records at once or not.	false
Filter By	The field to filter the results by.
Page Limit	The number of results to return per page, maximum is 100. If a greater value than 100 is provided, it will default to 100.	100
Sort By	The field to sort the results by.
Topic Id	The unique identifier of the topic.	12
Connection

{
  "data": {
    "meta": {
      "has_more": true,
      "after_cursor": "xxx",
      "before_cursor": "yyy"
    },
    "links": {
      "next": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[after]=xxx",
      "prev": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[before]=yyy"
    },
    "posts": [
      {
        "id": 35467,
        "title": "How do I open the safe"
      }
    ]
  }
}

List Section Subscriptions

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

Input	Notes	Example
Pagination Cursor	The cursor to use for pagination. If not provided, the first page will be returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Page Limit	The number of results to return per page, maximum is 100. If a greater value than 100 is provided, it will default to 100.	100
Section Id	The unique identifier of the section.	123123213
Connection

{
  "data": {
    "meta": {
      "has_more": true,
      "after_cursor": "xxx",
      "before_cursor": "yyy"
    },
    "links": {
      "next": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[after]=xxx",
      "prev": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[before]=yyy"
    },
    "subscriptions": [
      {
        "content_id": 8748733,
        "id": 35467,
        "locale": "en",
        "user_id": 888887
      }
    ]
  }
}

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	Whether to make the actions handle pagination and fetch all the records at once or not.	false
Locale	The desired locale.	en-us
Page Limit	The number of results to return per page, maximum is 100. If a greater value than 100 is provided, it will default to 100.	100
Sort By	The field to sort the results by.
Sort Order	The order to sort the results by.	asc
Connection

{
  "data": {
    "meta": {
      "has_more": true,
      "after_cursor": "xxx",
      "before_cursor": "yyy"
    },
    "links": {
      "next": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[after]=xxx",
      "prev": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[before]=yyy"
    },
    "sections": [
      {
        "category_id": 888887,
        "description": "This section contains articles on flight instruments",
        "id": 35467,
        "locale": "en-us",
        "name": "Avionics"
      },
      {
        "category_id": 887285,
        "description": "This section contains weather resources for pilots",
        "id": 36169,
        "locale": "en-us",
        "name": "Weather"
      }
    ]
  }
}

List Tickets

List all Tickets. | key: listTickets

Input	Notes	Example
Connection

{
  "data": [
    {
      "assignee_id": 235323,
      "collaborator_ids": [
        35334,
        234
      ],
      "created_at": "2009-07-20T22:55:29Z",
      "custom_fields": [
        {
          "id": 27642,
          "value": "745"
        },
        {
          "id": 27648,
          "value": "yes"
        }
      ],
      "custom_status_id": 123,
      "description": "The fire is very colorful.",
      "due_at": null,
      "external_id": "ahg35h3jh",
      "follower_ids": [
        35334,
        234
      ],
      "from_messaging_channel": false,
      "group_id": 98738,
      "has_incidents": false,
      "id": 35436,
      "organization_id": 509974,
      "priority": "high",
      "problem_id": 9873764,
      "raw_subject": "{{dc.printer_on_fire}}",
      "recipient": "support@company.com",
      "requester_id": 20978392,
      "satisfaction_rating": {
        "comment": "Great support!",
        "id": 1234,
        "score": "good"
      },
      "sharing_agreement_ids": [
        84432
      ],
      "status": "open",
      "subject": "Help, my printer is on fire!",
      "submitter_id": 76872,
      "tags": [
        "enterprise",
        "other_tag"
      ],
      "type": "incident",
      "updated_at": "2011-05-05T10:38:52Z",
      "url": "https://company.zendesk.com/api/v2/tickets/35436.json",
      "via": {
        "channel": "web"
      }
    }
  ]
}

List Tickets Assigned To User

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

Input	Notes	Example
UserId	Provide an integer value for the unique identifier of the user.	488042375842
Connection

{
  "data": [
    {
      "assignee_id": 235323,
      "collaborator_ids": [
        35334,
        234
      ],
      "created_at": "2009-07-20T22:55:29Z",
      "custom_fields": [
        {
          "id": 27642,
          "value": "745"
        },
        {
          "id": 27648,
          "value": "yes"
        }
      ],
      "custom_status_id": 123,
      "description": "The fire is very colorful.",
      "due_at": null,
      "external_id": "ahg35h3jh",
      "follower_ids": [
        35334,
        234
      ],
      "from_messaging_channel": false,
      "group_id": 98738,
      "has_incidents": false,
      "id": 35436,
      "organization_id": 509974,
      "priority": "high",
      "problem_id": 9873764,
      "raw_subject": "{{dc.printer_on_fire}}",
      "recipient": "support@company.com",
      "requester_id": 20978392,
      "satisfaction_rating": {
        "comment": "Great support!",
        "id": 1234,
        "score": "good"
      },
      "sharing_agreement_ids": [
        84432
      ],
      "status": "open",
      "subject": "Help, my printer is on fire!",
      "submitter_id": 76872,
      "tags": [
        "enterprise",
        "other_tag"
      ],
      "type": "incident",
      "updated_at": "2011-05-05T10:38:52Z",
      "url": "https://company.zendesk.com/api/v2/tickets/35436.json",
      "via": {
        "channel": "web"
      }
    }
  ]
}

List Tickets Requested By User

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

Input	Notes	Example
UserId	Provide an integer value for the unique identifier of the user.	488042375842
Connection

{
  "data": [
    {
      "assignee_id": 235323,
      "collaborator_ids": [
        35334,
        234
      ],
      "created_at": "2009-07-20T22:55:29Z",
      "custom_fields": [
        {
          "id": 27642,
          "value": "745"
        },
        {
          "id": 27648,
          "value": "yes"
        }
      ],
      "custom_status_id": 123,
      "description": "The fire is very colorful.",
      "due_at": null,
      "external_id": "ahg35h3jh",
      "follower_ids": [
        35334,
        234
      ],
      "from_messaging_channel": false,
      "group_id": 98738,
      "has_incidents": false,
      "id": 35436,
      "organization_id": 509974,
      "priority": "high",
      "problem_id": 9873764,
      "raw_subject": "{{dc.printer_on_fire}}",
      "recipient": "support@company.com",
      "requester_id": 20978392,
      "satisfaction_rating": {
        "comment": "Great support!",
        "id": 1234,
        "score": "good"
      },
      "sharing_agreement_ids": [
        84432
      ],
      "status": "open",
      "subject": "Help, my printer is on fire!",
      "submitter_id": 76872,
      "tags": [
        "enterprise",
        "other_tag"
      ],
      "type": "incident",
      "updated_at": "2011-05-05T10:38:52Z",
      "url": "https://company.zendesk.com/api/v2/tickets/35436.json",
      "via": {
        "channel": "web"
      }
    }
  ]
}

List Topic Subscriptions

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

Input	Notes	Example
Pagination Cursor	The cursor to use for pagination. If not provided, the first page will be returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Page Limit	The number of results to return per page, maximum is 100. If a greater value than 100 is provided, it will default to 100.	100
Topic Id	The unique identifier of the topic.	12
Connection

{
  "data": {
    "meta": {
      "has_more": true,
      "after_cursor": "xxx",
      "before_cursor": "yyy"
    },
    "links": {
      "next": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[after]=xxx",
      "prev": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[before]=yyy"
    },
    "subscriptions": [
      {
        "content_id": 8748733,
        "id": 35467,
        "locale": "en",
        "user_id": 888887
      }
    ]
  }
}

List Topics

Retrieve a list of topics from the Help Center. | key: listTopics

Input	Notes	Example
Pagination Cursor	The cursor to use for pagination. If not provided, the first page will be returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Fetch All	Whether to make the actions handle pagination and fetch all the records at once or not.	false
Page Limit	The number of results to return per page, maximum is 100. If a greater value than 100 is provided, it will default to 100.	100
Connection

{
  "data": {
    "meta": {
      "has_more": true,
      "after_cursor": "xxx",
      "before_cursor": "yyy"
    },
    "links": {
      "next": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[after]=xxx",
      "prev": "https://example.zendesk.com/api/v2/tickets.json?page[size]=100&page[before]=yyy"
    },
    "topics": [
      {
        "html_url": "https://{subdomain}.zendesk.com/hc/en-us/community/topics/10-Using-Help-Center-Tips-Tricks",
        "id": 10,
        "name": "Using Help Center - Tips & Tricks",
        "url": "https://{subdomain}.zendesk.com/api/v2/community/topics/10.json"
      },
      {
        "html_url": "https://{subdomain}.zendesk.com/hc/en-us/community/topics/11-Using-Help-Center-Getting-Started-Guide",
        "id": 11,
        "name": "Using Help Center - Getting Started Guide",
        "url": "https://{subdomain}.zendesk.com/api/v2/community/topics/11.json"
      }
    ]
  }
}

List Triggers

List workflow triggers | key: listTriggers

Input	Notes	Example
Connection

List Users

List all Users. | key: listUsers

Input	Notes	Example
Connection

{
  "data": [
    {
      "id": 223443,
      "name": "Johnny Agent"
    },
    {
      "id": 8678530,
      "name": "James A. Rosen"
    }
  ]
}

List Webhooks

List webhooks configured in Zendesk | key: listWebhooks

Input	Notes	Example
Show only instance webhooks	Show only webhooks that point to this instance	true
Connection

Raw Request

Send raw HTTP request to Zendesk | key: rawRequest

Input	Notes	Example
Connection
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 you to interact with API endpoints that are not covered by other actions. For example, if you want to list groups, which as an endpoint of /api/v2/groups, you can enter /groups as the endpoint and select the GET verb.

Search Articles

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

Input	Notes	Example
Brand Ids	Limit the search to articles or post within these brand.	63
Category Ids	Limit the search to articles or post within these categories.	63
Created After	The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Created At	The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Created Before	The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Label Names	The label names to filter the results by.	examplelabel1
Locales	The locale to filter the results by.	en-us
Section Id	The unique identifier of the section to filter the results for.	12
Updated After	The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Updated At	The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Updated Before	The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Search Query	The search text to be matched or a search string.	carrot
Multibrand	Whether to filter the results by multibrand or not.	false
Sort By	The field to sort the results by.
Sort Order	The order to sort the results by.	asc
Connection

Search Posts

Search posts in the Help Center. | key: searchPosts

Input	Notes	Example
Created After	The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Created At	The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Created Before	The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Updated After	The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Updated At	The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Updated Before	The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Search Query	The search text to be matched or a search string.	carrot
Sort By	The field to sort the results by.
Sort Order	The order to sort the results by.	asc
Topic Id	The ID of the topic to filter posts by.	12
Connection

Search Users

Returns 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 query parameter supports the Zendesk search syntax for more advanced user searches. It can specify a partial or full value of any user property, including name, email address, notes, or phone. Example: query="jdoe".
Connection

{
  "data": [
    {
      "id": 35436,
      "name": "Robert Jones",
      "notes": "sigil issue"
    },
    {
      "id": 9873843,
      "name": "Terry Gilliam"
    }
  ]
}

Show Ticket

Get the information and metadata of a ticket by Id. | key: showTicket

Input	Notes	Example
Ticket Id	Provide the unique identifier for the ticket you would like to show.	ExampleTicketId
Connection

Show User

Get the information and metadata of a user by Id. | key: showUser

Input	Notes	Example
UserId	Provide an integer value for the unique identifier of the user.	488042375842
Connection

Unified Search

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

Input	Notes	Example
Brand Ids	Limit the search to articles or post within these brand.	63
Category Ids	Limit the search to articles or post within these categories.	63
Content Types	Limit the search to one of these content types: ARTICLE, POST
Pagination Cursor	The cursor to use for pagination. If not provided, the first page will be returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
External Source Ids	Use this parameter to scope the result of your search to a specifiedexternal source or external sources.	63
Locales	Limit the search to articles or post within these locales.	en-us
Page Limit	The number of results to return per page, maximum is 100. If a greater value than 100 is provided, it will default to 100.	100
Search Query	The search text to be matched or a search string.	carrot
Section Ids	Limit the search to articles or post within these sections.	63
Topic Ids	Limit the search to posts within these topics.	63
Connection

Update Article

Update an existing Article's Metadata in the Help Center. | key: updateArticle

Input	Notes	Example
Body	The body of the article.	Example Body
Article Id	The unique identifier of the article.	123123213
Title	The title of the article.	Example Title
Author Id	The unique identifier of the author.	12
Comments Disabled	Whether comments are disabled or not.
Content Tag Ids	Content Tag IDs to be attached to the Object.
Label Names	Label Names to be attached to the Object.
Locale	The desired locale.	en-us
Permission Group Id	The unique identifier of the permission group.	15
Position	The position of the object.	42
Promoted	Whether the object should be promoted or not.
Section Id	The unique identifier of the section.	123123213
User Segment Id	The unique identifier of the user segment.	15
Connection

{
  "data": {
    "article": {
      "author_id": 3465,
      "comments_disabled": true,
      "content_tag_ids": [
        "01GT23D51Y",
        "01GT23FWWN"
      ],
      "id": 37486578,
      "locale": "en_us",
      "permission_group_id": 123,
      "position": 42,
      "promoted": false,
      "title": "Article title",
      "user_segment_id": 12
    }
  }
}

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 of 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

{
  "data": {
    "category": {
      "description": "This category contains a collection of Super Hero tricks",
      "id": 37486578,
      "locale": "en-us",
      "name": "Super Hero Tricks"
    }
  }
}

Update Post

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

Input	Notes	Example
Content Tag Ids	Content Tag IDs to be attached to the Object.
Closed	Whether the post is closed or not.
Featured	Whether the post is featured or not.
Pinned	Whether the post is pinned or not.
Details	The details of the post.
Post Id	The unique identifier of the post.	12
Status	The status of the post.
Title	The title of the post.	Example Title
Topic Id	The unique identifier of the topic.	12
Connection

{
  "data": {
    "post": {
      "author_id": 888887,
      "content_tag_ids": [
        6776,
        4545
      ],
      "featured": true,
      "id": 35467,
      "title": "Post title"
    }
  }
}

Update Section

Update section in the Help Center. | key: updateSection

Input	Notes	Example
Category Id	Category ID of the Section to update.	12
Locale	The desired locale.	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 of the section.	123123213
Section Name	Name of the Section to update.	Example Section
Connection

{
  "data": {
    "section": {
      "description": "This section contains articles on flight instruments",
      "id": 3457836,
      "locale": "en-us",
      "name": "Avionics",
      "position": 2
    }
  }
}

Update Ticket

Update the information and metadata of a ticket by Id. | key: updateTicket

Input	Notes	Example
Assignee Email	Provide a valid email for the assignee of the ticket.	Jane.Doe@example.com
Assignee Id	Provide a valid user id for the assignee of the ticket.	403598029853443232
File	The file to attach to the comment - either string contents or a binary file
File Name	The name of the file to upload
Requester Organization Id	Provide an integer value to specify the Organization of the requester.	488042375842
Tags	For each item, provide a string value for the tag.	Engineering
Ticket Comment Body	When creating a ticket, this field can be used to give a ticket description. It will also leave a comment on the ticket from the assignee.	This is an example Comment.
Ticket Comment HTML Body	When creating a ticket, this field can be used to give a ticket description using HTML. It will also leave a comment on the ticket from the assignee.	<p>This is an example Comment.</p>
Ticket Id	Provide the unique identifier for the ticket you would like to show.	ExampleTicketId
Ticket Priority	Provide a string value for the priority of the ticket.
Ticket Status	Provide a string value for the status of the ticket.
Ticket Subject	Provide a string value for the subject of the ticket	This is an example ticket subject.
Ticket Type	Provide a string value for the type of the ticket.
Connection

Update Topic

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

Input	Notes	Example
Manageable By	The user segments that can manage the topic.
Position	The position of the topic in the list of topics.	42
Topic Description	The description of the topic.	Example Description
Topic Id	The unique identifier of the topic.	12
Topic Name	The name of the topic.	Example Topic
User Segment Id	The user segment ID to associate with the topic.	15
Connection

{
  "data": {
    "topic": {
      "name": "How to make fish stew",
      "id": 37486578,
      "description": "A guide to making the perfect fish stew"
    }
  }
}

Update User

Update the information and metadata of 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. Example: "ian1" and "Ian1" are different users
Moderator	This flag specifies whether or not the user will have moderator permissions.
Verified	Flip this flag to true if any of the user's identities is verified.
Organization Id	Provide the unique identifier of the organization.
Alias	Provide a string value that represents an alias to give to a user.	Example Alias
Details	Provide a string value that represents details to be attached to the user.	These are some example user details
Email Address	Provide a valid email address for the user. Make sure this value does not conflict with any other users in your Zendesk Domain	someone@example.com
UserId	Provide an integer value for the unique identifier of the user.	488042375842
Name	Provide a string value for the name of the user.	John Doe
Notes	Provide a string value that represents notes to be attached to the user.	These are some example notes.
Phone Number	Provide a valid phone number for the user.	15554008989
User Role	Provide which level of permissions the user is granted.
Time Zone	Provide a valid timezone that the user operates in.	Berlin
Connection

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

Changelog

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​

OAuth2 (Deprecated)​

OAuth 2.0​

Triggers​

Webhook​

Data Sources​

Select Articles​

Select Categories​

Select Management Permission Groups​

Select Sections​

Select Tags​

Select User Segments​

Actions​

Associate Attachments in Bulk 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 By External ID​

Get Topic​

Get Topic Subscription​

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​

List Tickets Requested By User​

List Topic Subscriptions​

List Topics​

List Triggers​

List Users​

List Webhooks​

Raw Request​

Search Articles​

Search Posts​

Search Users​

Show Ticket​

Show User​