Schemas

Exactly one of topic_glob or brick_class - topic_glob for the original per-topic-string targeting, brick_class to target every point already classified into that Brick class (see mapping.classify_point) regardless of which topic/building/naming scheme it came from. fault_detector.py resolves a brick_class roster via SPARQL against the same Oxigraph graph mapping.py writes to, not against the topic string at all.

range only.

range only.

stuck only.

stale only.

Free-form (e.g. info/warning/critical) - not validated or enumerated server-side, the alarm console UI just displays whatever string was given. Defaults to warning if omitted. Copied onto each fault this rule opens at open time (see Fault.severity) - editing a rule's severity later doesn't relabel faults it already raised.

Server-generated (a hex string, distinct from name) - this is the value a webhook's filter.rule_id must match, not name.

Exactly one of topic_glob or brick_class - topic_glob for the original per-topic-string targeting, brick_class to target every point already classified into that Brick class (see mapping.classify_point) regardless of which topic/building/naming scheme it came from. fault_detector.py resolves a brick_class roster via SPARQL against the same Oxigraph graph mapping.py writes to, not against the topic string at all.

range only.

range only.

stuck only.

stale only.

Free-form (e.g. info/warning/critical) - not validated or enumerated server-side, the alarm console UI just displays whatever string was given. Defaults to warning if omitted. Copied onto each fault this rule opens at open time (see Fault.severity) - editing a rule's severity later doesn't relabel faults it already raised.

Used to HMAC-SHA256 sign every delivered payload (X-Baler-Signature header, sha256=... format). Send a real string when creating a webhook; always null when read back via GET /webhooks (shown as a real string exactly once, in the POST /webhooks response).

Omit or null to receive every fault. Currently supports scoping to one rule_id.

Used to HMAC-SHA256 sign every delivered payload (X-Baler-Signature header, sha256=... format). Send a real string when creating a webhook; always null when read back via GET /webhooks (shown as a real string exactly once, in the POST /webhooks response).

Present on GET /webhooks list responses only (absent on the POST /webhooks creation response). True once consecutive_failures has hit the auto-disable threshold (5) - see POST /webhooks/{id}/enable.

GET-only, see disabled.

GET-only, see disabled. The most recent delivery error, if any.

Omit or null to receive every fault. Currently supports scoping to one rule_id.

Copied from the rule's severity at the moment this fault opened. See POST /rules's severity field.

Set by POST /faults/{id}/ack. Null if never acked.

The X-User value (gateway-forwarded) at the time of the most recent ack.

Set by POST /faults/{id}/snooze. Null if not currently snoozed.