Skip to main content

Box Component

Manage files stored in Box

Component key: box

Changelog ↓

Description​

Box is a file sharing platform that allows teams to collaborate and share files with one another. The Box component allows you to create, list, fetch, move, or delete files and folders in a customer's Box account.

API Documentation​

This component was built using the Box REST API

A common integration pattern involves listing files in a file store, and performing a series of actions on the array of files that are returned. See our looping over files quickstart for information about how to create a loop over an array of files.

Connections​

Box Developer Token​

key: apiKey

A Developer Token is a short-lived (60-minute) token that can be used for testing purposes. Developer tokens allow access to the Box API for a personal Box account only.

Production Authentication

When an integration is ready for production, an OAuth 2.0 connection is required to authenticate customer Box accounts. Testing can also be performed with OAuth 2.0.

Prerequisites​

Setup Steps​

To generate a developer token:

  1. Navigate to the Box Developer Console
  2. Select Create New App
  3. Choose Custom App and click Next
  4. Select User Authentication (OAuth 2.0) and click Next
  5. Enter an app name and click Create App
  6. In the app's Configuration tab, scroll to the Developer Token section
  7. Click Generate Developer Token
  8. Copy the generated token (valid for 60 minutes)

For more information, refer to the Box Developer Token documentation.

Configure the Connection​

  • Enter the developer token value into the Developer Token field of the connection configuration
Token Expiration

Developer tokens expire after 60 minutes. Generate a new token if authentication fails due to expiration.

InputNotesExample
Developer Token

A short-lived developer token for testing purposes. Obtain from Box Developer Console.

ABCDEFGHIJKLMNOPQRSTUVWXYZ123456

Box OAuth 2.0 Connection​

key: oauth2

To connect to Box using OAuth 2.0, create a Box OAuth 2.0 app to authorize the integration to access customer Box accounts.

Refer to the Box OAuth 2.0 setup guide for detailed information.

Prerequisites​

Setup Steps​

  1. Navigate to the Box Developer Console
  2. Click Create New App
  3. Select Custom App and click Next
  4. Select User Authentication (OAuth 2.0) and click Next
  5. Enter an app name and click Create App
  6. In the app's Configuration tab, configure the OAuth settings:
    • Copy the Client ID and Client Secret values
    • Under OAuth 2.0 Redirect URI, add https://oauth2.prismatic.io/callback
    • Under Application Scopes, select the appropriate permissions:
      • For full access, select Write all files and folders stored in Box
      • For read-only access, select Read all files and folders stored in Box
      • Refer to Box scopes documentation for more granular permissions
    • Leave CORS Domains blank
  7. Click Save Changes

Configure the Connection​

  • Enter the Client ID and Client Secret from the Box app configuration
  • For Scopes, either:
    • Leave blank to use the Application Scopes configured in the Box app
    • Enter specific scopes as a space-separated list (e.g., root_readwrite manage_webhook)
    • Refer to Box scopes documentation for available scopes
Box Enterprise Features

Some Box features require an Enterprise account. Ensure the Box account has appropriate subscription level for the required functionality.

InputNotesExample
Authorize URL

The OAuth 2.0 Authorization URL for Box.

https://account.box.com/api/oauth2/authorize
Client ID

The OAuth 2.0 client ID from your Box app configuration. Obtain from Box Developer Console.

abc123def456ghi789jkl012mno345pq
Client Secret

The OAuth 2.0 client secret from your Box app configuration. Obtain from Box Developer Console.

Scopes

A space-delimited set of one or more scopes. Leave blank to use your app's configured default scopes. See Box OAuth Scopes for available options.

root_readwrite manage_webhook
Token URL

The OAuth 2.0 Token URL for Box.

https://api.box.com/oauth2/token

Triggers​

Managed Webhook​

Receive and validate webhook requests from Box. Automatically creates and manages a webhook subscription when the instance is deployed, and removes the subscription when the instance is deleted. | key: managedWebhook

InputNotesExample
Connection

The Box connection to use.

Primary Signature Key

A signature key used to validate webhook requests. See Box Webhook Signatures for details.

3T2eTfOvJbAIRoBpXsXPmq0gn8CmF5Q7
Secondary Signature Key

A signature key used to validate webhook requests. See Box Webhook Signatures for details.

