Class AutomationRuleAttributes

Core attributes of an automation rule, including its name, trigger condition, action to execute, and current state.

Hierarchy

  • AutomationRuleAttributes

Constructors

constructor

Properties

action additionalProperties? createdAt modifiedAt? name state trigger

Constructors

constructor

Properties

action

action: AutomationRuleAction

Defines what happens when the rule triggers. Combines an action type with action-specific configuration data.

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

createdAt

createdAt: Date

Timestamp when the automation rule was created.

Optional modifiedAt

modifiedAt?: Date

Timestamp when the automation rule was last modified.

name

name: string

A human-readable name for the automation rule, used to identify the rule in the UI and API responses.

state

state: CaseAutomationRuleState

Whether the automation rule is active. Enabled rules trigger on matching case events; disabled rules are inactive but preserve their configuration.

trigger

trigger: AutomationRuleTrigger

Defines when the rule activates. Combines a trigger type (the case event to listen for) with optional trigger data (conditions that narrow when the trigger fires).

Settings

Member Visibility

Theme

Generated using TypeDoc