SDK API Reference / JourneyStage

Interface: JourneyStage

Journey stage definition

Properties

description?

optional description: string | null

Stage description

---

entryCriteria?

optional entryCriteria: JourneyCriteria | null

Entry criteria - who enters this stage

---

exitCriteria?

optional exitCriteria: JourneyCriteria[]

Exit criteria - conditions to remove from stage

---

id

id: string

Stage ID

---

milestone?

optional milestone: JourneyCriteria | null

Milestone tracking point

---

name

name: string

Stage name

---

steps?

optional steps: Record<string, JourneyStep> | JourneyStep[]

Steps within this stage. Note: API returns object keyed by UUID, but internal code may use array.