Box Developer Documentation
Log in

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

Register now!

Workflow

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
11446498

The unique identifier for the workflow

string
workflow

workflow

Value is always workflow

string
This workflow sets off a new hire approval flow

The description for a workflow.

object array

A list of flows assigned to a workflow.

string
12345

The identifier of the flow

string
flow

The flow's resource type

Value is always flow

string (date-time)
2012-12-12T10:53:43-08:00

When this flow was created

User (Base) object

The user who created this flow

object array

Actions that are completed once the flow is triggered

string
12345

The identifier of the outcome

string
outcome

The outcomes resource type

Value is always outcome

string
assign_task

The 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

object array

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

string
12345

The identifier of the outcome

string
outcome

The outcomes resource type

Value is always outcome

string
assign_task

The 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

string
Approval Rejection Outcome

The name of the outcome

string
Task Approval Outcome

The name of the outcome

object

Trigger that initiates flow

string
trigger

The trigger's resource type

Value is always trigger

object array

List of trigger scopes

string
trigger_scope

The trigger scope's resource type

Value is always trigger_scope

object

The object the ref points to

string
/event/source/parameters/folder

Indicates the path of the condition value to check

string
WORKFLOW_MANUAL_START

The type of trigger selected for this flow

Value is always WORKFLOW_MANUAL_START

boolean
true

Specifies if this workflow is enabled

string
New Hire Workflow

The name of the workflow

Response Example

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