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}



    • Related Articles

    • Preventing duplicate ticket creation in custom ticketing integrations via webhooks

      Issue Alerts sent from Site24x7 to a webhook fail with a 400 error and are marked as duplicate events by the third-party system. Common cause This issue is likely caused by a possible misconfiguration in the Update URL and Close URL settings of the ...

    • FAQ on Custom Roles

      What is the Created permission and what does it allow users to do? The Created permission is a specific type of access control that permits users to perform actions such as View, Write, or Delete solely on the modules, like dashboard, that they have ...

    • Global Parameters: List of supported Date and Time Components

      To configure a Global Parameter with a strategy Current Date and Time, you must specify the respective Date and Time pattern string in the Parameter Value field. Letters specified in the below table alone can be used to generate the pattern strings. ...

    • Difference between a website monitor and a SOAP Web Service monitor

      Website monitor will support monitoring of any web application via POST, GET and HEAD methods of configuration. Learn more on the performance metrics provided for a website monitor. SOAP Web Service monitors , on the other hand, lets you to ...

    • Monitor types that can be cloned using Site24x7 Clone option

      To create an exact copy of your existing monitor with the same configuration settings, you've to access the "Clone" functionality in the client. Most of the internet-facing services that Site24x7 supports can be cloned. Please find below the list of ...