3T2eTfOvJbAIRoBpXsXPmq0gn8CmF5Q7
Target ID

The unique identifier of the file or folder that will trigger the webhook.

123456789012
Target Type

The type of item that will trigger the webhook (file or folder).

file
Trigger Type

Select which event types will trigger this webhook. See Box Events for available options.

The Instance Webhook trigger automatically creates and manages Box webhook subscriptions for an instance. Unlike traditional webhook setups that require manual configuration in the Box Developer Console, this trigger handles the entire webhook lifecycle.

When the trigger is used in a flow:

  • On Instance Deploy: The trigger automatically creates a V2 webhook subscription in Box pointing to the flow's unique webhook URL. The webhook monitors the specified target (file or folder) for the selected event types. If the webhook configuration changes between deployments, the trigger deletes the old webhook and creates a new one with the updated settings.
  • On Instance Deletion: The trigger automatically removes the webhook subscription from Box, ensuring no orphaned webhooks remain.

Configuration​

Configure the trigger with the following inputs:

  • Connection: Box OAuth 2.0 connection with permissions to create and manage webhooks
  • Target ID: The ID of the file or folder to monitor for events (use the Box content data source)
  • Target Type: Select either "File" or "Folder" as the webhook target
  • Trigger Type: Select one or more event types to monitor (see available events below)
  • Primary Signature Key: A signature key for webhook payload verification (optional but recommended)
  • Secondary Signature Key: A secondary signature key for webhook rotation scenarios (optional)

Available Webhook Events​

The trigger supports monitoring over 30 different event types on Box files and folders.

A full list of available webhook events is available in the Box Webhooks documentation.

View all available webhook events
CategoryEventDescription
FileFILE.UPLOADEDA file is uploaded to a folder
FILE.PREVIEWEDA file is previewed
FILE.DOWNLOADEDA file is downloaded
FILE.TRASHEDA file is moved to trash
FILE.DELETEDA file is permanently deleted
FILE.RESTOREDA file is restored from trash
FILE.COPIEDA file is copied to another location
FILE.MOVEDA file is moved to a different folder
FILE.LOCKEDA file is locked
FILE.UNLOCKEDA file is unlocked
FILE.RENAMEDA file is renamed
FolderFOLDER.CREATEDA new folder is created
FOLDER.DOWNLOADEDA folder is downloaded
FOLDER.RESTOREDA folder is restored from trash
FOLDER.DELETEDA folder is permanently deleted
FOLDER.COPIEDA folder is copied to another location
FOLDER.MOVEDA folder is moved to a different location
FOLDER.TRASHEDA folder is moved to trash
FOLDER.RENAMEDA folder is renamed
CommentCOMMENT.CREATEDA comment is created on a file
COMMENT.UPDATEDA comment is updated
COMMENT.DELETEDA comment is deleted
CollaborationCOLLABORATION.CREATEDA collaboration is created
COLLABORATION.ACCEPTEDA collaboration invitation is accepted
COLLABORATION.REJECTEDA collaboration invitation is rejected
COLLABORATION.REMOVEDA collaboration is removed
COLLABORATION.UPDATEDA collaboration is updated
Shared LinkSHARED_LINK.CREATEDA shared link is created
SHARED_LINK.UPDATEDA shared link is updated
SHARED_LINK.DELETEDA shared link is deleted
TaskTASK_ASSIGNMENT.CREATEDA task assignment is created
TASK_ASSIGNMENT.UPDATEDA task assignment is updated
MetadataMETADATA_INSTANCE.CREATEDMetadata is added to a file or folder
METADATA_INSTANCE.UPDATEDMetadata is updated on a file or folder
METADATA_INSTANCE.DELETEDMetadata is removed from a file or folder
Sign RequestSIGN_REQUEST.COMPLETEDA sign request is completed
SIGN_REQUEST.DECLINEDA sign request is declined
SIGN_REQUEST.EXPIREDA sign request expires
WebhookWEBHOOK.DELETEDA webhook is deleted

Returned Data​

The trigger returns the complete webhook payload from Box. The structure varies depending on the event type. The source field contains the file or folder that triggered the event, while created_by identifies the user who performed the action.

