Objects

The page lists the objects you can use in Help Center templates. Click the page links in the left sidebar for the availability of the objects in different templates. To learn how to access object properties in your templates, see Properties in the introduction.

activity object

The activity object has the following properties.

NameTypeDescription
labelstringThe translated label showing the type and the time of the contribution made by the user
typestringThe type can be created-article, created-post or created-comment
contributionobjectA contribution object related to the activity

answer bot object

Answer Bot refers to AI Agent autoreplies with articles in Zendesk. The answer bot object has the following properties.

NameTypeDescription
auth_tokenstringAnswer Bot auth_token. It should be appended to the suggested article URLs as explained in the Article Feedback APIs documentation
interaction_access_tokenstringAnswer Bot interaction_access_token to be used to interact with the Article Feedback APIs
articlesarrayAn array of answer bot article objects containing the suggested articles
request_idstringThe id of the submitted request

answer bot article object

This object represents an article suggested by the Answer Bot. It includes the following properties:

NameTypeDescription
article_idintegerThe id of the article
html_urlstringThe URL of the article
titlestringThe title of the article
snippetstringA snippet from the article

article object

The article object has the following properties.

NameTypeDescription
idintegerThe id of the article
urlstringThe URL of the article in Help Center
titlestringThe title of the article
bodytextThe body of the article. Starting with Templating API v4, this property is not available outside the Article page
localestringThe locale that the article is displayed in
promotedbooleanIf the article is promoted or not. False by default
internalbooleanIf the article has a "staff" user segment. See User Segments
updated_atstringThe time the article was last updated
created_atstringThe time the article was created
edited_atstringThe time the article was last edited in its displayed locale
vote_sumintegerThe sum of upvotes (+1) and downvotes (-1), which may be positive or negative
vote_countintegerThe total number of upvotes and downvotes
upvote_countintegerThe number of up votes on this article
comment_countintegerThe number of comments on this article
comments_disabledbooleanIf comments are disabled or not
authorobjectA user object describing the author of the article
votehelperVoting elements. See vote helper. Starting with Templating API v4, this property is not available outside the Article page
path_stepsarrayAn array of path_step objects describing the path to the article
labelsarrayAn array of article label objects
snippetstringAn excerpt of the article body. Available only outside the Article page from Templating API v4

article comment object

The article comment object has the following properties.

NameTypeDescription
idintegerThe id of the comment
bodystringThe body of the comment
anchorstringThe anchor id of the comment
urlstringThe URL of the comment
created_atstringThe time the comment was created
edited_atstringThe last time the comment was edited
pendingbooleanIf the comment is pending approval or not
vote_sumintegerThe total sum of votes on this comment
vote_countintegerThe number of votes cast on this comment
authorobjectA user object describing the author of the comment
editorobjectA user object describing the editor of the comment if the comment was edited
ticketobjectA ticket object related to the comment, if available
actionshelperLinks to the actions available (depending of the account and the user) for the comment
votehelperVoting elements. See vote helper

article label object

The article label object has the following properties.

NameTypeDescription
identifierstringThe name of the label

attachment object

The attachment object has the following properties.

NameTypeDescription
idintegerThe id of the attachment
urlstringThe URL of the attachment
namestringThe name of the attachment
sizestringThe size of the attachment

badge object

The badge object has the following properties.

NameTypeDescription
idstringThe id of the badge
namestringThe badge's name
descriptionstringThe badge's description
category_slugstringThe slug of the badge’s category
icon_urlstringThe URL of the badge’s icon. Empty if the badge does not have an icon
assigned_atstringThe time the badge was awarded to the user

brand object

The brand object has the following properties.

NameTypeDescription
idintegerThe id of the brand
namestringThe name of the brand

category object

The category object has the following properties.

NameTypeDescription
idintegerThe id of the category
namestringThe name of the category
descriptionstringThe description of the category
urlstringThe URL of the category in Help Center
more_sectionsbooleanIf there are more sections than the ones in the sections array
sectionsarrayAn array of up to 5 category section objects. See more_sections above. The limit increases to 30 section objects when a single category is displayed on the Home page. Before Templating API v4, the array contains up to 30 section objects when the category is displayed on the Home page, and up to 100 section objects when the category is displayed on the Category page

contribution object

The contribution object has the following properties.

