SDK API Reference / JourneyStep

Interface: JourneyStep

Journey step definition

Properties

activationId?

optional activationId?: string

Activation ID reference

---

branches?

optional branches?: JourneyBranch[]

Decision branches

---

conditions?

optional conditions?: object[]

WaitStep conditions array (API response format for multi-condition wait steps)

moveAfter?

optional moveAfter?: number

segmentId?

optional segmentId?: string

timedOutPath?

optional timedOutPath?: boolean

unit?

optional unit?: string

---

conditionSegmentId?

optional conditionSegmentId?: string

Condition segment ID (legacy flat format)

---

conditionTimeoutDuration?

optional conditionTimeoutDuration?: number

Condition timeout duration (legacy flat format)

---

conditionTimeoutUnit?

optional conditionTimeoutUnit?: string

Condition timeout unit (legacy flat format)

---

customizedSplit?

optional customizedSplit?: boolean

Whether to use customized split percentages

---

duration?

optional duration?: number

Wait duration

---

id

id: string

Step ID

---

name?

optional name?: string

Step name

---

nextStepId?

optional nextStepId?: string | null

Next step ID (for linear flow)

---

target?

optional target?: object

Jump target

journeyId?

optional journeyId?: string

stageId?

optional stageId?: string

---

type

type: JourneyStepType

Step type

---

unit?

optional unit?: JourneyWaitUnit

Wait unit (day/week)

---

variants?

optional variants?: JourneyVariant[]

A/B test variants

---

waitCondition?

optional waitCondition?: object

Wait until condition

segmentId

segmentId: string

timeout?

optional timeout?: object

timeout.duration

duration: number

timeout.unit

unit: JourneyWaitUnit

---

waitUntil?

optional waitUntil?: string

Wait until specific date