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 Documents
You can activate Scroll Documents in your viewport as explained on Publish Versions, Languages and Variants with Scroll Documents .
This adds a version, language and/or variant picker in the Help Center theme from where your users can switch to the version, variant or language of the content they need.
Translations for Scroll Documents
Translations for Scroll Documents is an extension app of Scroll Documents. While Scroll Documents allows you to manage translations of your content, the extension app will unlock all translation management features.
Used in combination with Viewport, you’ll be able to decide which translations should be published to your help center.
Variants for Scroll Documents
Variants for Scroll Documents is an extension app of Scroll Documents. While Scroll Documents allows you to conditionalize your content and manage variants of your content, the extension app will unlock all variant management features, including the option to create unlimited variants.
Used in combination with Viewport, you’ll be able to decide which variants should be published to your help center.
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 |
| Toggle | on | |
2 |
| 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.
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 |
| Other | UA-123456-7 | Insert the Google Analytics ID of your service. |
Tag Manager
Name | Type | Example Value | Comment | |
---|---|---|---|---|
1 |
| Other | GTM-123456-7 | Insert the Google Tag Manager ID of your service. |
If your data seems to not appear in Google Analytics, make sure cookies can be set.
Freshdesk
From Viewport version 2.19.3 on: Support of the Help Widget
Set up and configure the help widget from your FreshDesk account following FreshDesk’s instructions.
Name | Type | Example Value | Comment | |
---|---|---|---|---|
1 |
| String | The Url to your FreshDesk Help Widget. | |
2 |
| Sting | The Id of your FreshDesk Help Widget is also a part of the widgetUrl |
To display the widget in your help center, provide the two values within the Theme Settings File.
You don't need to use the widget code generated by Freshdesk.
Up to Viewport version 2.19.2: Support only for the Feedback Widget
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 |
| Link | https://yourcompany.freshdesk.com | This setting will provide the Freshdesk Web Widget in your Help Center Theme. |
2 |
| Free Text | Support | This text will be the text of button to activate the widget. |
3 |
| CSS Color | green | A CSS Color for the background color of the button. |
4 |
| 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 |
| Other | abc12345 | Insert the Intercom App ID to activate the widget in your Help Center Theme. |
Jira Service Management Cloud
You can integrate the Jira Service Management widget through a property in the "theme-settings.properties" file. The Jira Service Management widget is currently only available for Cloud.
Name | Type | Example Value | Comment | |
---|---|---|---|---|
1 |
| Other | 9364753d9a-tg7d-45ad-a46d-b348thfc5d | Insert the Jira Service Management 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 |
| Other | yourCompany.zendesk.com | Insert the Zendesk URL of your service. |