DocumentationAPI Reference

Help Center

Adding help center to your app

The help center powered by Zendesk Guide provides your customers a web-based, self-service knowledge base. You can now integrate it into the Zendesk SDK for Unity, allowing your customers to browse the help center directly within your Unity application without needing to launch an external browser.

Your help center displays your published browser-accessible content, including images, links, and a select range of rich text features such as bold, italics, and lists.

Benefits of integrating your help center in the app

Integrating the help center into your app offers significant benefits:

  • Enhanced User Experience: Users can find answers quickly without leaving the app.
  • Reduced Support Costs: Fewer support tickets as users may self-serve more.
  • Increased Customer Satisfaction: Users will have immediate access to information which may positively impact satisfaction rate.

Prerequisites

UI overview

The sections below describe your integrated help center UI.

Home Screen

As shown below, users will have direct access to your help center content from the Home screen, along with the option to engage in messaging conversations.

Help Center Page

The Categories and Promoted Articles/Recent Activity sections display the layout of your web-based help center. Users can tap on an article to view its content. The current article viewer does not support all formats available on the web.

Tapping a category opens the Category Page.

Users can start a conversation by tapping the Message Icon located at the top right corner of the screen.

Category Page

The category's content reflects the setting of the web-based help center.

See Promotion of articles for more information. If there are no promoted articles, we will be showing articles with the most recent activity.

Configuring help center in your app

To display your help center, call the ShowHomeAsync(); method from the ZendeskSdk.Instance.Home instance.

Optional parameters:

  • parentTransform: The parent transform to which the Zendesk prefab will be attached, or null (in which case, the Zendesk prefab will be instantiated at the root of the first canvas).

C#

await ZendeskSdk.Instance.Home.ShowHomeAsync();

After ShowHomeAsync() is called, the Zendesk Home UI is displayed.

Localization

The UI supports localization in 25 languages and automatically selects the appropriate language according to the device's locale. The locale must be available in your help center and within the localization settings of your Support account. Additionally, the articles in your help center must be localized to be viewed in a different language.

Note: If the device's locale is not supported in your help center, the Home UI will be displayed in the default locale of the help center.

Limitations

  • Restricted articles are not supported in the SDK
  • Search functionality is not available
  • Emojis aren't supported in the SDK