Add Markdown to an alert description

Alert descriptions support Markdown, which is a simple formatting syntax that converts plain text into HTML. When placed before or around text, certain non-alphabetic characters specify what HTML styling to apply to the text. For example, place double asterisks (**) before and after text you want to display as bold.

If you add a notification to the alert configuration, the description is included in the body of email notifications. The description is also displayed in the Alert Details, which you can access from the Alert History.

  1. Log into the Web UI on the ExtraHop Discover or Command appliance.
  2. Click the System Settings icon and then click Alerts.
  3. Open the alert you want, and then click the Description tab.
  4. In the text box, enter the description for the alert configuration.
    The following table shows common Markdown formats that are supported in the text box.
    Format Description Example
    Headings Place a number sign (#) before your text to format headings. The level of heading is determined by the amount of number signs. ####Example H4 heading
    Unordered lists Place a single asterisk (*) before your text. * First example * Second example
    Ordered lists Place a single number and period (1.) before your text. 1. First example 2. Second example
    Bold Place double asterisks before and after your text. **bold text**
    Italics Place an underscore before and after your text. _italicized text_
    Hyperlinks

    Place link text in brackets before the URL in parentheses. Or type your URL.

    Links to external websites open in a new browser tab. Links within the ExtraHop Web UI,such as dashboards or custom pages, open in the current browser tab.

    [Visit our home page](https://www.extrahop.com)

    https://www.extrahop.com

    Blockquotes Place a right angle bracket and a space before your text.

    On the ExtraHop website:

    > Access the live demo and review case studies.

    Monospace font Place a backtick (`) before and after your text. `example code block`
    Emojis Copy and paste a Unicode block emoji into the text box. Adding emojis in Markdown syntax is unsupported. For Unicode emojis examples, see the Unicode Emoji Chart website.  
  5. Click OK.
Published 2018-11-09 13:57