Content Types

The Zendesk Guide connector synchronizes the following content types:

Content Type Description

Articles

All published articles are processed by the connector.

Article Attachments

If the option under Advanced Configuration → Zendesk → Filter → Attachments is enabled, the connector will process all attachments attached to an article including inline and block attachments.

Categories

If the option under Advanced Configuration → Zendesk → Filter → Categories is enabled, the connector will process all categories as separate documents.

Metadata

Article

Metadata Name Description Example

authorId

Numeric Unique Identifier of the user who wrote the article

123

categoryName

The name of the category the article belongs to.

General

commentsDisabled

Can be set to true of false, depending on if comments are disabled for the given article.

false

draft

Set to true if the translation for the current locale is in draft. Else set to false.

false

fileType

Displayable file type. For articles, always set to value html

html

itemType

Set to value Article for all articles.

Article

labels

List of names for all labels attached to the article.

Important, Production

permissionGroupId

The numeric ID of the permission group which defines edit and publish permission for the article.

123

position

Numeric value representing the position of the article in the articles list.

10

promoted

Set to true, if the article is promoted.

true

sectionId

Numeric Unique Identifier of the section the article belongs to.

123

sectionName

Name of the section the article belongs to.

Announcements

userSegmentId

Numeric Unique Identifier for the user segment defining the read access for the article. If this value is missing or set to null, the article is accessible to everyone.

123

voteCount

Numeric value representing the total count of up- and down-votes.

0

voteSum

Numeric value set to the sum of up- and down-votes. Positive number indicates more up-votes then down-votes, vice versa.

0

Article Attachments

Metadata Name Description Example

articleName

Name of the article where the attachment is attached to.

Welcome to Zendesk !

categoryName

Name of the category attached to the parent article.

General

fileType

File type of the attachment.

pdf

inline

Set to true if the attachment is an inline attachment, to false if the attachment is a block attachment.

false

itemType

Set to value Attachment for all attachments.

Attachment

labels

List of names for all labels attached to the parent article of the attachment.

Important, Production

sectionName

Name of the section the parent article belongs to.

Announcements

size

Size of attachment content is bytes.

2000000

Categories

Metadata Name Description Example

id

The unique identifier in Zendesk of the category.

123

url

The url of the raw data in JSON format.

https://your-subdomain.zendesk.com/api/v2/help_center/de/categories/123.json

htmlUrl

The url of the category’s page.

https://your-subdomain.zendesk.com/hc/de/categories/123-General

position

Numeric value representing the position of the category in the category list.

10

createdAt

Datetime of when the category was created.

2022-07-12T12:44:08Z

updatedAt

Datetime of when the category was last updated.

2022-07-12T12:44:08Z

name

Name of the category.

General

description

Desription of the category.

General information about your company.

locale

The language code where this category belongs in.

de

sourceLocale

The language code of the category this one is the translation of

en

outdated

A boolean value indicating that this category translation was flagged as outdated.

false