Breadcrumbs

Officially supported content properties

Workflows stores a number of content properties on Confluence content. Historically, these properties were considered internal implementation details and were neither officially documented nor supported.

Because content properties are accessible through the Confluence REST API, users have nevertheless used Workflows content properties to build external automations, integrations, and reporting tools. While these integrations often worked successfully, the underlying properties were undocumented, outside our support scope, and not guaranteed to remain stable over time.

We recognise the value of these use cases and are now formalising support for a defined set of Workflows content properties. The properties documented here are part of the supported public contract for Workflows and are intended for long-term external use.

Any additions, edits, and/or removals to these content properties will be documented with advance notice being given to users.

Any content properties outwith this document remain unsupported and are subject to change without notice.

Content properties

For pages that pre-date the introduction date on each of the content properties below, property data may not be present and up-to-date until the documented conditions have been met on the page post-introduction.


Latest Finalised Official Version

Data about the latest official version which has been approved and finalised on the page.

Name

latestFinalisedOfficialVersion

Introduced

Schema

 
latestFinalisedOfficialVersion: {
  majorVersion: number,
  minorVersion: number,
  createdAtConfluenceVersion: number,
  finalisedAtConfluenceVersion: number,
}

  • majorVersion - the major part of the Workflows Official Version, e.g., 3 in the case of v3.1.

  • minorVersion - the minor part of the Workflows Official Version, e.g., 1 in the case of v3.1.

  • createdAtConfluenceVersion - the Confluence page version at the time this Workflows Official Version was created (i.e., the Create official version step was transitioned from).

  • finalisedAtConfluenceVersion - the Confluence page version at the time this Workflows Official Version was finalised (i.e., the Finalise official version action was ran).

Conditions

  • This content property is only present on Confluence pages where at least one official version has been finalised on the page.

  • The data in this content property will persist until another official version is finalised, at which point the data is updated.


:question_mark:

Need programmatic access to Workflows data that doesn’t exist yet? Feel free to reach out to our service desk to file a feature request; we would love to hear about your use case!

Need support? We’re here to help 🧡

If you have any questions or would like to speak with us about Workflows, please don’t hesitate to reach out to our Customer Support team.