Dela via

Zendesk

  • Reference

Zendesk builds software for better customer relationships. With multiple products in its portfolio, Zendesk provides a customer service and support ticketing platform that gives businesses the ability to handle customer calls, emails, and other technical inquiries from a unified interface.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Microsoft
URL Microsoft LogicApps Support
Microsoft Power Automate Support
Microsoft Power Apps Support
Connector Metadata
Publisher Microsoft
Website https://www.zendesk.com/
Privacy policy https://www.zendesk.com/company/customers-partners/privacy-policy/

Known issues and limitations

  1. Connector returns only atomic properties of Zendesk entity (i.e. lists, records and other complex types are not supported). For instance, Ticket entity has tags property represented by array on Zendesk's side. Zendesk connector returns [List] string for such fields.
  2. Connector requires updated_at column to exist for any table that is used with triggers.
  3. Zendesk Search API has a limitation on returning 1000 results per query. This affects some connector actions, that would fail with an error ("Http request failed: the content was not a valid JSON") if target table contains 1000 records or more:

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Company name string The Zendesk company name is the subdomain part of your site url. E.g. https://{company}.zendesk.com True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create Item

Creates a Zendesk item
Delete item

Deletes a Zendesk item
Get item

Retrieves a Zendesk item
Get items

Retrieves Zendesk items of a certain Zendesk type (example: 'Ticket')
Get tables

Retrieves Zendesk tables from a site
Search Articles

Returns a default number of 25 articles per page, up to a maximum of 1000 results.
Update item

Updates an existing Zendesk item

Create Item

Operation ID:
PostItem

Creates a Zendesk item

Parameters

Name Key Required Type Description
Table name
 table True string

Zendesk item type (example: 'Ticket')
Item
 item True dynamic

Zendesk item to create

Returns

The outputs of this operation are dynamic.

Delete item

Operation ID:
DeleteItem

Deletes a Zendesk item

Parameters

Name Key Required Type Description
Table name
 table True string

Zendesk item type (example: 'Ticket')
Item key
 id True string

Unique identifier of the item to delete

Get item

Operation ID:
GetItem

Retrieves a Zendesk item

Parameters

Name Key Required Type Description
Table name
 table True string

Zendesk item type (example: 'Ticket')
Item key
 id True string

Unique identifier of the item to retrieve

Returns

The outputs of this operation are dynamic.

Get items

Operation ID:
GetItems

Retrieves Zendesk items of a certain Zendesk type (example: 'Ticket')

Parameters

Name Key Required Type Description
Table name
 table True string

Zendesk item type (example: 'Ticket')
Filter Query
 $filter string

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).
Order By
 $orderby string

An ODATA orderBy query for specifying the order of entries
Skip Count
 $skip integer

Number of entries to skip (default = 0)
Maximum Get Count
 $top integer

Maximum number of entries to retrieve (default = 512)
Select Query
 $select string

Specific fields to retrieve from entries (default = all).

Returns

The outputs of this operation are dynamic.

Get tables

Operation ID:
GetTables

Retrieves Zendesk tables from a site

Returns

Body
TablesList

Search Articles

Operation ID:
SearchArticles

Returns a default number of 25 articles per page, up to a maximum of 1000 results.

Parameters

Name Key Required Type Description
Query
 query True string

Article to search for.
Locale
 locale string

The locale the item is displayed in
Brand Id
 brand_id integer

Search for articles in the specified brand.
Category
 category integer

Limit the search to this category id.
Section
 section integer

Limit the search to this section id
Label Names
 label_names string

A comma-separated list of label names.
Multibrand
 multibrand boolean

Enable search across all brands if true.

Returns

Body
SearchResult

Update item

Operation ID:
PatchItem

Updates an existing Zendesk item

Parameters

Name Key Required Type Description
Table name
 table True string

Zendesk item type (example: 'Ticket')
Item key
 id True string

Unique identifier of the item to update
Item
 item True dynamic

Zendesk item with updated values

Returns

The outputs of this operation are dynamic.

Triggers

When an item is created

Triggers a flow when an item is created in Zendesk
When an item is modified

Triggers a flow when an item is modified in Zendesk

When an item is created

Operation ID:
GetOnNewItems

Triggers a flow when an item is created in Zendesk

Parameters

Name Key Required Type Description
Table name
 table True string

Name of Zendesk table
Filter Query
 $filter string

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).
Order By
 $orderby string

An ODATA orderBy query for specifying the order of entries
Skip Count
 $skip integer

Number of entries to skip (default = 0)
Maximum Get Count
 $top integer

Maximum number of entries to retrieve (default = 512)

Returns

The outputs of this operation are dynamic.

When an item is modified

Operation ID:
GetOnUpdatedItems

Triggers a flow when an item is modified in Zendesk

Parameters

Name Key Required Type Description
Table name
 table True string

Name of Zendesk table
Filter Query
 $filter string

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).
Order By
 $orderby string

An ODATA orderBy query for specifying the order of entries
Skip Count
 $skip integer

Number of entries to skip (default = 0)
Maximum Get Count
 $top integer

Maximum number of entries to retrieve (default = 512)

Returns

The outputs of this operation are dynamic.

Definitions

Table

Name Path Type Description
Name
 Name string
DisplayName
 DisplayName string

SearchResult

Name Path Type Description
results
 results array of object
id
 results.id integer

Automatically assigned article ID
url
 results.url string

The API url of the article
html_url
 results.html_url string

The url of the article in Help Center
author_id
 results.author_id integer

Author ID
comments_disabled
 results.comments_disabled boolean

True if comments are disabled; false otherwise
draft
 results.draft boolean

True if the translation for the current locale is a draft
promoted
 results.promoted boolean

True if this article is promoted; false otherwise. false by default
position
 results.position integer

The position of this article in the article list. 0 by default
vote_sum
 results.vote_sum integer

The sum of upvotes (+1) and downvotes (-1), which may be positive or negative
vote_count
 results.vote_count integer

The total number of upvotes and downvotes
section_id
 results.section_id integer

The id of the section to which this article belongs
created_at
 results.created_at date-time

The time the article was created
updated_at
 results.updated_at date-time

The time the article was last updated
name
 results.name string

Name of Article
title
 results.title string

The title of the article
source_locale
 results.source_locale string

The source (default) locale of the article
locale
 results.locale string

The locale that the article is being displayed in
outdated
 results.outdated boolean

Deprecated
outdated_locales
 results.outdated_locales array of string

Locales in which the article was marked as outdated
edited_at
 results.edited_at date-time

The time the article was last edited in its displayed locale
user_segment_id
 results.user_segment_id integer

The id of the user segment which defines who can see this article
permission_group_id
 results.permission_group_id integer

The id of the permission group which defines who can edit and publish this article
content_tag_ids
 results.content_tag_ids array of string

The list of content tags attached to the article
label_names
 results.label_names array of string

An array of label names associated with this article
body
 results.body string

HTML body of the article
snippet
 results.snippet string

HTML snippet of the article
result_type
 results.result_type string

Type of Result

TablesList

Name Path Type Description
value
 value array of Table