Creating webhook actions

TrueSight Intelligence provides alarms that are triggered when the monitored entity violates a defined threshold. You can configure each alarm to use one or more Actions, so that end users can be notified when a condition is breached. Create a webhook action to specify a web URL for receiving notifications from TrueSight Intelligence.

Use webhook URLs to create actions for third-party services. For example, use web services which allow you to automate actions to send alerts over SMS.


To create a webhook action

The details required to create an action vary depending on the action type. For example, you will need the OpsGenie API key for sending data, but only valid email addresses for sending email notifications.

  1. From the top right of the screen, click  > Notifications to access the actions and alarms.
  2. From the Actions tab, click Create Action.
  3. Type a unique Name for the action.
  4. Select webhook from the Action Type drop-down list.
  5. Select the HTTP Method (POST, PUT, GET, or DELETE) of the endpoint for the specified webhook URL.

  6. Type the complete Webhook URL that needs to be invoked.
    For example, http://host.com/path or https://host.com/path.

    HTTP and HTTPS are supported. However, for HTTPS URLs, only certificates issued from a Trusted Certificate Authority are supported.
  7. Type the Username and Password for authentication.
    Leave both the fields blank if basic authentication is not required.
  8. If you selected the POST data (or PUT) method, you can type the payload in a valid JSON format to be sent as part of the request.

    Note

    The payload will be ignored if the HTTP Method is set to GET or DELETE.

    If invalid JSON is found, “INVALID-JSON” will be sent with the request.

    In the JSON string, you can provide parameters which are replaced before making the request to the URL. Provide the parameters in the following format to replace them successfully - ${param-name}. When the string is encountered in the JSON string, it is replaced with its value and available as part of notification. If the parameter is not set for this notification then the value is displayed as “NOTSET”.

    For example,

    {

       “key1” : “Value1”,

       “AppId” : “${appId}”,

       “Source” : “${source}”

    }

    The following table lists parameters that you can use.

    Valid parameters

    appId

    eventId

    severity

    closedTime

    metric

    source

    createdTime

    notes

    state

    entityTypeId

    product

    status

    eventClass

    ruleDesc

    tenantId

    eventDesc

    ruleId

    title

  9. Click Save.

Where to go from here

After creating an action, you can either create another action or create an alarm.

Was this page helpful? Yes No Submitting... Thank you

Comments