Setting up the Atlassian Statuspage integration for Guide

What's my 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.

This article is intended for administrators and describes the steps to set up and configure the Atlassian Statuspage widget for Guide. You set up the widget by adding a JavaScript snippet that runs a script to display status page incidents in your help center.

Note: To set up the widget, you must be on the Zendesk Guide Professional or Enterprise plan and have a public Atlassian Statuspage URL.

This article contains the following topics:

• Uploading the script as a help center theme asset
• Adding the code snippet to the header template
• Deleting the Atlassian Statuspage widget

Related articles:

• Installing and using the Atlassian Statuspage integration for Chat

• Installing and using the Atlassian Statuspage integration for Support

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

1. Download the statuspage-widget.js file.
2. In Guide, open your theme, then click Edit code.
   
   
   
3. In the assets directory, click Add asset.
   
   
   
4. 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

1. In Guide, open your theme, then click Edit code.
2. In your theme code configuration page under the templates directory, click the header.hbs handlebar file. The file content is displayed.
   
   
   
3. 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>

   
   
   
4. 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.
5. 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.