Integrate the Help Center theme with you analytics service, customer support system, and apps from K15t like Scroll Versions.

Scroll App Integrations

In this section you will learn which and how Scroll-Apps can be implemented with the theme.

Scroll Versions

You can activate Scroll Versions in your viewport as explained here. This adds a version and/or variant picker in the Help Center theme.

Limitations

Currently there is only support for publishing content via the Scroll Viewport <> Scroll Versions integration. In this case, Scroll Viewport must be active on the source space and instance. Published spaces containing different versions of the same source space cannot be integrated as versions of the same space within the theme.

Settings

We provide a setting to define a variant which always redirects to the latest version of a page and hides the version picker in the theme.


NameTypeExample ValueComment
1integrations.scrollVersions.variants.standAloneOthercloudAn example use case could be a cloud variant which usually doesn't have older versions but always runs on the latest version.

Scroll Translations

You can activate Scroll Translations in your Viewport as explained here. This adds a language picker in the Help Center theme.

Third-Party Integrations

You can also integrate the Help Center theme with analytics and support systems to create a rich help experience.

If you activate a third-party integration in your help center we recommend you turn on the Cookie Notice to comply with privacy regulations, like the GDPR.

Google

You can connect the Help Center theme to the Google suite of of apps like Analytics, Tag Manager, and Search Console to help better understand your users' help journeys and improve your content over time.

Analytics


NameTypeExample ValueComment
1integrations.google.analyticsIdOther

UA-123456-7

Insert the Google Analytics ID of your service without the 'UA-' in front.

Tag Manager


NameTypeExample ValueComment
1integrations.google.tagManagerIdOther

GTM-123456-7

Insert the Google Tag Manager ID of your service without the 'GTM-' in front.

Freshdesk

You can integrate the Freshdesk web widget through properties in the "theme-settings.properties" file. Follow the Freshdesk widget instructions and populate the following settings:


NameTypeExample ValueComment
1integrations.freshdesk.urlLinkhttps://yourcompany.freshdesk.comThis setting will provide the Freshdesk Web Widget in your Help Center Theme.
2integrations.freshdesk.buttonTextFree TextSupportThis text will be the text of button to activate the widget.
3integrations.freshdesk.buttonColorCSS ColorgreenA CSS Color for the background color of the button.
4integrations.freshdesk.buttonTextColorCSS ColorwhiteA CSS Color the text should be displayed in.

You don't need to use the widget code generated by Freshdesk.

Intercom

You can integrate the Intercom web widget through a property in the "theme-settings.properties" file and style the web widget directly in Intercom.


NameTypeExample ValueComment
1integrations.intercom.appIdOther

abc12345

Insert the Intercom App ID to activate the widget in your Help Center Theme.

Jira Service Desk

You can integrate the Jira Service Desk widget through a property in the "theme-settings.properties" file. The Jira Service Desk widget is currently only available for Cloud.


NameTypeExample ValueComment
1integrations.jiraServiceDesk.keyOther

12345

Insert the Jira Service Desk Key to activate the widget in the Help Center theme.
2integrations.jiraServiceDesk.baseUrlOtherhttps://myBaseUrl.jira.com

Zendesk

You can integrate the Zendesk web widget through a property in the "theme-settings.properties" file and customize the web widget directly in Zendesk.


NameTypeExample ValueComment
1integrations.zendesk.urlOther

yourCompany.zendesk.com

Insert the Zendesk URL of your service without the 'GTM-' in front.