Resource
journey_version
One immutable-once-published snapshot of a journey definition. The authoring history returned by listJourneyVersions.
Configuration
journeyIdJourneyID!RequiredParent journey that will own the new immutable source version.
References journey
forces replacement
sourceXMLjourney_documentRequiredJourney document, including its steps and fields.
journey_document fields
The root element: a guided process made of ordered stages
estimatedMinutesOptionalApproximate time to complete, in whole minutes.
iconOptionalIcon shown with the journey. Defaults to generic.
- Allowed values
["device","network","customer","order","job","note","wrench","check","flag","generic"]
idRequiredStable handle for the journey, unique on the instance. Saved progress refers to it, so choose it before publishing.
inputsOptionalinvariantsOptionalknowledgeCaptureTemplateOptionaloutputsOptionalrequiredDomainsOptionalstepsRequired- Minimum items
1- Maximum items
9223372036854776000
summaryOptionaltitleRequiredName shown to users.
Only the fields listed here are accepted.
forces replacement
Read-only values
Show values
idJourneyVersionID!Read onlyTypeID of this version (prefix jnv, e.g. "jnv_01K…").
computed by the platform
versionInt!Read onlyMonotonic 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 onlyDRAFT 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 onlyCompiled Journey JSON for the Surfaces runtime.
computed by the platform
sourceStringRead onlyXML source envelope, available only to authors.
computed by the platform
createdAtISO8601!Read onlyISO-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.