NameTypeDescription
idintegerThe id of the contribution
titlestringThe title of the contribution
urlstringThe URL of the contribution
object_typestringThe type of the contribution
typestringThe translated type of the contribution
vote_sumintegerThe total sum of votes on the contribution
last_activity_atstringThe time of the last activity on the contribution
created_atstringThe time the contribution was created
edited_atstringThe time the contribution was edited
statusstringThe status of the contribution
status_namestringThe translated status of the contribution
status_dasherizedstringThe contribution status with dashes instead of underscores
bodystringThe body of the contribution
pendingbooleanWhether the contribution is pending for approval
officialbooleanWhether the contribution is marked as official
path_stepsarrayAn array of path_step objects
statsarrayAn array of stat object
authorobjectThe user object describing the author of the contribution
editorobjectThe user object describing the editor of the contribution

filter object

The filter object has the following properties.

NameTypeDescription
identifierstringThe filter's identifier
namestringThe filter's name
urlstringThe URL of the filter
selectedbooleanIf the filter is on or off by default
labelstringThe label for the filter when it's selected
countintegerThe number of records matching this filter

end user condition object

The end user condition object has the following properties.

NameTypeDescription
parent_field_idstringThe id of the parent field
parent_field_typestringThe type of the parent field
valuestringThe value of the condition
child_fieldsarrayAn array of end user condition child field objects

end user condition child field object

The end user condition child field object has the following properties.

NameTypeDescription
idstringThe id of the child field
is_requiredbooleanA boolean indicating whether the child field becomes required when the condition is met

group object

The group object has the following properties.

NameTypeDescription
idintegerThe id of the group
namestringThe name of the group

help_center object

The help_center object has the following properties.

NameTypeDescription
namestringThe name of the current Help Center
urlstringThe URL of the current Help Center
localestringThe locale in which the Help Center is being viewed
community_enabledbooleanIf community is enabled in the current Help Center
request_management_enabledbooleanIf end users can manage their requests in the current Help Center
request_ccs_enabledbooleanIf end users can add CCs to the requests in the current Help Center. See "Enable CCs for end users on Help Center" in the table in Setting permissions for CCs and followers in the Support Help Center
base_localestringIf the current locale is a variant of an another language, returns the base locale. Otherwise, the value is the same as the locale property
at_mentions_enabledbooleanIf the @mentions feature is enabled in the current help center

locale object

The locale object has the following properties.

NameTypeDescription
namestringThe name of the locale
urlstringThe URL of the locale
directionstringThe direction in which the language is read. Example: English is "ltr" (left to right) while Arabic is "rtl" (right to left)

new request form object

The new request form object has the following properties.

NameTypeDescription
accept_charsetstringThe value of the accept-charset attribute of the form element
actionstringThe value of the action attribute of the form element
http_methodstringThe value of the method attribute of the form element
errorsstringA string containing global errors for the form. It is null if there are no global errors
ticket_form_fieldobjectA ticket field object. It contains the enabled ticket forms in the options array
parent_id_fieldobjectA ticket hidden field object containing the parent request id if the request is a follow-up request
email_fieldobjectA ticket field object used for requesting the user's email address if the user is anonymous
cc_fieldobjectA ticket field object if CC on request form is enabled
organization_fieldobjectA ticket field object if the user belongs to multiple organizations
due_date_fieldobjectA ticket field object to be shown if the request is of type "task"
ticket_fieldsarrayAn array of ticket field objects containing all the standard and custom fields of the selected ticket form
end_user_conditionsarrayAn array of end user condition objects if the selected ticket form has end user conditions
attachments_fieldobjectA ticket attachment field object. It contains the previous attachments if the form has been submitted with errors
inline_attachments_fieldsarrayAn array of ticket hidden field objects. It contains the attachments added in the WYSIWYG editor if the form has been submitted with errors
description_mimetype_fieldobjectA ticket hidden field object. Its value must be set to text/html if the description field is using the WYSIWYG editor, or text/plain otherwise

organization object

The organization object has the following properties.

NameTypeDescription
idstringThe id of the organization
namestringThe name of the organization

path_step object

The path_step object has the following properties.

NameTypeDescription
namestringThe name of the path step
urlstringThe URL of the path step
targetstringThe target in which the URL should be opened. Example: _self or _blank

post object

You can use the following properties in any post object.

NameTypeDescription
idintegerThe id the post
titlestringThe title of the post
urlstringThe URL of the post in Help Center
detailsstringThe body of the post
created_atstringThe time the post was created
updated_atstringThe time the post was last updated
edited_atstringThe time the post was last edited
comment_countintegerThe number of comments on the post
follower_countintegerThe number of users following the post
vote_sumintegerThe total sum of votes on the post
vote_countintegerThe number of votes cast on the post
pendingbooleanIf the post is pending approval or not
pinnedbooleanIf the post is pinned
featuredbooleanIf the post is featured
closedbooleanWhether further comments are allowed
actionshelperPartial rendering the actions possible on the post
statusstringThe post status
status_dasherizedstringThe post status with dashes instead of underscores
status_namestringThe post status translated
ticketobjectA ticket object related to the post
authorobjectA user object describing the author of the post
editorobjectA user object describing the editor of the post if the post was edited
votehelperVoting elements. See vote helper
path_stepsarrayAn array of path_step objects describing the path to the post

