This macro provides the ability to create customisable alerts that appear when the page loads. Alerts layer above content on a Confluence page. They can be dismissed by the user and will reload each time the page is refreshed.

Example use cases include adding a warning to users that the page that they are viewing is not finalised, that there are specific restrictions for that page, or that there is something of importance on that page.

Any alerts added to a page are visible to all users that have permission to view the page.

Usage

  1. Go to the form you wish to edit.

  2. Click Edit

  3. Click Insert More Content, and select Other Macros.

  4. This takes you to the Macro Browser, where you can search and select the Alert Macro from the list.

    The Macro Browser, with the Alert macro shown.
  5. The macro then appears on the page.

    The placeholder for the Alert macro.

Parameters

There are three parameters that can be set for the Alert Macro. These are as follows:

ParameterDescriptionTypeDefaultRequired

Alert Type

Specify the type of alert to be shown. There are four types: Info (blue-default), Success (green), Warning (yellow), Error (red)

enum

info

Alert Title

The title that will be displayed at the head of the alert

string

none

Once the alert has been added to a page, it appears on page load. A page can contain multiple alerts.

Examples

Creating an Alert Macro

The Edit screen for the Alert macro. The example configuration is for a success message.

Success Alert

A rendered example of a Success Alert.

Info Alert

A rendered example of an Info Alert.

Warning Alert

A rendered example of a Warning Alert.

Error Alert

A rendered example of an Error Alert.