Skip to main content

Box Connector

Box Manage files stored in Box

Connections

Box Developer Token

Box Developer Token

InputCommentsDefault
Developer TokenA short-lived developer token for testing purposes

Box OAuth 2.0 Connection

Box OAuth 2.0 Connection

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
ScopesA space-delimited set of one or more scopes. Leave this blank to use your app's configured default scopes.root_readwrite manage_webhook
Client ID
Client Secret

Triggers

Webhook

Receive and validate webhook requests from Box for webhooks you configure.

Actions

Adds a shared link to a file

InputCommentsDefault
File IDThe unique identifier of the file
Shared LinkThe URL of the shared link
Shared Link AccessThe level of access for the shared link. Values: open, company, collaborators
Shared Link PasswordThe password for the shared link, if any
Shared Link PermissionsThe permissions for the shared link
{
"can_download": true,
"can_edit": true,
"can_preview": true
}
Shared Link Vanity NameThe custom vanity name for the shared link
Connection

Adds a shared link to a folder

InputCommentsDefault
Folder IDThe unique identifier that represents a folder
Shared LinkThe URL of the shared link
Shared Link AccessThe level of access for the shared link. Values: open, company, collaborators
Shared Link PasswordThe password for the shared link, if any
Shared Link Permissions FolderThe permissions for the shared link folder
{
"can_download": true,
"can_preview": true
}
Shared Link Vanity NameThe custom vanity name for the shared link
Connection

Copy Object

Copy a Folder or File from one path to another

InputCommentsDefault
From PathThis represents the source files's path. Include a leading /
To PathThis represents the destination files's path. Include a leading /
Connection

Create Folder

Create a Folder at the specified path

InputCommentsDefault
PathThis represents the files's path. Include a leading /
Connection

Create Webhook

Create a webhook to send data from Box to an instance URL

InputCommentsDefault
Webhook URLReference a flow's URL from the trigger payload
Target IDThe ID of the item that will trigger the webhook
Target TypeThe type of item that will trigger the webhook
Trigger TypeNames of events that this webhook will be triggered for.
Primary Signature KeyA signature key used to validate webhook requests
Secondary Signature KeyA signature key used to validate webhook requests
Connection

Delete Instance Webhooks

Delete all Box webhooks that point to a flow in this instance

InputCommentsDefault
Connection

Delete Object

Delete a Folder or File at the specified path

InputCommentsDefault
PathThis represents the files's path. Include a leading /
Connection

Delete Webhook

Delete a webhook by ID

InputCommentsDefault
Connection
Webhook IDThe ID of the webhook

Download File

Download the file at the specified path

InputCommentsDefault
PathThis represents the files's path. Include a leading /
Connection

Returns the file represented by a shared link

InputCommentsDefault
Shared LinkThe URL of the shared link
Shared Link PasswordThe password for the shared link, if any
FieldsA comma-separated list of attributes to include in the response.
Connection

Returns the folder represented by a shared link

InputCommentsDefault
Shared LinkThe URL of the shared link
Shared Link PasswordThe password for the shared link, if any
FieldsA comma-separated list of attributes to include in the response.
Connection

Get Current User

Get the information and metadata of the user that is currently logged in

InputCommentsDefault
Connection

Get File Download URL

Get a URL to download the file at the specified path

InputCommentsDefault
PathThis represents the files's path. Include a leading /
Connection

Gets the shared link for a file

InputCommentsDefault
File IDThe unique identifier of the file
Connection

Gets the shared link for a folder

InputCommentsDefault
Folder IDThe unique identifier that represents a folder
Connection

List Folder

List Folder contents at the specified path.

InputCommentsDefault
Fetch AllSet to true to retrieve all results.false
PathThis represents the files's path. Include a leading /
Fields/MetadataSpecify comma-separated attributes to include in the response. Supports metadata queries (e.g., metadata.enterprise_12345.contractTemplate). See https://developer.box.com/reference/resources/file--full for available fields.
LimitProvide an integer value for the maximum amount of items that will be returned. Provide a value from 1 to 1000.
MarkerSpecify the pagination token that's returned by a previous request to retrieve the next page of results
OffsetThe offset of the item at which to begin the response.
Connection

List Folder (Deprecated)

List Folder contents at the specified path. This version of the action is being deprecated. Please replace action with List Folder.

InputCommentsDefault
PathThis represents the files's path. Include a leading /
LimitProvide an integer value for the maximum amount of items that will be returned. Provide a value from 1 to 1000.
MarkerSpecify the pagination token that's returned by a previous request to retrieve the next page of results
OffsetThe offset of the item at which to begin the response.
Connection

List Webhooks

List all webhooks configured in Box, including those for other integrations

InputCommentsDefault
Connection
LimitProvide an integer value for the maximum amount of items that will be returned. Provide a value from 1 to 1000.
MarkerSpecify the pagination token that's returned by a previous request to retrieve the next page of results
Fetch AllSet to true to retrieve all results.false
Show Only Instance WebhooksShow only webhooks that point to this instancetrue

Move Object

Move a Folder or File from one path to another

InputCommentsDefault
From PathThis represents the source files's path. Include a leading /
To PathThis represents the destination files's path. Include a leading /
Connection

Path Details

Get detailed information about folders/files in the specified path

InputCommentsDefault
PathThis represents the files's path. Include a leading /
Connection

Raw Request

Send raw HTTP request to Box

InputCommentsDefault
Connection
URLInput the path only (/2.0/folders), The base URL is already included (https://api.box.com). For example, to connect to https://api.box.com/2.0/folders, only /2.0/folders is entered in this field.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Debug RequestEnabling this flag will log out the current request.false
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.false
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false

Removes a shared link from a file

InputCommentsDefault
File IDThe unique identifier of the file
Connection

Removes a shared link from a folder

InputCommentsDefault
Folder IDThe unique identifier that represents a folder
Connection

Updates a shared link on a file

InputCommentsDefault
File IDThe unique identifier of the file
Shared LinkThe URL of the shared link
Shared Link AccessThe level of access for the shared link. Values: open, company, collaborators
Shared Link PasswordThe password for the shared link, if any
Shared Link PermissionsThe permissions for the shared link
{
"can_download": true,
"can_edit": true,
"can_preview": true
}
Shared Link Vanity NameThe custom vanity name for the shared link
Connection

Updates a shared link on a folder

InputCommentsDefault
Folder IDThe unique identifier that represents a folder
Shared LinkThe URL of the shared link
Shared Link AccessThe level of access for the shared link. Values: open, company, collaborators
Shared Link PasswordThe password for the shared link, if any
Shared Link Permissions FolderThe permissions for the shared link folder
{
"can_download": true,
"can_preview": true
}
Shared Link Vanity NameThe custom vanity name for the shared link
Connection

Upload File

Upload a file to the specified path

InputCommentsDefault
PathThis represents the files's path. Include a leading /
File ContentsThe contents to write to a file. This can be a string of text, it can be binary data (like an image or PDF) that was generated in a previous step.
Connection