← All types

JourneyVersion

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

Fields

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

TypeID of the journey this version belongs to (prefix jny).

version

Int!Non-null

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.

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.

Possible values (2)
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.

Compiled Journey JSON for the Surfaces runtime.

Exact authoring XML, available only to authors. On a Journey, the newest open draft takes precedence over the published version.

source

StringNullable

XML source envelope, available only to authors.

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

Referenced by (3)
Exact type SDL
"""
One immutable-once-published snapshot of a journey definition. The authoring history returned by `listJourneyVersions`.
"""
type JourneyVersion @iac_resource(name: "journey_version") @iac_replace(strategy: CREATE_BEFORE_DESTROY) @iac_guide(ref: "journey-authoring-guide") @iac_ops(create: "createJourneyVersionFromSource", read: "getJourneyVersion", delete: "deleteJourneyVersionIfExists") {
  """TypeID of this version (prefix `jnv`, e.g. "jnv_01K…")."""
  id: JourneyVersionID! @iac_identity(assignedBy: SERVER) @iac_computed
  """TypeID of the journey this version belongs to (prefix `jny`)."""
  journeyId: JourneyID! @iac_ref(resource: "journey", onTargetDelete: CASCADE) @iac_forcesReplace
  """
  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.
  """
  version: Int! @iac_computed
  """
  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.
  """
  status: JourneyStatus! @iac_computed
  """Compiled Journey JSON for the Surfaces runtime."""
  definition: String! @iac_computed
  """
  Exact authoring XML, available only to authors. On a Journey, the newest open draft takes precedence over the published version.
  """
  sourceXML: String @iac_forcesReplace @iac_artifact(language: XML, validators: ["journey-source"], models: ["journey_document"], description: "Journey document, including its steps and fields.")
  """XML source envelope, available only to authors."""
  source: String @iac_computed
  """
  ISO-8601 timestamp of when this version was first opened as a draft; publishing does not change it.
  """
  createdAt: ISO8601! @iac_computed
}