This is Step 3 in the procedure for creating Webhook endpoints triggered from an incident or an alert workflow.
Complete the Endpoint configuration:
Select the request method (POST, PATCH, DELETE, PUT) to use to send data to the target system when an incident or alert triggers the webhook endpoint from a workflow.
The URL of the endpoint on the external target system that receives information from APEX AIOps Incident Management.
Select the way to authenticate with your target system.
You can choose from:
No auth
Basic Auth
Bearer Token
OAuth
The Incident Management webhook endpoint currently only supports the OAuth 2.0 password grant type. Refer to OAuth Community Site for more on OAuth.
Then, select the credential to use for this webhook endpoint from the list that appears to the right.
If you need to add new credentials, click Add New Credentials. The credential information you add is stored in the secure and encrypted Credential Store, where it can be reused.
By default, headers include Content-Type: application/json
. If there is other information that you would like to include in headers, you can define it here by clicking Add New Row. You can include as many additional rows as you need.
Headers consist of key : value pairs, where the key is the name of the header and the value is the contents.
You can use substitution syntax in both the key and value fields of a header. This is useful if you want the contents of your header to include field values from the incident or alert that triggers your webhook endpoint. Note that the contents of the key field cannot be a list.
Example: Suppose your webhook endpoint is triggered by incidents that have the following property1
tag:
"tags": {
"property1": [
"string"
]
}
To substitute property1
in the value field of a webhook endpoint header, you can create a new header with the following key : value pair:
key:
headerName
value:
The value of property1 is ${tags.property1[0]}
For more examples and information on using substitution syntax, read Substitution syntax.