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. 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
| Variable | Value |
|---|---|
$_alertUUID | Unique identifier for the alert. |
$_alertName | Name of the alert. Set in the Kio App Alert Rule. |
$_alertType | Type of the alert. |
$_alertUrgency | Alert severity: critical, high, medium, low, or info. |
$_alertCreatedDate | Date and time the alert was triggered (ISO 8601). |
$_alertRuleName | Name of the Alert Rule. |
$_alertTriggeredByCondition | The condition that triggered the alert, as a readable sentence. |
$_alertResponseUrl | Link to a page showing the alert details, with acknowledge and resolve actions. |
Location
| Variable | Value |
|---|---|
$_alertCampus | Name of the campus where the alert occurred. |
$_alertCampusId | Identifier of the campus. |
$_alertBuilding | Name of the building. |
$_alertBuildingId | Identifier of the building. |
$_alertFloor | Name of the floor. |
$_alertFloorId | Identifier of the floor. |
$_alertRoom | Name of the room. |
$_alertRoomId | Identifier of the room. |
$_alertDepartment | Name of the department. |
$_alertDepartmentId | Identifier of the department. |
Triggering entity or device
| Variable | Value |
|---|---|
$_alertTriggeredBy | The entity or device that triggered the alert, formatted for display — for example, "IV Pump 12 (IV Pump: A-4021)". |
$_alertEntityName | Name of the entity that triggered the alert. |
$_alertEntityExternalId | Entity ID (External ID) of the entity that triggered the alert. |
$_alertDeviceName | Name of the Tag or device. |
$_alertDeviceMac | MAC address of the Tag or device. |
$_alertDeviceUniqueId | Unique ID of the Tag or device. |
Escalation
These carry details of the root alert in an escalation chain.
| Variable | Value |
|---|---|
$_alertRootAlertUUID | Identifier of the root alert. |
$_alertRootAlertName | Name of the root alert. |
$_alertRootAlertType | Type of the root alert. |
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"}