Alerts extension: How to use alerts

This extension provides simple, customizable, and responsive notifications for your Help Center.

Installation Usage

1. Unpack the downloaded zip file. There will be three files:

   • apidata-min.js
   • alerts-min.js
   • Readme.txt

2. In Guide, click on the Customize design icon in the sidebar. The Theming center page opens.

3. Click the theme you want to edit to open it.

4. Click the Edit code button.

5. In the Assets section, click Add asset, then browse to select your files.

   Select the alerts-min.jsfile from the unpacked zip. The file is added to your list of asset files. If you don't use one of our themes, also upload the apidata-min.js file.

6. In your theme code configuration page under the templates directory, click the document_head.hbs file.

7. In the document_head.hbs file, paste the following snippets:

   <script src="{{asset 'apidata-min.js'}}" />

   <script src="{{asset 'alerts-min.js'}}" />
   

8. Click Publish.

1. Create a new article for the alert. It will be used for the content of an alert.

2. (Guide Enterprise only) If you are on Guide Enterprise, click Article settings.
   This step is not necessary on Guide Professional.

3. In Labels in the right sidebar, start typing the label you want to add, then select Add as new label or select the matching label, if it exists. Article labels are not case-sensitive.

   There are 4 types of alert labels:

   • alert_danger

     

   • alert_info

     

   • alert_success

     

   • alert_warning

     
4. Make sure that you have the correct article visibility settings in the Visible to field.
5. Save the changes.

Please note that after adding a label and publishing the article, it may take up to 5 minutes before the banner appears. It's because Zendesk doesn't reflect changes immediately in the API.