Appearance
Journey
Type: Object
An instance-served journey: a guided, multi-step workflow the runner executes. The container record joined with the version it currently serves (published when one exists, else the open draft). Who may see and author it is decided by scope.
Fields
| Name | Type | Args | Description | Deprecated |
|---|---|---|---|---|
| createdAt | ISO8601! | ISO-8601 timestamp of when the journey was first created (its first draft). | ||
| definition | String! | The journey definition as a verbatim JSON document (spec schema 2). | ||
| handle | String! | Stable, tenant-unique slug taken from the definition's id — never supplied separately, and never reassigned once the journey exists. Used for deep links and anchored launches (getJourneyByHandle). | ||
| hasDraft | Boolean! | True when an unpublished draft exists for this journey. | ||
| id | JourneyID! | TypeID of the journey container record (prefix jny, e.g. "jny_01K…"). Stable across publishes; the individual versions have their own jnv ids. | ||
| ownerUserId | UserID | Owner of a PERSONAL journey; null for TEAM / INSTANCE. | ||
| publishedVersionId | JourneyVersionID | TypeID of the live published version (prefix jnv); null while the journey only has drafts. The same fact as version when published, as a reference — a version number is server-assigned, so only the id can be pointed at by configuration written before the version exists. | ||
| requiredDomains | [String!]! | Permission domains the caller must hold to be offered this journey, lifted out of the definition so unauthorised journeys are filtered server-side. Empty means no extra domain is required beyond the journey's scope. | ||
| scope | JourneyScope! | Distribution scope, which drives authorization: PERSONAL is visible to and authored by its owner alone (journey:personal, self-service); TEAM is visible to members of teamIds; INSTANCE is offered to the whole tenant. Authoring TEAM or INSTANCE requires journey:write. | ||
| status | JourneyStatus! | Computed lifecycle status: PUBLISHED when a live published version exists, otherwise DRAFT. Not stored on the journey — derived from its versions. | ||
| teamIds | [TeamID!]! | Teams a TEAM-scoped journey is assigned to. | ||
| updatedAt | ISO8601! | ISO-8601 timestamp of the last change to the journey — an edited draft, a publish, or a scope / team-assignment change. | ||
| version | Int! | Version number (1-based) of the version definition was taken from: the published version when published, else the open draft. 0 for a journey with no versions. |