Example payload for FILE.UPLOADED event
{
  "trigger": "FILE.UPLOADED",
  "id": "1234567890",
  "type": "webhook_event",
  "webhook": {
    "id": "987654321",
    "type": "webhook"
  },
  "created_by": {
    "type": "user",
    "id": "11111",
    "name": "Example User",
    "login": "user@example.com"
  },
  "created_at": "2024-11-10T10:30:00-08:00",
  "source": {
    "id": "555555",
    "type": "file",
    "name": "example.pdf",
    "parent": {
      "type": "folder",
      "id": "999999",
      "name": "Documents"
    }
  }
}

For complete payload structure details, see the Box Webhooks V2 documentation.

Manual Webhook​

Receive and validate webhook requests from Box for manually configured webhook subscriptions. | key: webhook

New and Updated Files​

Checks for new and updated files in a specified folder on a configured schedule. | key: newOrUpdatedFile

InputNotesExample
Connection

The Box connection to use.

Folder ID

The unique identifier of the folder.

123456789012

Checks for new and updated files in a specified folder on a configured schedule.

This polling trigger monitors a Box folder at regular intervals and identifies files that have been created or modified since the last poll. The trigger automatically maintains state to track the last polling time and categorizes results into new files and updated files.

How It Works​

The trigger operates as follows:

  1. Runs on the configured schedule (e.g., every 5 minutes)
  2. Fetches all files from the specified folder using the Box Folders API
  3. Normalizes timestamps to UTC for accurate comparison (Box stores dates with timezone offsets)
  4. Compares file creation and modification timestamps against the last poll time
  5. Categorizes files as:
    • New Files: Files where created_at is after the last poll time
    • Updated Files: Files where modified_at is after the last poll time but are not classified as new
  6. Maintains polling state automatically to track the last poll time

Configuration​

Configure the trigger with the following inputs:

  • Connection: Box OAuth 2.0 connection with read permissions for the target folder
  • Folder ID: The unique identifier of the folder to monitor (use the Box folder data source to select a folder)

The trigger fetches up to 1,000 files per poll from the specified folder using Box's pagination mechanism.

Returned Data​

The trigger returns separate arrays for new and updated files with branch support.

Example returned data structure
{
  "data": {
    "newFiles": {
      "data": [
        {
          "id": "1234567890",
          "type": "file",
          "name": "report.pdf",
          "created_at": "2024-11-10T18:07:45Z",
          "modified_at": "2024-11-10T18:07:45Z"
        },
        {
          "id": "9876543210",
          "type": "file",
          "name": "invoice.xlsx",
          "created_at": "2024-11-10T18:15:22Z",
          "modified_at": "2024-11-10T18:15:22Z"
        }
      ]
    },
    "updatedFiles": {
      "data": [
        {
          "id": "5555555555",
          "type": "file",
          "name": "presentation.pptx",
          "created_at": "2024-11-08T14:30:00Z",
          "modified_at": "2024-11-10T18:20:10Z"
        }
      ]
    }
  }
}

New File Comments​

Checks for new comments on a specified file on a configured schedule. | key: newFileComments

InputNotesExample
Connection

The Box connection to use.

File ID

The unique identifier of the file.

987654321012

Checks for new comments on a specified file on a configured schedule.

This polling trigger monitors comments on a specific Box file at regular intervals and identifies comments that have been created since the last poll. The trigger automatically maintains state to track the last polling time and returns only newly created comments.

How It Works​

The trigger operates as follows:

  1. Runs on the configured schedule (e.g., every 5 minutes)
  2. Fetches all comments for the specified file using the Box Comments API
  3. Normalizes timestamps to UTC for accurate comparison (Box stores dates with timezone offsets)
  4. Compares comment creation timestamps against the last poll time
  5. Returns comments where created_at is after the last poll time
  6. Maintains polling state automatically to track the last poll time

State Management​

The trigger stores the last poll timestamp in the polling state. On the first execution, if no previous state exists, the trigger uses the current time as the baseline. This means the initial poll establishes the baseline and subsequent polls detect comments created after that point.

Each poll updates the state with the current timestamp, ensuring accurate tracking of when comments were added.

Configuration​

Configure the trigger with the following inputs:

  • Connection: Box OAuth 2.0 connection with read permissions for the target file
  • File ID: The unique identifier of the file to monitor for comments (use the Box content data source to select a file)

