REreveldigital
Alerts

Gets a single alert rule by its ID.

Returns the full alert rule, including its rule set, device/user associations, and audit timestamps. The rule must belong to the authenticated account. Requires the AlertRules_View securable.

get/alerts/rules/{id}

Request

Path parameters

idstring required

The alert rule ID.

Response

The requested alert rule.

idstring nullable

The alert rule id (encrypted)

namestring nullable

The name of the alert rule

rule_setstring nullable

The rule set configuration as a JSON string. See AlertRuleInput.ruleSet for the full schema, supported condition types, operators, and value semantics.

is_enabledboolean nullable

Indicates whether the alert rule is currently enabled and will be evaluated. When false, the rule is stored but never triggers alerts.

periodinteger nullable

The look-back / evaluation period, in minutes, used by time-window based conditions.

thresholdinteger nullable

A legacy scalar threshold value retained for backward compatibility. Thresholds for new rules are expressed inside the rule set (AlertRuleInput.ruleSet) via each item's "value" instead.

webhook_urlstring nullable

Optional HTTPS webhook URL that is invoked (HTTP POST) when the rule triggers.

all_devicesboolean nullable

When true, the rule is evaluated against every device in the account and RevelDigital.Core.PublicApi.Models.AlertRule.DeviceIds is empty. When false, only RevelDigital.Core.PublicApi.Models.AlertRule.DeviceIds are evaluated.

all_usersboolean nullable

When true, all users in the account are notified and RevelDigital.Core.PublicApi.Models.AlertRule.UserIds is empty. When false, only the users in RevelDigital.Core.PublicApi.Models.AlertRule.UserIds are notified.

created_onstring date-time nullable

The date and time the alert rule was created

updated_onstring date-time nullable

The date and time the alert rule was last updated

device_idsstring[] nullable

The devices explicitly associated with the rule (encrypted ids). Empty when RevelDigital.Core.PublicApi.Models.AlertRule.AllDevices is true.

user_idsstring[] nullable

The users explicitly notified by the rule (encrypted ids). Empty when RevelDigital.Core.PublicApi.Models.AlertRule.AllUsers is true.

Changes

No recorded changes to this operation across all 3 revisions of this API.