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

---

exitCriterias?

optional exitCriterias?: JourneyCriteria[]

Exit criteria (API response field name — has trailing "s")

---

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.