Suite | Growth, Professional, Enterprise, or Enterprise Plus |
Support with | Guide, any plan |
The Atlassian Statuspage integration for Guide allows customers to see status page incidents on your help center pages. This keeps customers informed of any service incidents or degradation, reducing the need for them to raise support requests. The status widget appears in the help center only when there's an impact to service.
You must be an admin to set up and configure the Atlassian Statuspage widget for Guide and you must have a public page for Atlassian Statuspage. You set up the widget by adding a JavaScript snippet that runs a script to display status page incidents in your help center.
This article contains the following topics:
Related articles:
Uploading the script as a help center theme asset
The first part of setting up the status page integration is uploading the JavaScript file as a help center theme asset.
To upload the JavaScript file to your theme assets
- Download the statuspage-widget.js file.
- In Knowledge admin, click Customize design
(
) in the sidebar.
- On the theme you want to edit, click Customize to open
it, then click Edit code.
- In the assets directory, click Add asset.
- Select the the statuspage-widget.js file on your computer, and
click Open.
Adding the code snippet to the header template
To complete setting up the integration, a script is added in the header template to display status page incidents in your help center.
To add the code snippet to the header template
- In Knowledge admin, click Customize design
(
) in the sidebar.
- On the theme you want to edit, click Customize to open it, then click Edit code.
- In your theme code configuration page under the templates directory,
click the header.hbs template file.
The file content is displayed.
- In the header.hbs file, paste the following snippet after the
<header/> tags:
<script type="text/javascript" id="statuspage-widget" statuspage="https://YOUR_STATUSPAGE_URL" src="{{asset 'statuspage-widget.js'}}"></script>
- Replace YOUR_STATUS_PAGE_URL with your public Atlassian Statuspage URL. You can also use the Zendesk test status page URL https://test1282.statuspage.io/ if you need to test and verify your installation.
- Click Publish. The status page is displayed
in your
help center.Note: If the public Atlassian Statuspage URL is incorrect, or if an invalid JSON is returned, the widget will not appear in your help center. If Atlassian Statuspage is not fully operational, the widget is not displayed.
Deleting the Atlassian Statuspage widget
To delete the integration, delete the statuspage-widget.js theme asset and the snippet you added in the header template of your help center theme.
10 comments
Elaine Robbie
I am trying to check if this will work on a legacy plan (professional) and if there is any way to tell if it is functioning correctly and if there are no active incidents. I am assuming from the comments that this widget will not appear unless there is an active incident.
0
Tony
thank you very much for your feedback. We really appreciate that.
Best,
0
Permanently deleted user
It should be noted that this does not work on the two other types of statuspage pages
Works
a public page on a Startup, Business or Enterprise plan
Does not work and won't display
a private page on any plan
an audience specific page
0
Jupete Manitas
As far as we can see here. This notification status will appear if there is an active incident or degradation posted on your Atlassian Statuspage. Is it behaving differently on your end?
0
Megan Daly
Should this widget appear when there are no active incidents?
0
Heather Firth
1268591125729 - What was the issue, did you have to generate the script from your status page?
0
Dane
I noticed that a ticket has already been submitted for this concern. Please continue to work with our engineer that is assigned on the ticket you have requested.
0
John DiGregorio
All I get is a pop up on the right hand side of the screen saying failure to load - is there another source to get this file
0
John DiGregorio
I edited the down load and it had /******/ on every line - tried removing it and it still won't load
0
John DiGregorio
I get an error everytime I try to add this as an asset
0
Sign in to leave a comment.