Join BoxWorks 2024 to discover what's possible with content and AI!

Workflow (Mini)

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

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

This resource has a few variations that can be encountered when using the API.

The fields that are part of the mini variant are generally returned when the resource is nested within the response for another resource.

id string

example11446498

The unique identifier for the workflow

type string

exampleworkflow

workflow

Value is always workflow

description string

exampleThis workflow sets off a new hire approval flow

The description for a workflow.

is_enabled boolean

exampletrue

Specifies if this workflow is enabled

name string

exampleNew Hire Workflow

The name of the workflow

Response Example

{
  "id": "11446498",
  "type": "workflow",
  "description": "This workflow sets off a new hire approval flow",
  "is_enabled": true,
  "name": "New Hire Workflow"
}