• Products
  • Get started
  • Documentation
  • Resources

Parameter types for Opsgenie actions

Opsgenie Actions allow you to customize parameters. Action channels may include various of parameter types which can be easily configured via Parameter section of Manage Actions.

Predefined Parameters

Predefined is used for pre-determined value selection. If you select Predefined while creating your action, the values will be directly transferred to the corresponding action channel (AWS SSM or REST Endpoint). This option is useful whenever an alert requires repetitive response with a non-variable parameter values. As a use case, consider a server which triggers “Server is down” alert occasionally. Instead of restarting the server each time you receive the alert, an Opsgenie action can be defined. Once the parameters are defined on the action, you can easily execute it without entering all the relevant values whenever a “Server is down” alert is triggered.

You can see the details of Predefined Parameter Configuration below:

Field

Description

Parameter Name

Name of the parameter which is in free-form text format
(Predefined, non-editable for AWS SM Action Channel)

Type

Options: String, Boolean, Number, List

Provided value is validated according to value type while configuring the action
(Predefined, non-editable for AWS SM Action Channels)

Value

Value is provided in two ways:

Static text input
Dynamic alert fields

Required

AWS SM Action Channels contain the value from the AWS side and can not be edited
It is checked by default for other channels

Prompt User Parameters

Prompt User is another option for value selection. This option is useful to specify the values during the runtime. An alert related to the same service, instance, or server may require various response depending on the current situation of the alert.

In the Prompt User section, select either 'Drop-down list' or 'Free-form text' for input types. Drop-down list stores the given values as a list. At the run time, values are selected from the drop-down list which is created by the value input by users.

The free-form text does not store any value information, instead, it provides you to a text box to enter values at the run time.

If the parameter type is List, you will be asked to enter values for 'Checkbox' input type. Checkbox allows you to select multiple values during the action execution.

Prompt User Parameter Configuration:

Field

Field Pre-Condition

Description

Parameter Name

-

Name of the parameter which is in free-form text format
(Predefined, non-editable for AWS SM Action Channels)

Type

-

Options: String, Boolean, Number, List

Provided value is validated according to value type while configuring the action.
(Predefined, non-editable for AWS SM Action Channels)

Value

-

Value is taken from the customer at run time

For AWS SM, it contains the value from AWS side and can not be edited

It is checked by default for other channels

Required

-

For AWS SM, it contain sthe value from AWS side and can not be edited

It is checked by default for other channels

Description

-

Value description (optional)

Input Type

Values must be provided if drop down or checkbox options are selected

Drop down or free-form text options are available for String, Number and Boolean parameter types.

Checkbox option is only available for List type.

Please note that action policies cannot work with Prompt user parameters. Predefined parameters are mandatory to execute action policies.

Last modified on Apr 1, 2021
Cached at 12:01 AM on Apr 13, 2021 |

Additional Help

Ask the Community