Skip to content


Alert rules can be created to get notifications when clients report issues. The alert system uses the health of tests or services to evaluate the issues.

Create an alert rule

  1. Navigate to Configuration > Alerts
  2. Click on the Create alert rule button.
  3. Choose a unique name and decide whether the alert rule should be enabled or disabled.
  4. Add the email address of everyone who should be notified to the Recipients list.
  5. Then click Next to specify the Condition that will trigger an alert.
  6. Choose a scope. Choose if only issues of a single client, clients at a location or all clients are considered.
  7. Choose a target which can be any service or test that is present on the health charts.
  8. Choose the health statuses that you want to be notified about.
  9. Choose the lookback time. 15 minutes relates to one column in the health charts.

Important remarks

  • Only tests and services that are shown on the health charts can be selected as target.
  • Whether an alert rule should be triggered is checked every quarter of an hour.
  • An alert condition basically relates to a health chart. An alert rule checks the latest column(s) of that chart and whether the status matches the selected status of the alert condition.


Alert API

The alert API is a REST API that provides information about all currently active alerts. It can be used for integration with other monitoring tools or notification systems (e.g. PRTG).

General usage

The URL for the API endpoint can be found under the Alerts API tab on the APIs page in the Rimscout portal.

  • Query the provided URL via an HTTP GET request.
  • Provide the header field X-Access-Token and set the access token on the Alert API tab as its value.
  • Specify the format of the respone via the Accept header field. Either application/xml or application/json are accepted.


The response contains a count for the number of currently active alerts and provides details about them. An example in xml format is shown below with comments for the parameters.

    <countActive>1</countActive> <!--Number of currently active alerts -->
    <lastEvaluated>2023-04-12T14:00.000Z</lastEvaluated> <!-- Date and time of the last check for active alerts -->
    <alerts> <!-- List with details for all currently active alerts-->
            <name>My alert</name>
            <startDateTime>2023-04-12T13:45:00.000Z</startDateTime> <!-- Date and time when the alert was triggered -->
            <acitveForMinutes>18<acitveForMinutes> <!-- Duration for which the alert is active in minutes -->
            <lastHealthStatus>critical</lastHealthStatus> <!--The last status of the target's health -->
            <lastModified>2023-04-10T11:23:14.000Z<lastModified> <!-- Date and time the alert configuration was last modified -->
            <conditions> <!-- List of conditions that triggered the alert. Currently there is always one condition. -->
                <condition> <!-- The configuration of the condition -->
                    <scopeValue></scopeValue> <!-- empty in case the targetType is 'Organization' -->
                    <targetValue>Teams</targetValue> <!-- empty in case the targetType is 'Overall' -->
                    <healthStatus>critical</healthStatus> <!-- the selected health status to be notified about -->
                    <timeMinutes>30</timeMinutes> <!-- lookback time in minutes -->
                    <healthLink></healthLink> <!-- The link to the corresponding health page in the Rimscout portal-->

PRTG example

This example gives a quick introduction for integrating the alert API into PRTG.

1) Retrieve API endpoint and token

  1. Go to
  2. Click on the tab REST API
  3. Use the URL and token on that page to query for your active alerts.


2) Create script for PRTG sensor

  1. Create a new powershell script in the suiting PRTG folder.
  2. In this script, query the active alerts using the URL and access token.
  3. Then build an XML structure the way PRTG should display the alerts.

Below is an example of such a Powershell script.

# define parameters for the API request
$url ="<tenant>/api/alerts" # replace with your URL
$key = "<access token>" # replace with your access token
$authheader = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$authheader["X-Access-Token"] = "$($key)"
$authheader["Accept"] = "application/xml"

# request Rimscout for active alerts
[xml]$request = Invoke-RestMethod -Uri $url -Headers $authheader

# build XML structure for the custom sensor in PRTG
$XMLOutput = "<prtg>`n"
    $XMLOutput +="<result>`n"
        $XMLOutput +="<channel>Active Alerts</channel>`n"
        $XMLOutput +="<unit>Custom</unit>`n"
        $XMLOutput +="<customUnit>Active Alerts</customUnit>`n"
        $XMLOutput +="<mode>Absolute</mode>`n"
        $XMLOutput +="<float>0</float>`n"
        $XMLOutput +="<value>$($request.rimscoutapi.countactive)</value>`n" # the number of active alerts in Rimscout
        $XMLOutput +="<LimitMode>1</LimitMode>`n"   
        $XMLOutput +="<LimitMaxWarning>0</LimitMaxWarning>`n" # create warning if there is at least one active alert
    $XMLOutput +="</result>`n"
    if ($request.rimscoutapi.countactive -eq 0) {
        $XMLOutput += "<text>Script last run at $(Get-Date -Format 'd.M.yyyy HH:mm:ss')</text>`n"
    else { #provide further information about the active alerts, if there are any
        $XMLOutput += "<text>"
        foreach ($alert in $request.rimscoutapi.alerts.alert) {
            $XMLOutput += "$($ - $($alert.lastHealthStatus) - Since $($alert.activeForMinutes) Minutes;"
        $XMLOutput += "</text>`n"
$XMLOutput += "</prtg>"
return $XMLOutput


Learn more about custom PRTG sensors.

3) Create new sensor

  1. Choose a device in PRTG and create a new sensor for it.
  2. Select EXE/Script Advanced as sensor type
  3. Set the script for the entry EXE/Script under Sensor settings.
  4. Set the Scanning interval to 10 or 15 minutes.
  5. Set the remaining settings according to your needs.