Box is a cloud content management and file sharing service that enables businesses to securely store, manage, and collaborate on documents.

Categories: File Storage

Type: box/v1

Connections

Version: 1

OAuth2 Authorization Code

Properties

Name	Label	Type	Description	Required
clientId	Client Id	STRING		true
clientSecret	Client Secret	STRING		true

Actions

Create Folder

Name: createFolder

Creates a new empty folder within the specified parent folder.

Properties

Name	Label	Type	Description	Required
name	Folder Name	STRING	`The name for the new folder.`	true
id	Parent Folder ID	STRING	`ID of the folder where the new folder will be created; if no folder is selected, the folder will be created in the root folder.`	true

Example JSON Structure

{
  "label" : "Create Folder",
  "name" : "createFolder",
  "parameters" : {
    "name" : "",
    "id" : ""
  },
  "type" : "box/v1/createFolder"
}

Output

Type: OBJECT

Properties

Name	Type	Description
type	STRING	This is always set to folder.
id	STRING	ID of the new folder.
name	STRING	Name of the new folder.
parent	OBJECT Properties {STRING(type), STRING(id), STRING(name)}	Folder that new folder is located within. This value may be null for some folders such as the root folder or the trash folder.

Output Example

{
  "type" : "",
  "id" : "",
  "name" : "",
  "parent" : {
    "type" : "",
    "id" : "",
    "name" : ""
  }
}

Download File

Name: downloadFile

Download a selected file.

Properties

Name	Label	Type	Description	Required
id	Parent Folder ID	STRING	`ID of the folder from which you want to download the file.`	true
fileId	File ID	STRING Depends On id	`ID of the file to download.`	true

Example JSON Structure

{
  "label" : "Download File",
  "name" : "downloadFile",
  "parameters" : {
    "id" : "",
    "fileId" : ""
  },
  "type" : "box/v1/downloadFile"
}

Output

Type: FILE_ENTRY

Properties

Name	Type	Description
extension	STRING
mimeType	STRING
name	STRING
url	STRING

Output Example

{
  "extension" : "",
  "mimeType" : "",
  "name" : "",
  "url" : ""
}

Upload File

Name: uploadFile

Uploads a small file to Box.

Properties

Name	Label	Type	Description	Required
id	Parent Folder ID	STRING	`ID of the folder where the file should be uploaded; if no folder is selected, the file will be uploaded in the root folder.`	true
file	File	FILE_ENTRY		true

Example JSON Structure

{
  "label" : "Upload File",
  "name" : "uploadFile",
  "parameters" : {
    "id" : "",
    "file" : {
      "extension" : "",
      "mimeType" : "",
      "name" : "",
      "url" : ""
    }
  },
  "type" : "box/v1/uploadFile"
}

Output

Type: OBJECT

Properties

Name	Type	Description
entries	ARRAY Items [{STRING(type), STRING(id), STRING(name), {STRING(type), STRING(id), STRING(name)}(parent)}]	A list of files that were uploaded.

Output Example

{
  "entries" : [ {
    "type" : "",
    "id" : "",
    "name" : "",
    "parent" : {
      "type" : "",
      "id" : "",
      "name" : ""
    }
  } ]
}

Triggers

New File

Name: newFile

Triggers when file is uploaded to folder.

Type: DYNAMIC_WEBHOOK

Properties

Name	Label	Type	Description	Required
folderId	Folder ID	STRING	`ID of the folder in which file uploads will trigger this webhook.`	true

Output

Type: OBJECT

Properties

Name	Type	Description
type	STRING	This is always set to file.
id	STRING	ID of the uploaded file.
name	STRING	Name of the uploaded file.
parent	OBJECT Properties {STRING(type), STRING(id), STRING(name)}	Folder that uploaded file is located within. This value may be null for some folders such as the root folder or the trash folder.

JSON Example

{
  "label" : "New File",
  "name" : "newFile",
  "parameters" : {
    "folderId" : ""
  },
  "type" : "box/v1/newFile"
}

New Folder

Name: newFolder

Triggers when folder is created.

Type: DYNAMIC_WEBHOOK

Properties

Name	Label	Type	Description	Required
folderId	Folder ID	STRING	`ID of the folder in which new folder will trigger this webhook.`	true

Output

Type: OBJECT

Properties

Name	Type	Description
type	STRING	This is always set to folder.
id	STRING	ID of the new folder.
name	STRING	Name of the new folder.
parent	OBJECT Properties {STRING(type), STRING(id), STRING(name)}	Folder that new folder is located within. This value may be null for some folders such as the root folder or the trash folder.

JSON Example

{
  "label" : "New Folder",
  "name" : "newFolder",
  "parameters" : {
    "folderId" : ""
  },
  "type" : "box/v1/newFolder"
}

Additional instructions

CONNECTION

Setting up OAuth2

Box

On this page