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

Zendesk Connection

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 in Prismatic.

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 SUBDOMAIN HERE}.zendesk.com/

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

Triggers

Webhook

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

Input	Notes
Connection connection / Required connection

Data Sources

List Articles

A picklist of Articles | key: listArticlesDataSource | type: picklist

Input	Default	Notes
Locale string / Required locale	en-us	The desired locale.
Connection connection / Required zendeskConnection

A picklist of Categories | key: listCategoriesDataSource | type: picklist

Input	Default	Notes
Locale string / Required locale	en-us	The desired locale.
Connection connection / Required zendeskConnection

List Sections

A picklist of Sections | key: listSectionsDataSource | type: picklist

Input	Default	Notes
Locale string / Required locale	en-us	The desired locale.
Connection connection / Required zendeskConnection

A picklist of Tags | key: listTagsDataSource | type: picklist

Input	Notes
Connection connection / Required zendeskConnection

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	Default	Notes	Example
Article Id string / Required articleId		The unique identifier of the article.	123123213
Attachment Ids string / Required Value List attachmentIds		Attachment IDs to be attached to the Object.
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Locale string / Required locale	en-us	The desired locale.
Connection connection / Required zendeskConnection

Example Payload for Associate Attachments in Bulk to Article

{
  "data": null
}

Create Article

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

Input	Default	Notes	Example
Body string articleBody		The body of the article.	Example Body
Title string / Required articleTitle		The title of the article.	Example Title
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Draft boolean isDraft		Whether the article is a draft or not.
Locale string / Required locale	en-us	The desired locale.
Notify Subscribers boolean notifySubscribers		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.
Permission Group Id string / Required permissionGroupId		The unique identifier of the permission group.	15
Section Id string / Required sectionId		The unique identifier of the section.	123123213
User Segment Id string / Required userSegmentId		The unique identifier of the user segment.	15
Connection connection / Required zendeskConnection

Example Payload for Create Article

