Skip to main content

Box Relay Workflows are objects that represent a named collection of flows.

Your application must be authorized to use the Manage Box Relay application scope within the developer console in order to use this resource.

id
string

The unique identifier for the workflow.

Example:

"11446498"

type
enum<string>

The value will always be workflow.

Available options:
workflow
Example:

"workflow"

name
string

The name of the workflow.

Example:

"New Hire Workflow"

description
string

The description for a workflow.

Example:

"This workflow sets off a new hire approval flow"

is_enabled
boolean

Specifies if this workflow is enabled.

Example:

true

flows
object[]

A list of flows assigned to a workflow.