Skip to content

Box

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

NameLabelTypeControl TypeDescriptionRequired
clientIdClient IdSTRINGTEXTtrue
clientSecretClient SecretSTRINGTEXTtrue

Actions

Create Folder

Name: createFolder

Creates a new empty folder within the specified parent folder.

Properties

NameLabelTypeControl TypeDescriptionRequired
nameFolder NameSTRINGTEXTThe name for the new folder.true
idParent Folder IDSTRINGSELECTID 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

Output

Type: OBJECT

Properties

NameTypeControl Type
typeSTRINGTEXT
idSTRINGTEXT
nameSTRINGTEXT
parentOBJECT
Properties {STRING(type), STRING(id), STRING(name)}
OBJECT_BUILDER

JSON Example

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

Download File

Name: downloadFile

Download a selected file.

Properties

NameLabelTypeControl TypeDescriptionRequired
idParent Folder IDSTRINGSELECTID of the folder from which you want to download the file.true
fileIdFile IDSTRING
Depends On id
SELECTID of the file to download.true

Output

Type: FILE_ENTRY

Properties

NameTypeControl Type
extensionSTRINGTEXT
mimeTypeSTRINGTEXT
nameSTRINGTEXT
urlSTRINGTEXT

JSON Example

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

Upload File

Name: uploadFile

Uploads a small file to Box.

Properties

NameLabelTypeControl TypeDescriptionRequired
idParent Folder IDSTRINGSELECTID of the folder where the file should be uploaded; if no folder is selected, the file will be uploaded in the root folder.true
fileFileFILE_ENTRYFILE_ENTRYtrue

Output

Type: OBJECT

Properties

NameTypeControl Type
entriesARRAY
Items [{STRING(type), STRING(id), STRING(name), {STRING(type), STRING(id), STRING(name)}(parent)}]
ARRAY_BUILDER

JSON Example

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

Triggers

New File

Name: newFile

Triggers when file is uploaded to folder.

Type: DYNAMIC_WEBHOOK

Properties

NameLabelTypeControl TypeDescriptionRequired
folderIdFolder IDSTRINGSELECTID of the folder in which file uploads will trigger this webhook.true

Output

Type: OBJECT

Properties

NameTypeControl Type
typeSTRINGTEXT
idSTRINGTEXT
nameSTRINGTEXT
parentOBJECT
Properties {STRING(type), STRING(id), STRING(name)}
OBJECT_BUILDER

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

NameLabelTypeControl TypeDescriptionRequired
folderIdFolder IDSTRINGSELECTID of the folder in which new folder will trigger this webhook.true

Output

Type: OBJECT

Properties

NameTypeControl Type
typeSTRINGTEXT
idSTRINGTEXT
nameSTRINGTEXT
parentOBJECT
Properties {STRING(type), STRING(id), STRING(name)}
OBJECT_BUILDER

JSON Example

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


Additional instructions


anl-c-box-md

CONNECTION

Setting up OAuth2