Rule.io SDK

---

Rule.io SDK / client/src / Automation

Interface: Automation

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

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:108

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:129

ISO 8601 timestamp of when the automation was created.

---

description?

optional description?: string

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

Optional description.

---

id?

optional id?: number

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

Automation ID.

Optional because the API may omit it in partial responses.

---

name

name: string

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

Human-readable automation name.

---

sendoutType?

optional sendoutType?: AutomationSendoutType

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

Sendout type: 'marketing' or 'transactional'.

Mapped from the API's numeric status descriptor object.

---

tagActionsOnFinish

tagActionsOnFinish: AutomationFinishTag[]

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

Tags attached to or removed from the subscriber once this automation completes for them.

[] if no finish tags are configured.

---

trigger?

optional trigger?: AutomationTrigger | null

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

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:131

ISO 8601 timestamp of when the automation was last updated.