Webhook
Webhook notifications enable integrations with external systems over HTTP. It supports JSON and YAML payloads that can be sent using POST or PUT requests.
You can find Webhook URLs by clicking Notifications > Targets.
-
To see available Webhook targets, click
. -
To create a new Webhook target, click
and then provide your settings.Note
You can share targets across your configured notifications.
Authentication Copied
Currently, the Webhook integration only supports basic (username/password) authentication.
Payloads Copied
Payloads are validated based on the selected content type. Placeholders can be used, which will then be interpolated by the app at runtime.
Some placeholders are JSON objects that should not be quoted or included as part of a string. These are:
${entity}${dimensions}
A valid payload using these placeholders is:
{
"entity": ${entity},
"dimensions": ${dimensions}
}
When interpolated:
{
"entity": {
"dimensions": {
"container": "obcerv-app-notifications"
}
},
"dimensions": {
"container": "obcerv-app-notifications"
}
}
Even though the configured payload is not strictly valid JSON, the app will ensure that it is valid post-interpolation of any placeholders. If not, an error will be shown upon saving.
The following placeholders are integers and can be used without quotes:
${triggeredCount}${criticalCount}${warningCount}${clearedCount}
For example:
{
"Triggered Entities": ${triggeredCount},
"Entities in Critical State": ${criticalCount},
"Entities in Warning State": ${warningCount}
}
When interpolated:
{
"Triggered Entities": 10,
"Entities in Critical State": 4,
"Entities in Warning State": 6
}