WebhookPayloadParameterState

WebhookPayloadParameterState
WebhookPayloadParameterState

A representation of the available parameters of the webhook payload

JSON Example 
{
    "template": "ALERT",
    "payloadParameters": {
        "severity": {
            "isRequired": true,
            "description": "The severity of alert instance.",
            "exampleString": "warning"
        },
        "resultsUrl": {
            "isRequired": true,
            "description": "The URL where a user can view more information about the alert that was triggered.",
            "exampleString": " https://www.mgmt.cloud.vmware.com/li/#/alerts/edit?instance=/vrlic/api/v1/alert/instances/19ea6d0602bbf275556d93ddd589ra"
        },
        "alertType": {
            "isRequired": false,
            "description": "EVERY_MATCH/WINDOWED",
            "exampleString": ""
        },
        "hitCount": {
            "isRequired": false,
            "description": "Threshold in Trigger Definition",
            "exampleString": "5"
        },
        "description": {
            "isRequired": true,
            "description": "A description of the alert that was triggered.",
            "exampleString": "The purpose of this alert is to send notification"
        },
        "recommendations": {
            "isRequired": false,
            "description": "Recommendations Steps when this alert got triggered.",
            "exampleString": "Restart the service when resource utilisation is more"
        },
        "searchPeriod": {
            "isRequired": false,
            "description": "Search Period in MilliSeconds for Windowed Alerts.",
            "exampleString": "60000"
        },
        "sourceInfo": {
            "isRequired": true,
            "description": "The URL of the service that generated the alert.",
            "exampleString": "This alert is from https://www.mgmt.cloud.vmware.com/li"
        },
        "name": {
            "isRequired": true,
            "description": "The name of the alert that was triggered",
            "exampleString": "test_alert"
        },
        "additionalInfo": {
            "isRequired": false,
            "description": "JSON string with additional information about the alert",
            "exampleString": "[{\"appname\":\"test\",\"count(*)\":\"1930\"}]"
        },
        "hitOperator": {
            "isRequired": false,
            "description": "Operator in Trigger Definition",
            "exampleString": "GREATER_THAN"
        },
        "additionalInfoJson": {
            "isRequired": false,
            "description": "JSON object with additional information about the alert.",
            "exampleString": "[{\"appname\":\"test\",\"count(*)\":\"1930\"}]"
        },
        "triggeredAt": {
            "isRequired": true,
            "description": "The time when alert was triggered, in the format \"11 Aug 2017 at 6:20 PM UTC\"",
            "exampleString": "11 Aug 2017 at 6:20 PM UTC"
        }
    }
}
string
template
Optional

Template for notification types, which includes: ALERT, SYSTEM_ALERT

Possible values are : ALERT, SYSTEM_ALERT,
object
payloadParameters
Optional

Parameters available for a template

Parameter To
Returned By