AlertRule

No description

type AlertRule implements Node {
  deliverability: AlertRuleDeliverability!
  id: ID!
  deletedAt: Time
  name: String!
  alertType: AlertRuleAlertType!
  severity: AlertRuleAlertSeverity!
  enabled: Boolean!
  system: Boolean!
  systemKey: String
  resourceType: AlertRuleAlertResourceType!
  resourceID: String
  conditions: Map
  deliveryMode: AlertRuleAlertDeliveryMode!
  batchIntervalMinutes: Int!
  recipients: [AlertRecipient!]!
  botModeFilter: AlertRuleAlertBotModeFilter!
  cooldownMinutes: Int!
  lastTriggeredAt: Time
  ownerID: String!
  createdAt: Time!
  updatedAt: Time!
  events(
    after: Cursor
    first: Int
    before: Cursor
    last: Int
    orderBy: AlertEventOrder
    where: AlertEventWhereInput
  ): AlertEventConnection!
}

Fields

AlertRule.deliverability ● AlertRuleDeliverability! non-null object

AlertRule.id ● ID! non-null scalar

AlertRule.deletedAt ● Time scalar

Soft-delete timestamp. If set, record is considered deleted.

AlertRule.name ● String! non-null scalar

Human-readable rule name (e.g., 'Bot Error Alert')

AlertRule.alertType ● AlertRuleAlertType! non-null enum

Type of alert: status_change, trade_opened, trade_closed, etc.

AlertRule.severity ● AlertRuleAlertSeverity! non-null enum

Alert severity: critical, warning, info

AlertRule.enabled ● Boolean! non-null scalar

Whether this rule is active

AlertRule.system ● Boolean! non-null scalar

System-defined rule: cannot be deleted, only toggled or have delivery settings changed

AlertRule.systemKey ● String scalar

Unique key for system rules (e.g., 'system:bot-status-change'). Used with owner_id for dedup.

AlertRule.resourceType ● AlertRuleAlertResourceType! non-null enum

Type of resource: organization, bot, strategy, runner

AlertRule.resourceID ● String scalar

Resource ID - UUID for bot/strategy/runner, or organization alias for org-level rules

AlertRule.conditions ● Map scalar

Condition parameters: thresholds, status values, etc.

AlertRule.deliveryMode ● AlertRuleAlertDeliveryMode! non-null enum

Delivery mode: immediate or batched

AlertRule.batchIntervalMinutes ● Int! non-null scalar

Batch window in minutes (only used if delivery_mode=batched)

AlertRule.recipients ● [AlertRecipient!]! non-null object

List of recipients (email, user, or role)

AlertRule.botModeFilter ● AlertRuleAlertBotModeFilter! non-null enum

Filter by bot trading mode: all, live, dry_run

AlertRule.cooldownMinutes ● Int! non-null scalar

Minimum minutes between alerts of same type for same resource

AlertRule.lastTriggeredAt ● Time scalar

When this rule last triggered (for cooldown calculation)

AlertRule.ownerID ● String! non-null scalar

Organization ID that owns this rule

AlertRule.createdAt ● Time! non-null scalar

AlertRule.updatedAt ● Time! non-null scalar

AlertRule.events ● AlertEventConnection! non-null object

AlertRule.events.after ● Cursor scalar

Returns the elements in the list that come after the specified cursor.

AlertRule.events.first ● Int scalar

Returns the first _n_ elements from the list.

AlertRule.events.before ● Cursor scalar

Returns the elements in the list that come before the specified cursor.

AlertRule.events.last ● Int scalar

Returns the last _n_ elements from the list.

AlertRule.events.orderBy ● AlertEventOrder input

Ordering options for AlertEvents returned from the connection.

AlertRule.events.where ● AlertEventWhereInput input

Filtering options for AlertEvents returned from the connection.

Interfaces

Node interface

An object with an ID. Follows the Relay Global Object Identification Specification

Returned By

createAlertRule mutation ● toggleAlertRule mutation ● updateAlertRule mutation

Member Of

AlertEvent object ● AlertRuleEdge object