Connect your Scroll site in Jira and paste two values into your site theme, so the support widget appears on your help center.
Scroll Support Hub keeps a list of websites that are allowed to show the support widget. In Jira, you add your site to that list and choose the service project that receives its requests. A website that is not on the list cannot load the widget or reach your service project. This stops someone from copying your widget onto another website and using your service project.
Connecting the site in Jira only allows it to show the widget. The widget appears after you paste the Connection URL and Connection ID into your Scroll site theme and publish the site. The address you connect has to match the address visitors see in their browser exactly.
Before You Begin
We’re in Early Access – Activation Required
Scroll Support Hub is currently only available to early access participants and needs to be activated by K15t.
To participate and get access to Scroll Support Hub: Sign up for early access
-
Your Scroll site is published at an
https://address, and you know that address, for examplehttps://help.example.com. -
Your site uses the Help Center theme.
-
You can edit the theme of your Scroll site and publish the site.
-
You know which service project should receive the requests.
Add the Site in Jira
-
In Jira, go to Settings > Marketplace Apps > Scroll Support Hub.
-
Click Connect site. The Connect site dialog opens.
-
In the site URL field, enter the address of your Scroll site. Enter the domain only, as the hint below the field says: Only domain, without path. Example: https://example.com .
-
Under Select a service desk, choose the service project. The list shows each project as its name followed by its key.
-
Click Save. A Site added message confirms it, and the site appears in the Connected sites table.
The default request type is a starting point. Visitors can still choose any request type your portal offers them.
Rules for the Site Address
A mismatch between the connected address and the address in the browser is the most common reason the widget never appears.
|
Rule |
What happens if you break it |
|---|---|
|
The address must start with |
Saving fails with URL must start with https:// |
|
The address must be a valid URL |
Saving fails with Invalid URL |
|
The field cannot be empty |
Saving fails with URL is required |
|
Two connected sites cannot overlap |
Saving fails with Site https://example.com already added |
|
|
The widget stays blank on whichever one you did not add |
The overlap rule compares whole addresses, so you cannot add https://example.com/docs once https://example.com is on the list. One entry already covers the whole domain.
If your help center is reachable at more than one address, add the one visitors use. The widget only loads on the address you connected.
What You Get Back
Saving a site produces two values:
-
Connection URL is the address the widget is served from. It is the same for every site you connect in Jira.
-
Connection ID identifies this one site. Every site you add gets a different one.
You need both to add the widget to your Scroll site theme.
Add the Widget to Your Scroll Site Theme
Copy the Two Values From Jira
-
In the Connected sites table in Jira, find your site and click View code snippet. The code snippet dialog opens.
-
Stay on the Scroll Sites tab. It shows the two values you need.
-
Click Copy next to Connection URL, and paste the value somewhere temporary, such as a text editor.
-
Click Copy next to Connection ID, and paste it in the same place.
The Custom site tab in the same dialog is for websites not built with Scroll Sites. You do not need it here.
Paste the Values Into Your Site Theme
-
In Confluence, open Apps > Scroll Sites and select your site.
-
Go to Site settings > Customize theme > Integrations > Scroll Support Hub.
-
Paste the Connection URL into the matching field.
-
Paste the Connection ID into the matching field.
-
Save the theme settings.
-
Publish the site. The widget appears on the published site only and does not show in the preview.
Check That the Widget Loads
-
Open your live site and go to the support page.
-
Wait for the widget to finish loading. It shows a spinner first, then Welcome to our support with two buttons.
The first visit after a quiet period can take several seconds, because the app has to start up. This is normal and only affects the first visitor after the quiet period.
If the widget area stays empty, the most likely cause is that the address you connected in Jira does not match the address in your browser. Compare the two character by character, and check the address against Rules for the Site Address.
If the widget area shows a short message naming an ID, the Connection ID in your theme no longer matches any connected site. Copy it again from View code snippet, which always shows the current value, then paste it into your theme and publish the site again.
Related Articles