REreveldigital
Alerts

Gets all alert rules for the authenticated account.

An alert rule defines the conditions that raise alerts for one or more devices. Results are scoped to the account associated with the API key and can be narrowed, paginated, and filtered using the query parameters below. Requires the AlertRules_View securable.

get/alerts/rules

Request

  • Base URL
    https://api.reveldigital.com
  • Auth
    • OAuth 2
      Authorization codehttps://id.reveldigital.com/connect/authorize
      Token URLhttps://id.reveldigital.com/connect/token
      Scopeswebapi
    • or API key in header X-RevelDigital-ApiKey
    • or API key in query parameter api_key
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

idstring

Optional single alert rule ID to filter by.

org_idstring

Optional organization ID to filter by.

takeinteger

Optional maximum number of rules to return (page size). Omit for the server default.

pageinteger

Optional 1-based page number, used together with take for pagination.

Response

The list of alert rules (may be empty).

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.