Reference · Tools

Box Trigger

Starts workflow when Box events occur

Webhook trigger Data & Storage v1

Box Trigger fires a workflow whenever a specified event happens on a Box file or folder — uploads, moves, deletions, collaboration changes, comments, metadata updates, and more. You point it at a specific file or folder ID, choose which events to watch, and your workflow runs the moment Box detects a match. A typical use: automatically route a newly uploaded contract for review the instant it lands in a Box folder.

Node type
Webhook trigger
Parameters
3
Outputs
Output
Credentials
Box

Box Trigger

Triggers when Box file, folder, or collaboration events occur.

Overview

The Box Trigger node listens for webhook events from Box cloud content management. It can detect file operations (upload, download, copy, move, delete, lock/unlock, preview, rename, trash, restore), folder operations (create, copy, move, delete, download, rename, trash, restore), collaboration changes (created, accepted, rejected, removed, updated), comment activity (created, updated, deleted), shared link changes, metadata instance changes, task assignment changes, and webhook deletion events. When an event occurs on a monitored file or folder, Box sends the event payload to this trigger, which then starts the connected workflow with the full event data.

Category: Data & Storage
Tool Name: box_trigger
Version: 1

Appearance: Icon: si-box | Color: #0061d5

Node Type

Trigger — webhook (receives incoming HTTP callbacks)

Input / Output

DirectionPort(s)
InputNone (trigger node)
OutputOutput

Credentials

This tool requires Box credentials. See the Credentials Guide for setup instructions.

Parameters

ParameterTypeRequiredDefaultDescription
EventsmultiOptionsYes[]The events to listen to.
Options: COLLABORATION.ACCEPTED, COLLABORATION.CREATED, COLLABORATION.REJECTED, COLLABORATION.REMOVED, COLLABORATION.UPDATED, COMMENT.CREATED, COMMENT.DELETED, COMMENT.UPDATED, FILE.COPIED, FILE.DELETED (the file is moved to the trash), FILE.DOWNLOADED, FILE.LOCKED, FILE.MOVED (from one folder to another), FILE.PREVIEWED, FILE.RENAMED, FILE.RESTORED (from the trash), FILE.TRASHED, FILE.UNLOCKED, FILE.UPLOADED (a file is uploaded to or moved into this folder), FOLDER.COPIED, FOLDER.CREATED, FOLDER.DELETED (permanently removed), FOLDER.DOWNLOADED, FOLDER.MOVED, FOLDER.RENAMED, FOLDER.RESTORED (from the trash), FOLDER.TRASHED, METADATA_INSTANCE.CREATED (a metadata template instance is associated with a file or folder), METADATA_INSTANCE.DELETED, METADATA_INSTANCE.UPDATED (an attribute of an existing instance is updated or deleted), SHARED_LINK.CREATED, SHARED_LINK.DELETED, SHARED_LINK.UPDATED, TASK_ASSIGNMENT.CREATED, TASK_ASSIGNMENT.UPDATED, WEBHOOK.DELETED (this webhook itself was deleted in Box)
Target TypeoptionsNoThe type of item to trigger a webhook.
Options: file, folder
Target IDstringNoThe ID of the file or folder to monitor for events. Supports expressions.

Output Data

Each delivered event produces one output item carrying the Box payload exactly as sent — typically id, type, trigger, created_by, created_at, source (the file or folder the event happened on, with its parent), webhook, and additional_info.

Five fields are added to every item:

  • _trigger — always box_webhook
  • _timestamp — ISO 8601 timestamp of when the request arrived
  • _webhookEvent — the Box trigger name, e.g. FILE.UPLOADED
  • _sourceType — the source.type, e.g. file or folder
  • _sourceId — the source.id

Deliveries whose trigger is not in your Events selection are acknowledged but do not start the workflow.

Reference the payload downstream by expression, e.g. {{ $json.source.name }} or {{ $json._sourceId }}.

Usage Examples

  • Start a workflow when a file is uploaded to a Box folder
  • Trigger processing when a file is downloaded from Box
  • React to new comments on Box files
  • Monitor collaboration changes on Box folders
  • Detect when files are moved or renamed in Box

Example Configuration

Watch a folder for new files:

{
  "type": "box_trigger",
  "parameters": {
    "events": ["FILE.UPLOADED"],
    "targetType": "folder",
    "targetId": "123456789"
  }
}

Track the full lifecycle of files in a folder:

{
  "type": "box_trigger",
  "parameters": {
    "events": ["FILE.UPLOADED", "FILE.MOVED", "FILE.RENAMED", "FILE.TRASHED"],
    "targetType": "folder",
    "targetId": "0"
  }
}

Monitor sharing and collaboration on a single file:

{
  "type": "box_trigger",
  "parameters": {
    "events": [
      "SHARED_LINK.CREATED",
      "SHARED_LINK.DELETED",
      "COLLABORATION.CREATED",
      "COLLABORATION.REMOVED"
    ],
    "targetType": "file",
    "targetId": "987654321"
  }
}

Trigger Behavior

  • Activation: When the workflow is activated, a webhook endpoint is registered with the service.
  • Deactivation: The webhook is automatically unregistered when the workflow is deactivated.
  • Payload: The incoming webhook payload is parsed and output as workflow items.
  • Verification: Supports signature verification where applicable.

Tips

Configure with your Box credentials, select which events to listen for, choose whether to watch a file or folder, and provide the target ID. Box will send a webhook notification whenever the selected events occur on the target.

  • Target Type and Target ID are how Box scopes the subscription. Set both — Box cannot register a webhook without them. The root folder has ID 0.
  • Finding an ID. Open the file or folder in Box; the trailing number in the browser URL is its ID.
  • Match events to the target. FILE.UPLOADED, for example, fires for files uploaded to or moved into the watched folder — the option descriptions above say what each event covers.
  • Box refuses a second webhook on the same target and address. If activation fails, check whether a webhook already exists on that file or folder.
  • WEBHOOK.DELETED tells you the subscription itself was removed in Box — useful as a signal that the workflow has stopped receiving events.

Frequently asked questions

What do I need to enter to get Box Trigger working?

You need three things: your Box credentials (Box API / boxApi), the target type (file or folder), and the target ID. Box cannot register a webhook without both the target type and ID set. To find an ID, open the file or folder in Box and copy the trailing number from the browser URL. The root folder always has ID 0.

Can I watch an entire Box account or just a specific file or folder?

Box Trigger scopes to a single file or folder at a time — you must provide one target ID per trigger node. There is no account-wide wildcard. If you need to monitor multiple locations, create a separate Box Trigger node for each target ID.

Activation is failing — what should I check first?

Box rejects a second webhook registration on the same target and delivery address. If activation fails, log in to Box and check whether a webhook already exists on that file or folder. Remove the duplicate webhook in Box, then try activating the trigger again.

What does the WEBHOOK.DELETED event mean and should I use it?

WEBHOOK.DELETED fires when the subscription itself is removed from Box — not when a file is deleted. It is useful as a signal that your workflow has stopped receiving events, for example so you can alert an admin or attempt re-registration. If you are not actively monitoring webhook health, you can safely omit it from your event selection.

Does FILE.UPLOADED fire when a file is moved into a watched folder, or only on new uploads?

FILE.UPLOADED fires for both: files uploaded directly to the watched folder and files moved into it. The event descriptions shown during node configuration specify exactly which actions each event covers, so check those descriptions when selecting events to avoid subscribing to more than you intend.

Build with the Box Trigger node

Drop it into a workflow, wire it to an agent, or call it on a schedule. You'll need Box credentials first.

Open BusyBot

Last updated . Spotted something wrong? Tell us.