{
  "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	Default	Notes	Example
Article Id string / Required articleId		The unique identifier of the article.	123123213
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
File data / Required file		The File Attachment to upload.
File Name string fileName		The name of the file to upload	file.jpg
Inline boolean inline		Whether to inline the attachment or not.
Connection connection / Required zendeskConnection

Example Payload for Create Article Attachment

{
  "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	Default	Notes	Example
Article Id string / Required articleId		The unique identifier of the article.	123123213
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Locale string locale		The locale of the article. If not provided, the default locale is used.
UserId string userId		The ID of the user to subscribe to the section. If none provided, the API assumes the current user.	488042375842
Connection connection / Required zendeskConnection

Example Payload for Create Article Subscription

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

Create Category

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

Input	Default	Notes	Example
Category Description string categoryDescription		The description of the category.	Example Description
Category Name string categoryName		The name of the category.	Example Category
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Locale string / Required locale	en-us	The desired locale.
Position string position		The position of the category to be created.	42
Connection connection / Required zendeskConnection

Example Payload for Create Category

{
  "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	Default	Notes	Example
Content Tag Ids string Value List contentTagIds		Content Tag IDs to be attached to the Object.
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Featured boolean isPostFeatured		Whether the post is featured or not.
Pinned boolean isPostPinned		Whether the post is pinned or not.
Notify Subscribers boolean notifySubscribers		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.
Details string postDetails		The details of the post.
Status string postStatus		The status of the post.
Title string / Required postTitle		The title of the post.	Example Title
Topic Id string topicId		The ID of the topic to create the post in.	12
Connection connection / Required zendeskConnection

Example Payload for Create Post

{
  "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	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Post Id string / Required postId		The unique identifier of the post.	12
UserId string userId		The ID of the user to subscribe to the post. If none provided, the API assumes the current user.	488042375842
Connection connection / Required zendeskConnection

Example Payload for Create Post Subscription

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

Create Section

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

Input	Default	Notes	Example
Category Id string / Required categoryId		The unique identifier of the category.	12
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Locale string / Required locale	en-us	The desired locale.
Position string position		The position of the section.	42
Section Description string sectionDescription		The description of the section.	Example Description
Section Name string / Required sectionName		The name of the section.	Example Section
Connection connection / Required zendeskConnection

Example Payload for Create Section

{
  "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	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Include Comments boolean includeComments		Whether to be subscribed to comments or not.
Locale string locale		The locale of the section. If not provided, the default locale is used.
Section Id string / Required sectionId		The unique identifier of the section.	123123213
UserId string userId		The ID of the user to subscribe to the section. If none provided, the API assumes the current user.	488042375842
Connection connection / Required zendeskConnection

Example Payload for Create Section Subscription

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

Create Ticket

Create a new ticket | key: createTicket

Input	Default	Notes	Example
Assignee Id string assigneeId		Provide a valid user id for the assignee of the ticket.	403598029853443232
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
External ID string externalId		The ID of this issue from an external system
Followers string Value List followers		For each item provide a unique identifier of the follower you want to add to the issue.	488042375842
Recipient Email string recipientEmail		Provide a string value for the name of the recipient.	Jane.Doe@example-prismatic.io
Requester Email string / Required requesterEmail		Provide a string value for the email of the requester.	John.Doe@example-email.com
Requester Name string / Required requesterName		provide a string value for the name of the requester.	John Doe
Requester Organization Id string requesterOrganization		Provide an integer value to specify the Organization of the requester.	488042375842
Tags string Value List tags		For each item, provide a string value for the tag.	Engineering
Ticket Comment Body string ticketComment		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 string ticketCommentHTML		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 string ticketPriority		Provide a string value for the priority of the ticket.
Ticket Status string ticketStatus		Provide a string value for the status of the ticket.
Ticket Subject string ticketSubject		Provide a string value for the subject of the ticket	This is an example ticket subject.
Ticket Type string ticketType		Provide a string value for the type of the ticket.
Connection connection / Required zendeskConnection

Create Topic

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

Input	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Topic Description string topicDescription		The description of the topic.	Example Description
Topic Name string / Required topicName		The name of the topic.	Example Topic
Connection connection / Required zendeskConnection

Example Payload for Create Topic

{
  "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	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Include Comments boolean includeComments		Whether to be subscribed to comments or not.
Topic Id string / Required topicId		The unique identifier of the topic.	12
UserId string userId		The ID of the user to subscribe to the topic. If none provided, the API assumes the current user.	488042375842
Connection connection / Required zendeskConnection

Example Payload for Create Topic Subscription

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

Create User

Create a new user | key: createUser

Input	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
External Id string externalId		A unique identifier from another system. The API treats the id as case sensitive. Example: "ian1" and "Ian1" are different users
Moderator boolean isModerator	false	This flag specifies whether or not the user will have moderator permissions.
Verified boolean isVerified	false	Flip this flag to true if any of the user's identities is verified.
Organization Id string organizationId		Provide the unique identifier of the organization.
Alias string userAlias		Provide a string value that represents an alias to give to a user.	Example Alias
Details string userDetails		Provide a string value that represents details to be attached to the user.	These are some example user details
Email Address string / Required userEmail		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-prismatic.io
Name string / Required userName		Provide a string value for the name of the user.	John Doe
Notes string userNotes		Provide a string value that represents notes to be attached to the user.	These are some example notes.
Phone Number string userPhone		Provide a valid phone number for the user.	15554008989
User Role string userRole		Provide which level of permissions the user is granted.
Connection connection / Required zendeskConnection

Create Webhook

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

Input	Default	Notes
Allow Duplicates? boolean / Required allowDuplicates	false
Callback URL string / Required callbackUrl		The URL to send data to
Events string / Required Value List events		Determines what events trigger a webhook to fire
Webhook Name string / Required name		A unique name to assign this webhook
Connection connection / Required zendeskConnection

Example Payload for Create Webhook

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

Create Webhook Trigger

Create a trigger to cause a webhook to fire | key: createWebhookTrigger

Input	Default	Notes	Example
Allow Duplicates? boolean / Required allowDuplicates	false	Allow a duplicate trigger with the same title to be created?
Trigger Conditions code / Required conditions		The conditions under which this trigger will fire. Leave the default to fire under any change.
Connection connection / Required connection
Webhook Message Body code / Required messageBody		The body to send to the webhook. See https://support.zendesk.com/hc/en-us/articles/4408886858138-Zendesk-Support-placeholders-reference
Trigger Name string / Required title
Webhook ID string / Required webhookId			01GK7R2DBS16XB76SPDEXAMPLE

Example Payload for Create Webhook Trigger

{
  "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	Default	Notes	Example
Article Attachment Id string / Required articleAttachmentId		The unique identifier of the article attachment.	12
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Connection connection / Required zendeskConnection

Example Payload for Delete Article Attachment

{
  "data": null
}

Delete Article Subscription

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

Input	Default	Notes	Example
Article Id string / Required articleId		The unique identifier of the article.	123123213
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Locale string locale		The locale of the article. If not provided, the default locale is used.
Subscription Id string / Required subscriptionId		The unique identifier of the subscription.	12
Connection connection / Required zendeskConnection

Example Payload for Delete Article Subscription

{
  "data": null
}

Delete Category

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

Input	Default	Notes	Example
Category Id string / Required categoryId		The unique identifier of the category.	12
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Connection connection / Required zendeskConnection

Example Payload for Delete Category

{
  "data": null
}

Delete Instance Webhooks

Delete all webhooks pointed at this instance | key: deleteInstanceWebhooks

Input	Notes
Connection connection / Required zendeskConnection

Delete Post

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

Input	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Post Id string / Required postId		The unique identifier of the post.	12
Connection connection / Required zendeskConnection

Example Payload for Delete Post

{
  "data": null
}

Delete Post Subscription

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

Input	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Post Id string / Required postId		The unique identifier of the post.	12
Subscription Id string / Required subscriptionId		The unique identifier of the subscription.	12
Connection connection / Required zendeskConnection

Example Payload for Delete Post Subscription

{
  "data": null
}

Delete Section

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

Input	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Locale string / Required locale	en-us	The desired locale.
Section Id string / Required sectionId		The unique identifier of the section.	123123213
Connection connection / Required zendeskConnection

Example Payload for Delete Section

{
  "data": null
}

Delete Section Subscription

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

Input	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Section Id string / Required sectionId		The unique identifier of the section.	123123213
Subscription Id string / Required subscriptionId		The unique identifier of the subscription.	12
Connection connection / Required zendeskConnection

Example Payload for Delete Section Subscription

{
  "data": null
}

Delete Ticket

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

Input	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Ticket Id string / Required ticketId		Provide the unique identifier for the ticket you would like to show.	ExampleTicketId
Connection connection / Required zendeskConnection

Delete Topic

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

Input	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Topic Id string / Required topicId		The unique identifier of the topic.	12
Connection connection / Required zendeskConnection

Example Payload for Delete Topic

{
  "data": null
}

Delete Topic Subscription

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

Input	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Subscription Id string / Required subscriptionId		The unique identifier of the subscription.	12
Topic Id string / Required topicId		The unique identifier of the topic.	12
Connection connection / Required zendeskConnection

Example Payload for Delete Topic Subscription

{
  "data": null
}

Delete User

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

Input	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
UserId string userId		Provide an integer value for the unique identifier of the user.	488042375842
Connection connection / Required zendeskConnection

Delete Webhook

Delete a webhook by ID | key: deleteWebhook

Input	Notes	Example
Webhook ID string / Required webhookId		01GK59HW1XMB8WVZ43RPVAPXRM
Connection connection / Required zendeskConnection

Get Article

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

Input	Default	Notes	Example
Article Id string / Required articleId		The unique identifier of the article.	123123213
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Locale string / Required locale	en-us	The locale of the articles to retrieve. Defaults to 'en-us'.
Connection connection / Required zendeskConnection

Example Payload for Get Article

{
  "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-Prismatic-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": "Prismatic Testing",
      "title": "Prismatic 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	Default	Notes	Example
Article Attachment Id string / Required articleAttachmentId		The unique identifier of the article attachment.	12
Article Id string / Required articleId		The unique identifier of the article.	123123213
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Connection connection / Required zendeskConnection

Example Payload for Get Article Attachment

{
  "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	Default	Notes	Example
Article Id string / Required articleId		The unique identifier of the article.	123123213
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Locale string locale		The locale of the article. If not provided, the default locale is used.
Subscription Id string / Required subscriptionId		The unique identifier of the subscription.	12
Connection connection / Required zendeskConnection

Example Payload for Get Article Subscription

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

Get Category

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

Input	Default	Notes	Example
Category Id string / Required categoryId		The unique identifier of the category.	12
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Locale string / Required locale	en-us	The desired locale.
Connection connection / Required zendeskConnection

Example Payload for Get Category

{
  "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	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Post Id string / Required postId		The unique identifier of the post.	12
Connection connection / Required zendeskConnection

Example Payload for Get Post

{
  "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	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Post Id string / Required postId		The unique identifier of the post.	12
Subscription Id string / Required subscriptionId		The unique identifier of the subscription.	12
Connection connection / Required zendeskConnection

Example Payload for Get Post Subscription

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

Get Section

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

Input	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Locale string / Required locale	en-us	The desired locale.
Section Id string / Required sectionId		The unique identifier of the section.	123123213
Connection connection / Required zendeskConnection

Example Payload for Get Section

{
  "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	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Section Id string / Required sectionId		The unique identifier of the section.	123123213
Subscription Id string / Required subscriptionId		The unique identifier of the subscription.	12
Connection connection / Required zendeskConnection

Example Payload for Get Section Subscription

{
  "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	Default	Notes
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
External ID string externalId		The ID of this issue from an external system
Connection connection / Required zendeskConnection

Get Topic

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

Input	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Topic Id string / Required topicId		The unique identifier of the topic.	12
Connection connection / Required zendeskConnection

Example Payload for Get Topic

{
  "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	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Subscription Id string / Required subscriptionId		The unique identifier of the subscription.	12
Topic Id string / Required topicId		The unique identifier of the topic.	12
Connection connection / Required zendeskConnection

Example Payload for Get Topic Subscription

{
  "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	Default	Notes	Example
Article Id string / Required articleId		The unique identifier of the article.	123123213
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Fetch All boolean fetchAll		Whether to make the actions handle pagination and fetch all the records at once or not.
Page Limit string pageLimit		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 connection / Required zendeskConnection

Example Payload for List Article Attachments

{
  "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	Default	Notes	Example
Article Id string / Required articleId		The unique identifier of the article.	123123213
Pagination Cursor string cursor		The cursor to use for pagination. If not provided, the first page will be returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Page Limit string pageLimit		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 connection / Required zendeskConnection

Example Payload for List Article Subscriptions

{
  "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	Default	Notes	Example
Label Names string Value List articleLabels		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 string cursor		The cursor to use for pagination. If not provided, the first page will be returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Fetch All boolean fetchAll		Whether to make the actions handle pagination and fetch all the records at once or not.
Locale string / Required locale	en-us	The locale of the articles to retrieve. Defaults to 'en-us'.
Page Limit string pageLimit		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 string sortBy		The field to sort the articles by.
Sort Order string sortOrder		The order to sort the results by.	asc
Start Time string startTime		The start time to filter articles by.	1731084643767
Connection connection / Required zendeskConnection

Example Payload for List Articles

{
  "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-Prismatic-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": "Prismatic Testing",
        "title": "Prismatic 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	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Fetch All boolean fetchAll		Whether to make the actions handle pagination and fetch all the records at once or not.
Locale string / Required locale	en-us	The desired locale.
Page Limit string pageLimit		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 string sortBy		The field to sort the results by.
Sort Order string sortOrder		The order to sort the results by.	asc
Connection connection / Required zendeskConnection

Example Payload for List Categories

{
  "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	Default	Notes	Example
Pagination Cursor string cursor		The cursor to use for pagination. If not provided, the first page will be returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Page Limit string pageLimit		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 string / Required postId		The unique identifier of the post.	12
Connection connection / Required zendeskConnection

Example Payload for List Post Subscriptions

{
  "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	Default	Notes	Example
Pagination Cursor string cursor		The cursor to use for pagination. If not provided, the first page will be returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Fetch All boolean fetchAll		Whether to make the actions handle pagination and fetch all the records at once or not.
Filter By string / Required filterBy		The field to filter the results by.
Page Limit string pageLimit		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 string sortBy		The field to sort the results by.
Topic Id string topicId		The unique identifier of the topic.	12
Connection connection / Required zendeskConnection

Example Payload for List Posts

{
  "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	Default	Notes	Example
Pagination Cursor string cursor		The cursor to use for pagination. If not provided, the first page will be returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Page Limit string pageLimit		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 string / Required sectionId		The unique identifier of the section.	123123213
Connection connection / Required zendeskConnection

Example Payload for List Section Subscriptions

{
  "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	Default	Notes	Example
Category Id string categoryId		Input a categoryId to filter out sections by the ID provided.	12
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Fetch All boolean fetchAll		Whether to make the actions handle pagination and fetch all the records at once or not.
Locale string / Required locale	en-us	The desired locale.
Page Limit string pageLimit		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 string sortBy		The field to sort the results by.
Sort Order string sortOrder		The order to sort the results by.	asc
Connection connection / Required zendeskConnection

Example Payload for List Sections

{
  "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	Default	Notes
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Connection connection / Required zendeskConnection

Example Payload for List Tickets

{
  "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	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
UserId string userId		Provide an integer value for the unique identifier of the user.	488042375842
Connection connection / Required zendeskConnection

Example Payload for List Tickets Assigned To User

{
  "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	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
UserId string userId		Provide an integer value for the unique identifier of the user.	488042375842
Connection connection / Required zendeskConnection

Example Payload for List Tickets Requested By User

{
  "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	Default	Notes	Example
Pagination Cursor string cursor		The cursor to use for pagination. If not provided, the first page will be returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Page Limit string pageLimit		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 string / Required topicId		The unique identifier of the topic.	12
Connection connection / Required zendeskConnection

Example Payload for List Topic Subscriptions

{
  "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	Default	Notes	Example
Pagination Cursor string cursor		The cursor to use for pagination. If not provided, the first page will be returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Fetch All boolean fetchAll		Whether to make the actions handle pagination and fetch all the records at once or not.
Page Limit string pageLimit		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 connection / Required zendeskConnection

Example Payload for List Topics

{
  "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
Connection connection / Required connection

List Users

List all Users | key: listUsers

Input	Default	Notes
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Connection connection / Required zendeskConnection

Example Payload for List Users

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

List Webhooks

List webhooks configured in Zendesk | key: listWebhooks

Input	Default	Notes
Show only instance webhooks boolean showOnlyInstanceWebhooks	true	Show only webhooks that point to this instance
Connection connection / Required zendeskConnection

Raw Request

Send raw HTTP request to Zendesk | key: rawRequest

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		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 string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required 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 boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries.

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	Default	Notes	Example
Brand Ids string Value List brandIds		Limit the search to articles or post within these brand.	63
Category Ids string Value List categoryIds		Limit the search to articles or post within these categories.	63
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Created After string filterCreatedAfter		The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Created At string filterCreatedAt		The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Created Before string filterCreatedBefore		The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Label Names string Value List filterLabelNames		The label names to filter the results by.	examplelabel1
Locales string Value List filterLocale		The locale to filter the results by.	en-us
Section Id string filterSectionId		The unique identifier of the section to filter the results for.	12
Updated After string filterUpdatedAfter		The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Updated At string filterUpdatedAt		The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Updated Before string filterUpdatedBefore		The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Search Query string / Required searchQuery		The search text to be matched or a search string.	carrot
Multibrand boolean shouldFilterMultibrand	false	Whether to filter the results by multibrand or not.
Sort By string sortBy		The field to sort the results by.
Sort Order string sortOrder		The order to sort the results by.	asc
Connection connection / Required zendeskConnection

Search Posts

Search posts in the Help Center. | key: searchPosts

Input	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Created After string filterCreatedAfter		The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Created At string filterCreatedAt		The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Created Before string filterCreatedBefore		The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Updated After string filterUpdatedAfter		The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Updated At string filterUpdatedAt		The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Updated Before string filterUpdatedBefore		The time to filter the results by. (Format: YYYY-MM-DD)	2024-05-01
Search Query string / Required searchQuery		The search text to be matched or a search string.	carrot
Sort By string sortBy		The field to sort the results by.
Sort Order string sortOrder		The order to sort the results by.	asc
Topic Id string topicId		The ID of the topic to filter posts by.	12
Connection connection / Required zendeskConnection

Search Users

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

Input	Default	Notes
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
External Id string externalId		The external_id parameter does not support the search syntax. It only accepts ids.
Query string 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 connection / Required zendeskConnection

Example Payload for Search Users

{
  "data": {
    "users": [
      {
        "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	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Ticket Id string / Required ticketId		Provide the unique identifier for the ticket you would like to show.	ExampleTicketId
Connection connection / Required zendeskConnection

Show User

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

Input	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
UserId string userId		Provide an integer value for the unique identifier of the user.	488042375842
Connection connection / Required zendeskConnection

Unified Search

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

Input	Default	Notes	Example
Brand Ids string Value List brandIds		Limit the search to articles or post within these brand.	63
Category Ids string Value List categoryIds		Limit the search to articles or post within these categories.	63
Content Types string Value List contentTypes		Limit the search to one of these content types: ARTICLE, POST
Pagination Cursor string cursor		The cursor to use for pagination. If not provided, the first page will be returned.	aQAAAAAAAAAAZPPgaGUAAAAAaZo+HCjcBQAA
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
External Source Ids string Value List externalSourceIds		Use this parameter to scope the result of your search to a specifiedexternal source or external sources.	63
Locales string / Required Value List locales		Limit the search to articles or post within these locales.	en-us
Page Limit string pageLimit		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 string / Required searchQuery		The search text to be matched or a search string.	carrot
Section Ids string Value List sectionIds		Limit the search to articles or post within these sections.	63
Topic Ids string Value List topicIds		Limit the search to posts within these topics.	63
Connection connection / Required zendeskConnection

Update Article

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

Input	Default	Notes	Example
Body string articleBody		The body of the article.	Example Body
Article Id string / Required articleId		The unique identifier of the article.	123123213
Title string articleTitle		The title of the article.	Example Title
Author Id string authorId		The unique identifier of the author.	12
Comments Disabled string commentsDisabled		Whether comments are disabled or not.
Content Tag Ids string Value List contentTagIds		Content Tag IDs to be attached to the Object.
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Label Names string Value List labelNames		Label Names to be attached to the Object.
Locale string locale	en-us	The desired locale.
Permission Group Id string permissionGroupId		The unique identifier of the permission group.	15
Position string position		The position of the object.	42
Promoted string promoted		Whether the object should be promoted or not.
Section Id string sectionId		The unique identifier of the section.	123123213
User Segment Id string userSegmentId		The unique identifier of the user segment.	15
Connection connection / Required zendeskConnection

Example Payload for Update Article

{
  "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	Default	Notes	Example
Category Description string categoryDescription		The description of the category to be updated.	Example Description
Category Id string / Required categoryId		The unique identifier of the category.	12
Category Name string categoryName		The name of the category to be updated.	Example Category
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Locale string locale	en-us	The locale of the category to be updated.
Position string position		The position of the category to be updated.	42
Connection connection / Required zendeskConnection

Example Payload for Update Category

{
  "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	Default	Notes	Example
Content Tag Ids string Value List contentTagIds		Content Tag IDs to be attached to the Object.
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Closed string isPostClosed		Whether the post is closed or not.
Featured string isPostFeatured		Whether the post is featured or not.
Pinned string isPostPinned		Whether the post is pinned or not.
Details string postDetails		The details of the post.
Post Id string / Required postId		The unique identifier of the post.	12
Status string postStatus		The status of the post.
Title string postTitle		The title of the post.	Example Title
Topic Id string topicId		The unique identifier of the topic.	12
Connection connection / Required zendeskConnection

Example Payload for Update Post

{
  "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	Default	Notes	Example
Category Id string categoryId		Category ID of the Section to update.	12
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Locale string / Required locale	en-us	The desired locale.
Parent Section Id string parentSectionId		Parent Section ID of the Section to update.	12
Position string position		Position of the Section to update.	42
Section Description string sectionDescription		Description of the Section to update.	Example Description
Section Id string / Required sectionId		The unique identifier of the section.	123123213
Section Name string sectionName		Name of the Section to update.	Example Section
Connection connection / Required zendeskConnection

Example Payload for Update Section

{
  "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	Default	Notes	Example
Assignee Email string assigneeEmail		Provide a valid email for the assignee of the ticket.	Jane.Doe@example-prismatic.io
Assignee Id string assigneeId		Provide a valid user id for the assignee of the ticket.	403598029853443232
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
File data file		The file to attach to the comment - either string contents or a binary file
File Name string fileName		The name of the file to upload
Requester Organization Id string requesterOrganization		Provide an integer value to specify the Organization of the requester.	488042375842
Tags string Value List tags		For each item, provide a string value for the tag.	Engineering
Ticket Comment Body string ticketComment		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 string ticketCommentHTML		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 string / Required ticketId		Provide the unique identifier for the ticket you would like to show.	ExampleTicketId
Ticket Priority string ticketPriority		Provide a string value for the priority of the ticket.
Ticket Status string ticketStatus		Provide a string value for the status of the ticket.
Ticket Subject string ticketSubject		Provide a string value for the subject of the ticket	This is an example ticket subject.
Ticket Type string ticketType		Provide a string value for the type of the ticket.
Connection connection / Required zendeskConnection

Update Topic

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

Input	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
Manageable By string manageableBy		The user segments that can manage the topic.
Position string position		The position of the topic in the list of topics.	42
Topic Description string topicDescription		The description of the topic.	Example Description
Topic Id string / Required topicId		The unique identifier of the topic.	12
Topic Name string / Required topicName		The name of the topic.	Example Topic
User Segment Id string userSegmentId		The user segment ID to associate with the topic.	15
Connection connection / Required zendeskConnection

Example Payload for Update Topic

{
  "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	Default	Notes	Example
Debug boolean debug	false	This flag toggles debugging. When true the integration will log any requests and failures.
External Id string externalId		A unique identifier from another system. The API treats the id as case sensitive. Example: "ian1" and "Ian1" are different users
Moderator string isModerator		This flag specifies whether or not the user will have moderator permissions.
Verified string isVerified		Flip this flag to true if any of the user's identities is verified.
Organization Id string organizationId		Provide the unique identifier of the organization.
Alias string userAlias		Provide a string value that represents an alias to give to a user.	Example Alias
Details string userDetails		Provide a string value that represents details to be attached to the user.	These are some example user details
Email Address string userEmail		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-prismatic.io
UserId string / Required userId		Provide an integer value for the unique identifier of the user.	488042375842
Name string userName		Provide a string value for the name of the user.	John Doe
Notes string userNotes		Provide a string value that represents notes to be attached to the user.	These are some example notes.
Phone Number string userPhone		Provide a valid phone number for the user.	15554008989
User Role string userRole		Provide which level of permissions the user is granted.
Time Zone string userTimeZone		Provide a valid timezone that the user operates in.	Berlin
Connection connection / Required zendeskConnection

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.

Manage Tickets and users in Zendesk

Description​

Zendesk webhooks​

Zendesk user and support webhooks​

Zendesk ticket webhooks​

Connections​

Zendesk Connection​

Triggers​

Webhook​

Data Sources​

List Articles​

List Categories​

List Sections​

List Tags​

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​

Unified Search​

Update Article​

Update Category​

Update Post​

Description

Zendesk webhooks

Zendesk user and support webhooks

Zendesk ticket webhooks

Connections

Zendesk Connection

Triggers

Webhook

Data Sources

List Articles

List Categories

List Sections

List Tags

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

Unified Search

Update Article

Update Category

Update Post

Update Section