post comment object

You can use the following properties in any post comment object.

NameTypeDescription
idintegerThe id the comment
anchorstringThe anchor id of the comment
urlstringThe URL of the comment
vote_sumintegerThe total sum of votes on the comment
vote_countintegerThe number of votes cast on the comment
created_atstringThe time the comment was created
updated_atstringThe time the comment was last updated
edited_atstringThe time the comment was last edited
officialbooleanIf the comment is official or not
pendingbooleanIf the comment is pending approval or not
bodystringThe body of the comment
actionshelperPartial rendering the actions possible on the post
authorobjectA user object describing the author of the comment
editorobjectA user object describing the editor of the comment if the comment was edited
ticketobjectA ticket object related to the comment, if available
votehelperVoting elements. See vote helper
internalbooleanIf the post is internal or not

rating object

The rating object has the following properties.

NameTypeDescription
max_valueintegerThe numeric representation of the rating scale's upper bound. For example, if the rating scale is a 1-5 scale, max_value will be 5
scale_typestringThe type of the scale the rating was selected on. Possible values: numeric, emoji, custom_text. New types of scales may be added in the future
scale_valuestringThe string representation of the selected rating from the scale
valueintegerThe numeric representation of the selected rating from the scale

related_article object

The related_article object has the following properties.

NameTypeDescription
urlstringThe URL of the article in Help Center
titlestringThe title of the article

request object

The request object has the following properties.

NameTypeDescription
idintegerThe id of the request
urlstringThe URL of the request in Help Center
subjectstringThe subject of the request
descriptionstringThe description of the request
updated_atstringThe time the request was last updated
created_atstringThe time the request was created
statusstringThe status of the request
status_descriptionstringA description of the status of the request
status_namestringThe localized version of the status value
requesterobjectA user object describing the requester author
due_atstringWhen the task is due (only applies if the request is of type "task")
due_datestringSame as due_at but Localized according to current locale.
typestringThe type of the request, "question", "incident", "problem", "task" or "none" if not assigned
type_namestringThe localized version of the type value
type_titlestringThe title shown to end users for the type field
prioritystringThe priority of the request, "low", "normal", "high", "urgent" or "none" if not assigned
priority_namestringThe localized version of the priority value
priority_titlestringThe title shown to end users for the priority field
followup_source_idintegerThe id of the previous request if this is a followup request
can_be_marked_as_solvedbooleanIf user can mark the request as solved

Both type and priority return falsy if the field is not visible to the end user.

request comment object

The request comment object has the following properties.

NameTypeDescription
idintegerThe id of the comment
anchorstringThe anchor id of the comment
created_atstringThe time the comment was created
bodystringThe body of the comment
authorobjectA user object describing the comment author
attachmentsarrayAn array of attachment objects

request field object

The request field object has the following properties.

NameTypeDescription
typestringThe type of the request field
titlestringThe title of the request field
valueanyThe value of the request field

satisfaction response object

The satisfaction_response object has the following properties.

NameTypeDescription
idstringThe id of the satisfaction response
editablebooleanIf the satisfaction response can still be edited by the current user
ratingobjectA nullable rating object related to the satisfaction response

search result object

The search result object has the following properties.

NameTypeDescription
titlestringThe title of the search result
urlstringThe URL of the search result
is_externalbooleanIf true, the search result is an external content record
textstringA relevant content snippet in the result, with <em> tags applied to the search term and any HTML from the source removed
vote_sumintegerThe total sum of votes on this search result record
created_atstringThe time the search result record was created
edited_atstringThe time the search result record was last edited
comment_countintegerThe number of comments on this search result record
metastringMeta information for a search result record, e.g.: 'by John Rossi 6 months ago in Kitchen > Recipes'"
typestringThe type of the search result. Valid values are 'article', 'community_post', and 'external_content_record'
authorobjectA user object describing the author of the search result record
path_stepsarrayAn array of path_step objects describing the path to the search result

section object

The section object has the following properties.