The trigger fetches all comments on the specified file during each poll. Box's API returns all comments without pagination for most files.

Returned Data​

The trigger returns an array of newly created comments.

Example returned data structure
{
  "data": {
    "newComments": {
      "data": [
        {
          "id": "1234567890",
          "message": "Please review the updated section on page 3",
          "created_at": "2024-11-10T18:07:45Z"
        },
        {
          "id": "9876543210",
          "message": "Approved for final release",
          "created_at": "2024-11-10T18:15:22Z"
        }
      ]
    }
  }
}

New Folders​

Checks for new folders in a specified folder on a configured schedule. | key: newFolder

InputNotesExample
Connection

The Box connection to use.

Folder ID

The unique identifier of the folder.

123456789012

Checks for new folders in a specified folder on a configured schedule.

This polling trigger monitors a Box folder at regular intervals and identifies subfolders that have been created since the last poll. The trigger automatically maintains state to track the last polling time and returns only newly created folders.

How It Works​

The trigger operates as follows:

  1. Runs on the configured schedule (e.g., every 5 minutes)
  2. Fetches all items from the specified folder using the Box Folders API
  3. Filters results to include only folder entries (excluding files)
  4. Normalizes timestamps to UTC for accurate comparison (Box stores dates with timezone offsets)
  5. Compares folder creation timestamps against the last poll time
  6. Returns folders where created_at is after the last poll time
  7. Maintains polling state automatically to track the last poll time

Configuration​

Configure the trigger with the following inputs:

  • Connection: Box OAuth 2.0 connection with read permissions for the target folder
  • Folder ID: The unique identifier of the parent folder to monitor (use the Box folder data source to select a folder)

The trigger fetches up to 1,000 items per poll from the specified folder using Box's pagination mechanism.

Returned Data​

The trigger returns an array of newly created folders.

Example returned data structure
{
  "data": {
    "newFolders": {
      "data": [
        {
          "id": "1234567890",
          "type": "folder",
          "name": "Q1 Reports",
          "created_at": "2024-11-10T18:07:45Z"
        },
        {
          "id": "9876543210",
          "type": "folder",
          "name": "Client Documents",
          "created_at": "2024-11-10T18:15:22Z"
        }
      ]
    }
  }
}

Data Sources​

Select File or Folder​

Select file or folder from Box account base path | key: selectContent | type: picklist

InputNotesExample
Connection

The Box connection to use.

Content Type

The type of content to select (files, folders, or both).

file
Limit

The maximum number of items to return (1-1000).

100
Marker

The pagination marker returned by a previous request to retrieve the next page of results.

lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Offset

The position to start returning results from (zero-based index).

0

Select Webhook​

Select webhook from Box account | key: selectWebhook | type: picklist

InputNotesExample
Connection

The Box connection to use.

Actions​

Add Shared Link to File​

Adds a shared link to a file | key: addSharedLinkToFile

InputNotesExample
Connection

The Box connection to use.

Shared Link

The URL of the shared link.

https://app.box.com/s/abcd1234efgh5678ijkl
File ID

The unique identifier of the file.

987654321012
Shared Link Access

The level of access for the shared link. Values: open, company, collaborators. See Box Shared Links for details.

open
Shared Link Password

The password for the shared link, if one is set.

Shared Link Permissions

The permissions for the shared link (file). Specify which actions are allowed. See Box Shared Link Permissions for details.

Shared Link Vanity Name

The custom vanity name for the shared link URL. Creates a URL like https://app.box.com/v/your-vanity-name.

q4-financial-report

Add Shared Link to Folder​

Adds a shared link to a folder | key: addSharedLinkToFolder

InputNotesExample
Connection

The Box connection to use.

Folder ID

The unique identifier of the folder.

123456789012
Shared Link

The URL of the shared link.

https://app.box.com/s/abcd1234efgh5678ijkl
Shared Link Access

The level of access for the shared link. Values: open, company, collaborators. See Box Shared Links for details.

open
Shared Link Password

The password for the shared link, if one is set.

Shared Link Permissions Folder

The permissions for the shared link (folder). Specify which actions are allowed. See Box Shared Link Permissions for details.

