Integrations

Integrate the Help Center theme with your 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.

	Name	Type	Example Value	Comment
1	`integrations.scrollVersions.variants.standAlone`	Other	cloud	An 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.

Scroll PDF Exporter

Using the Scroll PDF Exporter integration you can add a button for downloading a PDF to every article page. The button give the user the choice to download a single page or a page with all of its children. The integration is activated in the theme settings using the following settings.

	Name	Type	Example Value	Comment
1	`integrations.scrollPdfExporter`	Toggle	on
2	`integrations.scrollPdfExporter.templateId`	Free Text	79d10041-ffac-4abd-ae62-99aa88d1d	Find the ID by clicking Space Tools > Add-ons > Scroll PDF Exporter, finding the template you want to use, and clicking Template Information in the actions dropdown menu.

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 integrations 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

	Name	Type	Example Value	Comment
1	`integrations.google.analyticsId`	Other	UA-123456-7	Insert the Google Analytics ID of your service.

Tag Manager

	Name	Type	Example Value	Comment
1	`integrations.google.tagManagerId`	Other	GTM-123456-7	Insert the Google Tag Manager ID of your service.

If you data seems to not appear in Google Analytics, make sure cookies can be set.

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:

	Name	Type	Example Value	Comment
1	`integrations.freshdesk.url`	Link	https://yourcompany.freshdesk.com	This setting will provide the Freshdesk Web Widget in your Help Center Theme.
2	`integrations.freshdesk.buttonText`	Free Text	Support	This text will be the text of button to activate the widget.
3	`integrations.freshdesk.buttonColor`	CSS Color	green	A CSS Color for the background color of the button.
4	`integrations.freshdesk.buttonTextColor`	CSS Color	white	A 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.

	Name	Type	Example Value	Comment
1	`integrations.intercom.appId`	Other	abc12345	Insert the Intercom App ID to activate the widget in your Help Center Theme.

Jira Service Desk Cloud

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.

	Name	Type	Example Value	Comment
1	`integrations.jiraServiceDesk.key`	Other	9364753d9a-tg7d-45ad-a46d-b348thfc5d	Insert the Jira Service Desk Key to activate the widget in the Help Center theme.

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.

	Name	Type	Example Value	Comment
1	`integrations.zendesk.url`	Other	yourCompany.zendesk.com	Insert the Zendesk URL of your service.