Rule.io SDK

---

Rule.io SDK / client/src / AutomationTrigger

Interface: AutomationTrigger

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

Trigger configuration for an automation.

The type field must be uppercase ('TAG' or 'SEGMENT'). The API error messages may suggest lowercase, but uppercase is required.

Properties

id

id: number

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

ID of the tag or segment that triggers this automation.

---

name?

optional name?: string

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

Name of the tag or segment (informational — not sent to the API).

---

type

type: "TAG" | "SEGMENT"

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

Trigger type. Must be uppercase.

'TAG' fires when a subscriber is assigned the tag. 'SEGMENT' fires when a subscriber enters the segment.