NameTypeDescription
idintegerThe id of the section
namestringThe name of the section
descriptionstringThe description of the section
urlstringThe URL of the section in Help Center
article_countintegerThe number of articles in the section. Starting with Templating API v4, this property is not available in the Home page
more_articlesbooleanIf there are more articles than the ones in the articles array (the current page). Starting with Templating API v4, this property is not available in the Home page
articlesarrayAn array of up to 30 article objects. See more_articles above. For sections displayed on category pages, an array of up to 6 article objects. For subsections displayed on section pages, an array of up to 5 article objects. Starting with Templating API v4, this property is not available in the Home page
more_sectionsbooleanIf there are more sections than the ones in the sections array
sectionsarrayAn array of up to 30 section objects. See more_sections above. This array is populated only for Guide Enterprise customers. Starting with Templating API v4, the number of sections is limited to 5 on the Home page and the Category page

settings object

The settings object has custom properties. The object maps the identifier and value of the variables defined in the theme's manifest.json file. The property values can be changed using the theme's Settings panel in Guide. See Customizing the Settings panel in the Guide documentation.

In the following example, the settings object has a custom property with an identifier of color_brand_text:

<div style="color:{{settings.color_brand_text}}">

Like any other object, you can also use the settings object in a helper. Example:

{{#is settings.warnings_enabled "Yes"}}  <!--block to render if the setting value is "Yes" -->{{/is}}

In the example, the warnings_enabled custom property is a list type variable with "Yes" and "No" options.

stat object

The stat object has the following property.

NameTypeDescription
labelstringThe translated status showing the vote count of the contribution. For a post and article contribution, it also includes the comment and follower counts

subscription object

The subscription object has the following properties.

NameTypeDescription
idintegerThe id of the subscription
titlestringThe title of the subscribed record
urlstringThe URL of the subscribed record
typestringThe type of the subscription. Can be article, section, topic
namestringThe localized string of the type of the subscription
followingstringThe localized string of what types of content are followed
subscribehelperDrop-down menu with links for subscribing

ticket object

The ticket object has the following properties.

NameTypeDescription
idintegerThe id of the ticket
urlstringThe URL of the ticket

ticket attachment object

The ticket attachment field object has the following properties.

NameTypeDescription
idstringThe id of the attachment
file_namestringThe file name of the attachment
urlstringThe URL where the attachment can be accessed

ticket attachment field object

The ticket attachment field object has the following properties.

NameTypeDescription
namestringThe name of the field used to set the name attribute of the input element
labelstringThe translated label for the attachments field
attachmentsarrayAn array of ticket-attachment objects. If the form has been submitted with errors, it contains the previous attachments
errorstringThe error message associated with the field in the request. It is null if there are no errors

ticket field object

The ticket field object has the following properties.

NameTypeDescription
idintegerThe id of the field. If the field is not a standard or custom field configurable in Admin Center, the value is -1.
namestringThe name of the field used to set the name attribute of the input element
valuevariousThe value of the field. The type of the value depends on the field type. It contains a value when the form has been submitted with errors or when the form is prefilled. Otherwise it is null
optionsarrayAn array of ticket-field-option objects if the field has any options
errorstringThe error message associated with the field in the request. It is null if there are no errors
labelstringThe label of the field
requiredbooleanWhether the field is required or not
descriptionstringThe description of the field
typestringThe type of the field

ticket field option object

The ticket field option object has the following properties.

NameTypeDescription
namestringThe name of the option shown to the end user
valuestring or integerThe value of the option

ticket hidden field object

The ticket hidden field object has the following properties.

NameTypeDescription
namestringThe name of the hidden field
valuestringThe value of the field. It contains a value when the form has been submitted with errors or when the form is prefilled. Otherwise it is null
typestringThe type of the field, which is always hidden for this object

ticket form object

The ticket form object has the following properties.

NameTypeDescription
idintegerThe id of the ticket form
urlstringThe URL of the ticket form
display_namestringThe name of the ticket form

topic object

You can use the following properties in any topic object.

NameTypeDescription
idintegerThe topic id
namestringThe topic name
urlstringThe URL of the topic in Help Center
descriptionstringThe description of the topic in Help Center
post_countintegerThe number of posts in the topic
follower_countintegerThe number of users following the topic
internalbooleanIf the topic is internal or not
updated_atstringThe time the topic was last updated
created_atstringThe time the topic was created

user object

The user object has the following properties.

NameTypeDescription
namestringThe name of the user
idintegerThe user id
urlstringThe URL of the user in the agent interface
agentbooleanIf the user is an agent
avatar_urlstringThe user's avatar URL
badgesarrayAn array of badge objects
organizationsarrayAn array of organization objects