Skip to main content

Set Description action

Available for alert and incident workflows

This action sets the description field of an alert or incident based on a specified template.

This action takes the following inputs:

  • Description Template

    The template to use for setting the description. This template can refer to other fields and tags using the following format: ${property_name}

    You can also include macros using the following format: ${macro_name(property_name)}

    Multiple fields and tags can be referenced in the same template.

Alert example

Suppose you want to prepend the phrase "In maintenance: " to the descriptions of alerts which are created during a maintenance window. You can do this with an alert workflow that includes a trigger and a Set Description action.

  1. Configure the workflow trigger:

    Select New alerts only.

    Add the following filter:

    "in_maintenance" = true
  2. Add the Set Description action to the workflow, using this description template:

    In maintenance: ${description}

Alert before

Alert after

{
    "source": "my_source",
    "in_maintenance": "true",
    "description": "mgapp service not responding",
    ...
}
{
    "source": "my_source",
    "in_maintenance": "true",
    "description": "In maintenance: mgapp service not responding",
    ...
}