Zendesk | Yext Hitchhikers Platform
Overview
Use the Zendesk source to pull in your Help Articles, Community Posts, and Macros.
This source uses the Zendesk API to:
Requirements
Users must enter their Zendesk subdomain (e.g., https://[subdomain].zendesk.com
and their Zendesk Locale (e.g., en-us
). Additionally, Zendesk username and password are required in order to use the authenticated operation.
Authentication
For any public Zendesk Help Centers, no authentication is necessary to retrieve information via API.
For private Help Center content, we will use Basic Auth for making authenticated calls. Zendesk credentials (username and password) will be used to authenticate any private operation.
Pagination
Zendesk utilizes cursor pagination.
Cursor Type | Full URL |
Detect Cursor In | Response Body |
Cursor | next_page |
Fields
Fetch Help Articles
author_id
body
comments_disabled
content_tag_ids
created_at
draft
edited_at
html_url
id
label_names
locale
outdated
outdated_locales
permission_group_id
position
promoted
section_id
source_locale
title
updated_at
url
user_segment_id
vote_count
vote_sum
Fetch Sections
category_id
created_at
description
html_url
id
locale
name
outdated
parent_section_id
position
source_locale
theme_template
updated_at
url
Fetch Categories
created_at
description
html_url
id
locale
name
outdated
position
source_locale
updated_at
url
Fetch Community Posts
author_id
closed
comment_count
content_tag_ids
created
details
featured
follower_count
html_url
id
non_author_editor_id
non_author_updated_at
pinned
status
title
topic_id
updated_at
url
vote_count
vote_sum
Fetch Macros
actions
active
created_at
default
description
id
position
restriction
title
updated_at
url
<% elem.innerText %>