Webhook integration

What are Incident Parameters and Custom Parameters?

Incident and Custom parameters get passed along with the body of the URL during an HTTP request invocation.

Incident Parameters

Incident Parameters are predefined system parameters passed in the invoked URL's body. In the HTTP response, the Incident Parameters are substituted with the actual value of your specified monitor. Incident Parameters can be used as part of incident management. For example, in invoke URL actions within IT automation or in third-party integrations for customization and flexibility. 

You can refer to the list of incident parameters in the help documentation.
Notes
The $INCIDENT_DETAILS parameter is available only for RBL monitors.

Info
  1. The $MSP_CUSTOMER_NAME parameter will be accessible only to MSP users. Similarly, the $BU_NAME parameter will be shown only to Business Unit users. This parameter can be used to set up third-party integrations for different MSP and Business Unit customers.
  2. $MONITOR_DASHBOARD_LINK is not available for MSP admins or users.

Custom Parameters

Custom Parameters can be defined and passed along with your URL during an HTTP request. You can pass them as a Param name=value pair, wherein you can use Global Parameters to substitute it with a Constant or Dynamic value of your choice. You can utilize Custom Parameters for specific use cases in your third-party service portal for added flexibility. Custom parameters will be passed in a JSON in the same format you specified during the HTTP request. You can select a Custom Parameter in two different ways:

Custom Parameters syntax when specified in JSON format:

Syntax:
{
"param1" : "value1",
"token_type" : "${TOKEN_TYPE}",
"cx_type" : "${CX_TYPE}",
"api_key" : ${API_KEY}"
}



Select the checkbox Post as JSON to post the parameters in JSON format.
​
Custom Parameters syntax when specified as key-value:

Syntax:
param1 = value1 &
token_type = ${TOKEN_TYPE} &
cx_type = ${CX_TYPE} &
api_key = ${API_KEY}