---
title: "Workflow Supplier"
canonical: "https://support.appfire.com/space/CDML/649726882/Workflow%20Supplier"
format: markdown
---
> Macro (aura-html)


## Overview

> Macro (excerpt)
> 
> Provides workflow information to third party apps

The Workflow Supplier provides workflow information to third-party apps, such as the [Reporting for Confluence app](https://marketplace.atlassian.com/apps/186/reporting-for-confluence?tab=overview&hosting=datacenter), using the [Confluence Supplier Library](https://appfire.atlassian.net/wiki/spaces/REPS/pages/472914152).

## Examples

Some examples are listed in our [Integration Guides: Reporting for Confluence app](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649759324) page.

## Details

| Name | **Workflow Supplier** |
| --- | --- |
| Prefix | `workflow` (optional) |
| Supported Content | Confluence **Pages**, **News** (blog posts), **[States](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649595551)**, **[Tasks](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649694408)** and **[Approvals](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650153766)** |

## Supported keys

| Key | Content Types | Return Type | Description | Notes |
| --- | --- | --- | --- | --- |
| `state` | Pages and News items | **[State](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649957742)** | Current workflow state of the page or blog post. |  |
| `states > all` | Pages and News items | [List](https://appfire.atlassian.net/wiki/spaces/SUPSR/pages/479035989) of **[State](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649957742)** | A list of all states the content (page or blog post) has been transitioned through.<br>List order: Oldest → Newest (the last object in the list is the current workflow state). | **DEPRECATED** from<br>**7.0.0+** |
| `states > StateName` | Pages and News items | [List](https://appfire.atlassian.net/wiki/spaces/SUPSR/pages/479035989) of *specified* **[State](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649957742)** | A list of all the state objects of the specified StateName which have occurred for the current content (page or blog post).<br>List order: Oldest → Newest. | **DEPRECATED** from<br>**v7.0.0+** |
| `approvals` | Pages and News items | [List](https://appfire.atlassian.net/wiki/spaces/SUPSR/pages/479035989) of *approved* **[Approval](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649663204)** | A list of all approved content reviews for the current state of the workflow. |  |
| You can get a list of all approvals via a **[State](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649957742)** object. |  |
| `tasks` | Pages and News items | [List](https://appfire.atlassian.net/wiki/spaces/SUPSR/pages/479035989) of *active*** ****[Task](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649793989)** | A list of all tasks for the current state of the workflow, filtered to those that are not yet complete. |  |
| You can get access to all tasks and completed tasks via a **[State](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649957742)** object. |  |
| `metadata > ValueName` | Pages and News items | [Text](https://appfire.atlassian.net/wiki/spaces/SUPSR/pages/479035980) | Retrieve a value set by the **[set-metadata](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650251172)** macro or the [Comala Metadata app](https://marketplace.atlassian.com/plugins/org.andya.confluence.plugins.metadata/datacenter/overview).<br>For more information, see [Metadata references](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649925583). |  |

## Related objects

> Macro (children)

## See also

**Comala Document Management**

[Integration Guides](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649396230)

- [Reporting for Confluence app](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649759324)
- [Scaffolding Forms and Templates app](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650315581)

[Workflow Authoring Guide](https://appfire.atlassian.net/wiki/spaces/CDML/pages/648611901)

- [Supplier References](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649532510)

**External Links**

- [Supplier Documentation](https://appfire.atlassian.net/wiki/spaces/REPS/pages/472914152)
- [Developer Guide for creating custom suppliers](https://appfire.atlassian.net/wiki/spaces/REPS/pages/472914669)
- [Collection Supplier](https://appfire.atlassian.net/wiki/spaces/SUPSR/pages/479035989)
- [Text Supplier](https://appfire.atlassian.net/wiki/spaces/SUPSR/pages/479035980)