Shared Link Vanity Name

The custom vanity name for the shared link URL. Creates a URL like https://app.box.com/v/your-vanity-name.

q4-financial-report

Copy Object​

Copy a Folder or File from one path to another | key: copyObject

InputNotesExample
Connection

The Box connection to use.

From Path

The full path to the source file or folder. Must include a leading forward slash (/).

/Marketing/Documents/OldReport.pdf
To Path

The full path to the destination location including the new filename. Must include a leading forward slash (/).

/Archive/2024/OldReport.pdf

{
  "data": [
    {
      "id": "exampleId",
      "type": "folder",
      "name": "example"
    }
  ]
}

Create Folder​

Create a Folder at the specified path | key: createFolder

InputNotesExample
Connection

The Box connection to use.

Path

The full path to the file or folder. Must include a leading forward slash (/).

/Marketing/Documents/Q4_Report.pdf

{
  "data": {
    "id": "exampleId",
    "status": "active",
    "name": "Example",
    "created_at": "2020-01-01T12:00:00Z",
    "description": "Example description.",
    "folder": "exampleFolder"
  }
}

Create Webhook​

Create a webhook to send data from Box to an instance URL | key: createWebhook

InputNotesExample
Webhook URL

The URL where webhook events will be sent. Reference a flow's URL from the trigger payload.

https://hooks.example.com/box/abc123
Connection

The Box connection to use.

Primary Signature Key

A signature key used to validate webhook requests. See Box Webhook Signatures for details.

3T2eTfOvJbAIRoBpXsXPmq0gn8CmF5Q7
Secondary Signature Key

A signature key used to validate webhook requests. See Box Webhook Signatures for details.

3T2eTfOvJbAIRoBpXsXPmq0gn8CmF5Q7
Target ID

The unique identifier of the file or folder that will trigger the webhook.

123456789012
Target Type

The type of item that will trigger the webhook (file or folder).

file
Trigger Type

Select which event types will trigger this webhook. See Box Events for available options.

{
  "data": {
    "id": "1234",
    "type": "webhook",
    "target": {
      "id": "22222",
      "type": "folder"
    },
    "created_by": {
      "type": "user",
      "id": "33333",
      "name": "Example User",
      "login": "user@example.com"
    },
    "created_at": "2016-05-09T17:41:27-07:00",
    "address": "https://example.com/webhook",
    "triggers": [
      "FILE.DOWNLOADED",
      "FILE.UPLOADED"
    ]
  },
  "crossFlowState": {
    "primarySignatureKey": "3T2eTfOvJbAIRoBpXsXPmq0gn8CmF5Q7"
  }
}

Delete Instance Webhooks​

Delete all Box webhooks that point to a flow in this instance | key: deleteInstanceWebhooks

InputNotesExample
Connection

The Box connection to use.

Delete Object​

Delete a Folder or File at the specified path | key: deleteObject

InputNotesExample
Connection

The Box connection to use.

Path

The full path to the file or folder. Must include a leading forward slash (/).

/Marketing/Documents/Q4_Report.pdf

Delete Webhook​

Delete a webhook by ID | key: deleteWebhook

InputNotesExample
Connection

The Box connection to use.

Webhook ID

The unique identifier of the webhook.

375893453

{
  "data": {}
}

Download File​

Download the file at the specified path | key: downloadFile

InputNotesExample
Connection

The Box connection to use.

Path

The full path to the file or folder. Must include a leading forward slash (/).

/Marketing/Documents/Q4_Report.pdf

{
  "data": {
    "type": "Buffer",
    "data": [
      101,
      120,
      97,
      109,
      112,
      108,
      101
    ]
  },
  "contentType": "application/octet"
}

Returns the file represented by a shared link | key: findFileForSharedLink

InputNotesExample
Connection

The Box connection to use.

Fields

A comma-separated list of attributes to include in the response. See Box File Fields for available options.

type,id,name,size,created_at
Shared Link

The URL of the shared link.

https://app.box.com/s/abcd1234efgh5678ijkl
Shared Link Password

The password for the shared link, if one is set.

{
  "data": {
    "type": "file",
    "id": "exampleId",
    "name": "example"
  }
}

Returns the folder represented by a shared link | key: findFolderForSharedLink

InputNotesExample
Connection

