Content Management API > Workflow

Workflow

Through workflows it is possible to set up a precise state machine able to bring a draft content up to the final publication (and beyond), through a series of intermediate, fully customizable approval steps.

Object payload

id string

RFC 4122 UUID of workflow expressed in URL-safe base64 format

Example:

"uJzC2b6YQg-DW2A5edpQYQ"

type string

Must be exactly "workflow".

name string

The name of the workflow

Example:

"Approval by editors required"

stages

The stages of the workflow

Type: Array<object>

Example:

[{ id: "waiting_for_review", name: "Waiting for review", initial: true }]

id string

ID of the stage

Example:

"waiting_for_review"

name string

Name of the stage

Example:

"Waiting for review"

description string, null

Description of the stage

Example:

"Editor has finished writing and is waiting for approval from a supervisor"

initial boolean

Whether this is the initial stage or not

api_key string

Workflow API key

Example:

"approval_by_editors"

Available endpoints

Did this doc help you?

Need help?

Explore our forum, contact support, or connect with our sales team . You can also chat live with other users in our Slack channel.