Webhook built-in variables reference

This reference lists the built-in variables available in a webhook payload, header, or URL parameter.

Built-in variables are populated automatically from the Alert Rule event that triggers the webhook. They appear under the Built-in group when you edit a webhook and cannot be edited or deleted. Which variables appear depends on the Apps selected on the webhook — a webhook with no App selected offers only the few that apply to every alert, while selecting an App such as Temperature Monitoring adds the variables specific to it. To see the ones available for the Apps you have selected, type $ in the Payload field. To include one, insert it where you want the value to appear — for example, $_alertName — and the platform substitutes the value when the request is sent. All built-in variable values are text.

Alert

Location

Triggering entity or device

Escalation

These carry details of the root alert in an escalation chain.

Example payload

The following payload body references built-in variables alongside a custom variable ($testCustomVariable):

{"text":"Alert: $_alertUUID ($_alertType) - $_alertName
Created at: $_alertCreatedDate
Location: $_alertCampus > $_alertBuilding > $_alertFloor > $_alertRoom
Triggered by: $_alertTriggeredBy
Condition: $_alertTriggeredByCondition
Alert Rule: $_alertRuleName
Urgency: $_alertUrgency
Custom info: $testCustomVariable"}