The Box connection to use.

Fields

A comma-separated list of attributes to include in the response. See Box File Fields for available options.

type,id,name,size,created_at
Shared Link

The URL of the shared link.

https://app.box.com/s/abcd1234efgh5678ijkl
Shared Link Password

The password for the shared link, if one is set.

{
  "data": {
    "type": "folder",
    "id": "exampleId",
    "name": "example"
  }
}

Get Current User​

Get the information and metadata of the user that is currently logged in | key: getCurrentUser

InputNotesExample
Connection

The Box connection to use.

{
  "data": {
    "type": "user",
    "id": "33333",
    "name": "Example User",
    "login": "user@example.com",
    "created_at": "2012-03-26T15:43:07-07:00",
    "modified_at": "2012-12-12T11:34:29-08:00",
    "language": "en",
    "space_amount": 5368709120,
    "space_used": 2377016,
    "max_upload_size": 262144000,
    "status": "active",
    "job_title": "Employee",
    "phone": "5555555555",
    "address": "555 Office Drive",
    "avatar_url": "https://app.box.com/api/avatar/deprecated"
  }
}

Get File Download URL​

Get a URL to download the file at the specified path | key: getFileDownloadUrl

InputNotesExample
Connection

The Box connection to use.

Path

The full path to the file or folder. Must include a leading forward slash (/).

/Marketing/Documents/Q4_Report.pdf

{
  "data": "example.com/files/file.txt"
}

Get Shared Link For File​

Gets the shared link for a file | key: getSharedLinkForFile

InputNotesExample
Connection

The Box connection to use.

File ID

The unique identifier of the file.

987654321012

{
  "data": {
    "sharedLink": "https://app.box.com/s/abbvr71aw8a4gb7u2541hlv45l806u5h"
  }
}

Get Shared Link For Folder​

Gets the shared link for a folder | key: getSharedLinkForFolder

InputNotesExample
Connection

The Box connection to use.

Folder ID

The unique identifier of the folder.

123456789012

{
  "data": {
    "sharedLink": "https://app.box.com/s/abbvr71aw8a4gb7u2541hlv45l806u5h"
  }
}

List Folder​

List Folder contents at the specified path. | key: listFolderWithPagination

InputNotesExample
Connection

The Box connection to use.

Fetch All

When true, retrieves all results using automatic pagination.

false
Fields/Metadata

Comma-separated attributes to include in the response. Supports metadata queries (e.g., metadata.enterprise_12345.contractTemplate). See Box File Fields for available options.

content_created_at,name,size,modified_at
Limit

The maximum number of items to return (1-1000).

100
Marker

The pagination marker returned by a previous request to retrieve the next page of results.

lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Offset

The position to start returning results from (zero-based index).

0
Path

The full path to the file or folder. Must include a leading forward slash (/).

/Marketing/Documents/Q4_Report.pdf

{
  "data": {
    "entries": [
      {
        "id": "exampleId",
        "type": "folder",
        "name": "example"
      }
    ],
    "pagination": {
      "next_marker": "exampleMarker",
      "limit": 1000
    }
  }
}

List Folder (Deprecated)​

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

InputNotesExample
Connection

The Box connection to use.

Limit

The maximum number of items to return (1-1000).

100
Marker

The pagination marker returned by a previous request to retrieve the next page of results.

lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Offset

The position to start returning results from (zero-based index).

0
Path

The full path to the file or folder. Must include a leading forward slash (/).

/Marketing/Documents/Q4_Report.pdf

{
  "data": [
    {
      "id": "exampleId",
      "type": "folder",
      "name": "example"
    }
  ]
}

List Webhooks​

List all webhooks configured in Box, including those for other integrations | key: listWebhooks

InputNotesExample
Connection

The Box connection to use.

Fetch All

When true, retrieves all results using automatic pagination.

false
Limit

The maximum number of items to return (1-1000).

100
Marker

The pagination marker returned by a previous request to retrieve the next page of results.

lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Show Only Instance Webhooks

Show only webhooks that point to this instance

true

{
  "data": {
    "next_marker": "ZmlQZS0xLTE%3D",
    "entries": [
      {
        "id": "1234",
        "type": "webhook",
        "target": {
          "id": "22222",
          "type": "folder"
        }
      },
      {
        "id": "5678",
        "type": "webhook",
        "target": {
          "id": "11111",
          "type": "file"
        }
      }
    ],
    "limit": 2
  }
}

