Workflow - Box Dev Docs

API version 2024.0 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.

This resource has a few variations that can be encountered when using the API.The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.

string

example: 11446498The unique identifier for the workflow.

type

string

example: workflowThe value will always be workflow.Value is always workflow

description

string

example: This workflow sets off a new hire approval flowThe description for a workflow.

flows

object[]

A list of flows assigned to a workflow.

Show child attributes

string

example: 12345The identifier of the flow.

type

string

example: flowThe flow’s resource type.Value is always flow

created_at

string(date-time)

example: 2012-12-12T10:53:43-08:00When this flow was created.

created_by

User (Base)object

The user who created this flow.

outcomes

object[]

Actions that are completed once the flow is triggered.

Show child attributes

string

example: 12345The identifier of the outcome.

type

string

example: outcomeThe outcomes resource type.Value is always outcome

action_type

string

example: assign_taskThe type of outcome.Value is one of add_metadata,assign_task,copy_file,copy_folder,create_folder,delete_file,delete_folder,lock_file,move_file,move_folder,remove_watermark_file,rename_folder,restore_folder,share_file,share_folder,unlock_file,upload_file,wait_for_task,watermark_file,go_back_to_step,apply_file_classification,apply_folder_classification,send_notification

if_rejected

object[]

If action_type is assign_task and the task is rejected, returns a list of outcomes to complete.

Show child attributes

string

example: 12345The identifier of the outcome.

type

string

example: outcomeThe outcomes resource type.Value is always outcome

action_type

string

name

string

example: Approval Rejection OutcomeThe name of the outcome.

name

string

example: Task Approval OutcomeThe name of the outcome.

trigger

object

Trigger that initiates flow.

Show child attributes

type

string

example: triggerThe trigger’s resource type.Value is always trigger

scope

object[]

List of trigger scopes.

Show child attributes

type

string

example: trigger_scopeThe trigger scope’s resource type.Value is always trigger_scope

object

The object the ref points to.

ref

string

example: /event/source/parameters/folderIndicates the path of the condition value to check.

trigger_type

string

example: WORKFLOW_MANUAL_STARTThe type of trigger selected for this flow.Value is always WORKFLOW_MANUAL_START

is_enabled

boolean

example: trueSpecifies if this workflow is enabled.

name

string

example: New Hire WorkflowThe name of the workflow.

{
  "id": "11446498",
  "type": "workflow",
  "description": "This workflow sets off a new hire approval flow",
  "flows": [
    {
      "created_at": "2012-12-12T10:53:43-08:00",
      "created_by": {
        "id": "11446498",
        "type": "user"
      },
      "id": "12345",
      "outcomes": [
        {
          "action_type": "assign_task",
          "id": "12345",
          "if_rejected": [
            {
              "action_type": "assign_task",
              "id": "12345",
              "name": "Approval Rejection Outcome",
              "type": "outcome"
            }
          ],
          "name": "Task Approval Outcome",
          "type": "outcome"
        }
      ],
      "trigger": {
        "scope": [
          {
            "object": {
              "id": "12345",
              "type": "folder"
            },
            "ref": "/event/source/parameters/folder",
            "type": "trigger_scope"
          }
        ],
        "trigger_type": "WORKFLOW_MANUAL_START",
        "type": "trigger"
      },
      "type": "flow"
    }
  ],
  "is_enabled": true,
  "name": "New Hire Workflow"
}