Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / Automation

Interface: Automation

Defined in: client/src/resources/automations/automations.types.ts:53

An automation entity as returned by the API.

Properties use camelCase; the wire format is normalised by the SDK.

Properties ​

active? ​

optional active?: boolean

Defined in: client/src/resources/automations/automations.types.ts:70

Whether the automation is active.

Inactive automations are paused — they do not fire even when the trigger condition is met.

createdAt? ​

optional createdAt?: string

Defined in: client/src/resources/automations/automations.types.ts:84

ISO 8601 timestamp of when the automation was created.

description? ​

optional description?: string

Defined in: client/src/resources/automations/automations.types.ts:63

Optional description.

id? ​

optional id?: number

Defined in: client/src/resources/automations/automations.types.ts:59

Automation ID.

Optional because the API may omit it in partial responses.

name ​

name: string

Defined in: client/src/resources/automations/automations.types.ts:61

Human-readable automation name.

sendoutType? ​

optional sendoutType?: AutomationSendoutType

Defined in: client/src/resources/automations/automations.types.ts:82

Sendout type: 'marketing' or 'transactional'.

Mapped from the API's numeric status descriptor object.

trigger? ​

optional trigger?: AutomationTrigger | null

Defined in: client/src/resources/automations/automations.types.ts:76

The trigger that activates this automation.

null means the automation has no trigger (disabled or default state).

updatedAt? ​

optional updatedAt?: string

Defined in: client/src/resources/automations/automations.types.ts:86

ISO 8601 timestamp of when the automation was last updated.