Move Object​

Move a Folder or File from one path to another | key: moveObject

InputNotesExample
Connection

The Box connection to use.

From Path

The full path to the source file or folder. Must include a leading forward slash (/).

/Marketing/Documents/OldReport.pdf
To Path

The full path to the destination location including the new filename. Must include a leading forward slash (/).

/Archive/2024/OldReport.pdf

{
  "data": [
    {
      "id": "exampleId",
      "type": "folder",
      "name": "example"
    }
  ]
}

Path Details​

Get detailed information about folders/files in the specified path | key: pathDetails

InputNotesExample
Connection

The Box connection to use.

Path

The full path to the file or folder. Must include a leading forward slash (/).

/Marketing/Documents/Q4_Report.pdf

{
  "data": [
    {
      "id": "exampleId",
      "type": "file",
      "name": "example"
    }
  ]
}

Raw Request​

Send raw HTTP request to Box | key: rawRequest

InputNotesExample
Connection

The Box connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
Debug Request

Enabling this flag will log out the current request.

false
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A 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.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If 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
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input 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.

/2.0/folders
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Remove Shared Link from File​

Removes a shared link from a file | key: removeSharedLinkFromFile

InputNotesExample
Connection

The Box connection to use.

File ID

The unique identifier of the file.

987654321012

Remove Shared Link from Folder​

Removes a shared link from a folder | key: removeSharedLinkFromFolder

InputNotesExample
Connection

The Box connection to use.

Folder ID

The unique identifier of the folder.

123456789012

Update Shared Link on File​

Updates a shared link on a file | key: updateSharedLinkToFile

InputNotesExample
Connection

The Box connection to use.

File ID

The unique identifier of the file.

987654321012
Shared Link

The URL of the shared link.

https://app.box.com/s/abcd1234efgh5678ijkl
Shared Link Access

The level of access for the shared link. Values: open, company, collaborators. See Box Shared Links for details.

open
Shared Link Password

The password for the shared link, if one is set.

Shared Link Permissions

The permissions for the shared link (file). Specify which actions are allowed. See Box Shared Link Permissions for details.

Shared Link Vanity Name

The custom vanity name for the shared link URL. Creates a URL like https://app.box.com/v/your-vanity-name.

q4-financial-report

Update Shared Link on Folder​

Updates a shared link on a folder | key: updateSharedLinkOnFolder

InputNotesExample
Connection

The Box connection to use.

Folder ID

The unique identifier of the folder.

123456789012
Shared Link

The URL of the shared link.

https://app.box.com/s/abcd1234efgh5678ijkl
Shared Link Access

The level of access for the shared link. Values: open, company, collaborators. See Box Shared Links for details.

open
Shared Link Password

The password for the shared link, if one is set.

Shared Link Permissions Folder

The permissions for the shared link (folder). Specify which actions are allowed. See Box Shared Link Permissions for details.

Shared Link Vanity Name

The custom vanity name for the shared link URL. Creates a URL like https://app.box.com/v/your-vanity-name.

q4-financial-report

Upload File​

Upload a file to the specified path | key: uploadFile

InputNotesExample
Connection

The Box connection to use.

File Contents

The file content to upload. Accepts text, binary data (images, PDFs), or output from a previous step.

My File Contents
Path

The full path to the file or folder. Must include a leading forward slash (/).

/Marketing/Documents/Q4_Report.pdf

{
  "data": [
    {
      "id": "exampleId",
      "type": "folder",
      "name": "example"
    }
  ]
}

Changelog​

2025-01-23​

Added new triggers for improved event monitoring:

  • Managed Webhook automatically creates and manages webhook subscriptions when instances are deployed and removes them when deleted
  • New or Updated Files polls for new or modified files in a specified folder on a schedule
  • New Folders polls for newly created folders within a target folder on a schedule
  • New File Comments polls for new comments on a specific file on a schedule

2025-11-19​

Enhanced webhook triggers to support simulated test executions

2025-09-15​

Upgraded to the latest Box SDK version with enhanced object operations and improved webhook functionality