← All resources

Resource

journey

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.

GraphQL reference →

Configuration

publishedVersionIdJourneyVersionIDOptional

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.

References journey_version

written by `publishJourney`, not by this resource's update

scopeJourneyScope!Optional

Visibility and ownership scope for the new journey; omitted scope follows native journey creation defaults.

Allowed values

PERSONAL — Owned by one user and visible only to them. Self-service: authoring it needs journey:personal rather than journey:write, and journey:write is not a backdoor into someone else's personal journey.

TEAM — Offered to the members of the teams it is assigned to; at least one team is required. Authoring it needs journey:write.

INSTANCE — Offered to everyone in the tenant whose permissions cover its requiredDomains. The default scope when none is given, and what bundled journeys use; authoring it needs journey:write.

teamIds[TeamID!]!Optional

Teams to assign to a TEAM-scoped journey, validated using native journey authorization.

References team

sourceXMLjourney_documentRequired

Journey document, including its steps and fields.

journey_document fields

Open model reference →

The root element: a guided process made of ordered stages

object
estimatedMinutesOptional

Approximate time to complete, in whole minutes.

integer
iconOptional

Icon shown with the journey. Defaults to generic.

string
Allowed values
["device","network","customer","order","job","note","wrench","check","flag","generic"]
idRequired

Stable handle for the journey, unique on the instance. Saved progress refers to it, so choose it before publishing.

string
inputsOptional
array
Minimum items
0
Maximum items
9223372036854776000
List items
invariantsOptional
array
Minimum items
0
Maximum items
9223372036854776000
List items
knowledgeCaptureTemplateOptional
outputsOptional
array
Minimum items
0
Maximum items
9223372036854776000
List items
requiredDomainsOptional
array
Minimum items
0
Maximum items
9223372036854776000
List items
stepsRequired
summaryOptional
titleRequired

Name shown to users.

string

Only the fields listed here are accepted.

Read-only values

Show values
revisionInt!Read only

Monotonic authoring revision used as the expectedRevision precondition for concurrent edits.

computed by the platform

idJourneyID!Read only

TypeID of the journey container record (prefix jny, e.g. "jny_01K…"). Stable across publishes; the individual versions have their own jnv ids.

computed by the platform

handleString!Read only

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).

computed by the platform

statusJourneyStatus!Read only

Computed lifecycle status: PUBLISHED when a live published version exists, otherwise DRAFT. Not stored on the journey — derived from its versions.

Allowed values

DRAFT — An editable, unpublished version; never served to runners. On the journey record it means no published version exists yet.

PUBLISHED — An immutable, live version — the only status runners fetch. On the journey record it means a live published version exists, even when a newer draft is open beside it.

computed by the platform

versionInt!Read only

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.

computed by the platform

requiredDomains[String!]!Read only

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.

computed by the platform

ownerUserIdUserIDRead only

Owner of a PERSONAL journey; null for TEAM / INSTANCE.

References service_account

computed by the platform

definitionString!Read only

Compiled Journey JSON for the Surfaces runtime.

computed by the platform

sourceStringRead only

XML source envelope, available only to authors.

computed by the platform

hasDraftBoolean!Read only

True when an unpublished draft exists for this journey.

computed by the platform

createdAtISO8601!Read only

ISO-8601 timestamp of when the journey was first created (its first draft).

computed by the platform

updatedAtISO8601!Read only

ISO-8601 timestamp of the last change to the journey — an edited draft, a publish, or a scope / team-assignment change.

computed by the platform

Lifecycle

The CLI can create this resource. The platform assigns its id.

When replacement is needed, the existing resource is removed before its replacement is created.