← All resources

Resource

journey_version

One immutable-once-published snapshot of a journey definition. The authoring history returned by listJourneyVersions.

GraphQL reference →

Configuration

journeyIdJourneyID!Required

Parent journey that will own the new immutable source version.

References journey

forces replacement

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.

forces replacement

Read-only values

Show values
idJourneyVersionID!Read only

TypeID of this version (prefix jnv, e.g. "jnv_01K…").

computed by the platform

versionInt!Read only

Monotonic version number within the journey, starting at 1. A new draft takes the next number; re-saving an open draft overwrites it in place, so numbers are not consumed per edit.

computed by the platform

statusJourneyStatus!Read only

DRAFT before publication and never served to runners; PUBLISHED once publishJourney promotes it, after which it is immutable. Several DRAFT versions may be open at once — editing amends the newest editable draft, while createJourneyVersion mints a fixed source snapshot — and publishing promotes the one it names, leaving the rest open.

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

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

createdAtISO8601!Read only

ISO-8601 timestamp of when this version was first opened as a draft; publishing does not change it.

computed by the platform

Lifecycle

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

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