Box
Box is a cloud content management platform for managing, securing, and sharing content among distributed teams.
Note Your subscription tier may not support metadata and metadata template actions. For more information, see box.com/pricing.
Triggers
Trigger |
Configuration fields |
Data type |
Required? |
---|---|---|---|
File copied - A file was copied. |
Folder - Search your account. Type to start searching. |
Choice |
|
File deleted - A file was deleted. |
Folder - Search your account. Type to start searching. |
Choice |
|
File locked - A file was locked. |
Folder - Search your account. Type to start searching. |
Choice |
|
File moved - A file was moved. |
Folder - Search your account. Type to start searching. |
Choice |
|
File restored - A file was restored. |
Folder - Search your account. Type to start searching. |
Choice |
|
File unlocked - A file was unlocked. |
Folder - Search your account. Type to start searching. |
Choice |
|
File uploaded - A file was uploaded. |
Folder - Search your account. Type to start searching. |
Choice |
|
Folder copied - A folder was copied. |
Folder - Search your account. Type to start searching. |
Choice |
|
Folder deleted - A folder was deleted. |
Folder - Search your account. Type to start searching. |
Choice |
|
Folder downloaded - A folder was downloaded. |
Folder - Search your account. Type to start searching. |
Choice |
|
Folder moved - A folder was moved. |
Folder - Search your account. Type to start searching. |
Choice |
|
Folder restored - A folder was restored. |
Folder - Search your account. Type to start searching. |
Choice |
|
Metadata template deleted from a file - A metadata template applied to the file was deleted. |
File - Search your account. Type to start searching. |
String |
|
Metadata template deleted from a folder - A metadata template applied to the folder was deleted. |
Folder - Search your account. Type to start searching. |
Choice |
|
Metadata template applied to file - A metadata template was applied to a file. |
File - Search your account. Type to start searching. |
String |
|
Metadata template applied to a folder - A metadata template was applied to a folder. |
Folder - Search your account. Type to start searching. |
Choice |
|
Comment added - A new comment was added. |
File - Search your account. Type to start searching. |
String |
|
File downloaded - A new file was downloaded. |
Folder - Search your account. Type to start searching. |
Choice |
|
Folder created - A new folder was created. |
Folder - Search your account. Type to start searching. |
Choice |
|
Metadata attribute edited or deleted for a file - An attribute is edited or deleted for the metadata template applied to a folder. |
File - Search your account. Type to start searching. |
String |
|
Metadata attribute updated or deleted from a folder - An attribute is updated ordeleted for an existing metadata template instance associated with a folder. |
Folder - Search your account. Type to start searching. |
Choice |
|
Actions
Action |
Configuration fields |
Data type |
Required? |
---|---|---|---|
Create retention policy - Create a new retention policy. |
Retention period - Amount of time, in days, to apply the retention policy. Warning Do not specify for indefinite policies. Required for finite policies. |
Number |
|
Policy name - Enter the name of the policy to create. |
String |
|
|
Policy disposition Warning For indefinite policies, must be "Remove retention". For finite policies, can be either disposition. |
Choice |
|
|
Policy type |
Choice |
|
|
Add collaborator to folder - Grant user or group access in a specific role to a folder. |
Notify user - Choose whether the user will receive notifications. |
Boolean |
|
Accessible By Type - Choose between user or group |
Choice |
|
|
Collaborator role - Choose the type of access granted. |
Choice |
|
|
Invitee ID - Enter the collaborator ID to grant access. |
String |
|
|
Invitee email - Enter the email address of a user to grant access. Use instead of ID to invite new users. |
String |
|
|
File ID - Enter the ID of the file to grant access to. |
String |
|
|
Add collaborator to file - Grant user or group access in a specific role to a file. |
Notify user - Choose whether the user will receive notifications. |
Boolean |
|
Accessible by type - Choose the collaborator type. |
Choice |
|
|
Collaborator role - Choose the type of access granted. |
Choice |
|
|
Invitee email - Enter the email address of a user to grant access. Use instead of ID to invite new users. |
String |
|
|
File ID - Enter the ID of the file to grant access to. |
String |
|
|
Invitee ID - Enter the ID of the user or group that is granted access. |
String |
|
|
Assign legal hold policy - Assign a legal hold policy. |
Legal hold policy - Choose the legal hold policy to assign. |
Choice |
|
Assignment type - Choose the type of assignment. |
Choice |
|
|
Assignment value - Possible ID values are file_version_id, file_id, folder_id, or user_id. |
String |
|
|
Update file information - Update one or more data fields for a file. |
File ID - Enter the ID of the file to update. |
String |
|
Access - Choose the level of access for the shared link. |
Choice |
|
|
Download - Choose whether the link allows downloads. |
Boolean |
|
|
Preview - Choose whether the link allows previews. |
Boolean |
|
|
Folder ID - Enter the parent folder ID. |
String |
|
|
Tags - Enter the tags for the file (in CSV format). Warning Comma separated values |
String |
|
|
Description - Update the file description. |
String |
|
|
Filename - Update the filename. |
String |
|
|
Create shared link for a file - Create a shared link for a file. |
File ID - Enter the ID of the file to create the link for. |
String |
|
File access - Choose the level of access required. |
Choice |
|
|
Can download - Choose whether this link allows downloads Warning Can only be used with Open and Company access. |
Boolean |
|
|
Can preview - Choose whether this link allows previewing Warning Can only be used with Open and Company access. |
Boolean |
|
|
Effective access - Choose whether to use the access set by the enterprise administrator. Warning This setting overrides any previous access levels and prevents setting any less-restrictive levels. |
Boolean |
|
|
Password - Enter the password required for access. |
String |
|
|
Create shared link for a folder - Create a shared link for a folder. |
Folder ID - Enter the ID of the folder. |
Choice |
|
Folder access - Choose the level of access required. |
Choice |
|
|
Can download - Choose whether this link allows downloads. Warning Can only be used with Open and Company access. |
Boolean |
|
|
Can preview - Choose whether this link allows previevs. Warning Can only be used with Open and Company access. |
Boolean |
|
|
Effective access - Choose whether to use the access set by the enterprise administrator. Warning This setting overrides any previous access levels and prevents setting any less-restrictive levels. |
Boolean |
|
|
Password - Enter the password required for access. |
String |
|
|
Resolve task - Update a task resolution. |
Assignment ID - Enter the ID of the task assignment. |
String |
|
Task resolution - Choose the resolution of the task. |
Choice |
|
|
Message - Enter a message about the task. |
String |
|
|
Update folder information - Updates one or more fields in the folder. |
Folder ID - Enter the ID of the folder to update. |
String |
|
Sync state - Choose whether Box Sync clients will sync with this folder. |
Choice |
|
|
Preview - Choose whether the link allows downloads. |
Boolean |
|
|
Download - Choose whether this link allows downloads |
Boolean |
|
|
Description - Enter a new description for the folder. |
String |
|
|
Folder name - Enter a new name for the folder. |
String |
|
|
Access - Enter the access level required for the shared link. |
Choice |
|
|
Parent - Enter the parent folder. |
String |
|
|
Tags - Enter the tags for the folder (in CSV format). Warning Comma separated values |
String |
|
|
User ID - Enter your user ID. |
String |
|
|
Create metadata template - Create a new metadata template. |
Hidden - Choose whether the template is hidden from the UI. |
Boolean |
|
Template key - Enter a unique identifier for the template. Defaults to a string derived from the display name if no value is entered. Warning Must be unique across the enterprise. |
String |
|
|
Display name - Enter the display name of the template. |
String |
|
|
Fields - Enter the ordered set of key:value pairs for the template. Copy
|
JSON |
|
|
Create group - Create a new group. |
Invitability level - Choose who can invite this group to collaborate on folders |
Choice |
|
Description - Enter a group description, up to 255 characters. |
String |
|
|
External Sync Identifier - Enter a group identifier for groups from an external source. |
String |
|
|
Group name - Enter the name of the group. Warning You must be the admin of an enterprise account to create a group. |
String |
|
|
Provenance - Tracks the external source for the group. |
String |
|
|
Viewability level - Who can view the members of this group |
Choice |
|
|
Update web link - Update a web link URL. |
Web link id - Enter the ID of the web link. |
String |
|
Description - Enter a description of the web link. |
String |
|
|
Name - Enter a name for the web link. Defaults to the URL if empty. |
String |
|
|
Folder ID - Enter the ID of the parent folder. |
String |
|
|
URL - Enter the updated URL. Warning Must include http:// or https://. |
URL |
|
|
Create web link - Create a web link. |
Description - Enter a description of the web link. |
String |
|
Name - Enter a name for the web link. Warning Defaults to the URL if empty. |
String |
|
|
Folder ID - Enter the ID of the parent folder. |
String |
|
|
URL - Enter the URL for the web link. Warning Must include http:// or https://. |
URL |
|
|
Create task - Add a task to a file. |
Message - Enter a message about the task. |
String |
|
File ID - Enter the ID of the file to add the task to. |
String |
|
|
Due at - Set a due date for the task. |
Date |
|
|
Update task - Update an existing task. |
Task ID - Enter the ID of the task to update. |
String |
|
Message - Enter a message about the task. |
String |
|
|
Due at - Set a due date for the task. |
Date |
|
|
Create legal hold policy - Create a legal hold policy. |
Description - Enter a policy description, up to 500 characters. |
String |
|
Policy name - Enter the policy name, up to 254 characters. |
String |
|
|
Filter end date Warning Applies to custodian assignments only. |
Date |
|
|
Filter start date Warning Applies to custodian assignments only. |
Date |
|
|
Is ongoing Warning After initialization, assignments under this policy will apply to files based on events, until the policy expires. |
Boolean |
|
|
Copy file - Copy a file to another folder. |
File ID - Enter the ID of the file to copy. |
String |
|
Filename - Enter an optional new filename. |
String |
|
|
Folder ID - Enter the ID of the destination folder. |
String |
|
|
Version - To copy a specific file version, enter the version ID. |
String |
|
|
Copy folder - Create a copy of a folder in another folder. |
Source folder ID - Enter the ID of the folder to copy. |
String |
|
Name - Enter an optional new name for the folder. |
String |
|
|
Destination folder ID - Enter the ID of the destination folder. |
String |
|
|
Update legal hold policy - Update a legal hold policy. |
Legal hold policy - Choose the policy to update. |
Choice |
|
Release notes - Enter notes on the policy update. Warning (Optional) Up to 500 characters. |
String |
|
|
Description - Update the policy description, up to 500 characters. |
String |
|
|
Policy name - Update the policy name, up to 254 characters. |
String |
|
|
Comment file - Add comments to a file. |
Message - Enter the comment text. Warning Use either the message or tagged message field. |
String |
|
File ID - Enter the ID of the item that will be commented on. |
String |
|
|
Tagged message - The text body of the comment, including @[userid:Username] Warning Use either the message or tagged message field. |
String |
|
|
Assign task - Assign a task to a user. |
User email - Enter the email of the user who the task is for. |
Choice |
|
Task ID - Enter the ID of the task to assign. |
String |
|
|
Create file from text - Create a file from text. |
Text - Enter the file's content. |
String |
|
Filename - Enter the new file's name. |
String |
|
|
Folder ID - Enter the parent folder ID. |
String |
|
|
Assign retention policy to folder - Assigns a retention policy to a folder. |
Folder ID - Enter the ID of the folder to assign the policy to. |
String |
|
Policy ID - Enter the ID of the policy to assign to the folder. |
Choice |
|
|
Create folder - Create an empty folder. |
Folder ID - Enter the ID of the parent folder. |
String |
|
Folder name - Enter the name of the folder. |
String |
|
|
Assign retention policy to enterprise - Assign a retention policy to an enterprise. |
Policy ID - Enter the ID of the retention policy to assign to the enterprise. |
Choice |
|
Create metadata cascade policy - Create a metadata cascade policy that applies to a folder and a metadata instance attached to that folder. |
Template key - Enter the key of the metadata template |
Choice |
|
Folder - Search for a folder in your account where the policy will apply. Type to start searching. |
String |
|
|
Upload a new file - Upload a new file. |
Filename - Enter the new file's name. |
String |
|
Folder ID - Enter the parent folder ID. |
String |
|
|
File - Enter the URL where the file will be created before upload. |
URL |
|
|
Replace metadata for file - Update a metadata value for a file. |
Template - Choose the template to use. |
Choice |
|
File ID - Enter the file ID. |
String |
|
|
Value - Enter the new value. Warning The old metadata value must be present. |
String |
|
|
Path - Enter the path of the key in the JSON-Pointer format. Warning The value must exist in the path for testing to succeed. |
String |
|
|
Remove metadata from file - Remove a metadata value from a file. |
Template - Choose the template to use. |
Choice |
|
File ID - Enter the file ID. |
String |
|
|
Path - Enter the path of the key in the JSON-Pointer format. Warning The value must exist in the path for removal to succeed. |
String |
|
|
Test metadata for folder - Test a metadata value for a folder. |
Template - Choose the template to use. |
Choice |
|
Folder ID - Enter the ID of the folder. |
String |
|
|
Path - Enter the path of the key in the JSON-Pointer format. Warning The value must exist in the path for testing to succeed. |
String |
|
|
Value - Enter the value to be tested. Warning This value must match the existing value. |
String |
|
|
Test metadata for file - Test a metadata value for a file. |
Template - Choose the template to use. |
Choice |
|
File ID - Enter the file ID. |
String |
|
|
Path - Enter the path of the key in the JSON-Pointer format. Warning The value must exist in the path for testing to succeed. |
String |
|
|
Value - Enter the value to test. Warning This value must match the existing value. |
String |
|
|
Remove metadata from folder - Remove a metadata value from a folder. |
Template - Choose the template to use. |
Choice |
|
Folder ID - Enter the ID of the folder. |
String |
|
|
Path - Enter the path of the key in the JSON-Pointer format. Warning The value must exist in the path for testing to succeed. |
String |
|
|
Replace metadata for folder - Update a metadata value for a folder. |
Template - Choose the template to use. |
Choice |
|
Folder ID - Enter the ID of the folder. |
String |
|
|
Path - Enter the path of the key in the JSON-Pointer format. Warning The value must exist in the path for update to succeed. |
String |
|
|
Value - Enter the value to update. Warning The old metadata value must be present. |
String |
|
|
Update retention policy - Update a retention policy. |
Policy ID - Enter the ID of the policy to update. |
String |
|
Policy name - Enter the updated name of the policy. |
String |
|
|
Policy disposition Warning For indefinite policies, must be "Remove retention". For finite policies, can be either disposition. |
Choice |
|
|
Status - Retires a retention policy. Warning If not retiring a policy, do not specify, or set to null. |
Choice |
|
|
Upload new version - Upload a new version of a file. |
File ID - Enter the file ID. Warning The filename on Box remains the same. |
String |
|
File URL - Enter the URL of the updated version. |
URL |
|
|
Move file to folder - Move one file to a different folder. |
File ID - Enter the ID of the file to download. |
String |
|
Folder - Search for a folder in your account in which the file will be placed. Search for a destination folder in your account. |
String |
|
|
Apply watermark to file - Apply or update a watermark on a file. |
File ID - Enter the ID of the file to watermark. |
String |
|
Apply watermark to folder - Apply or update a watermark on a folder |
Folder ID - Enter the ID of the folder to watermark. |
String |
|
Delete folder - Delete a folder. |
Recursive - Choose whether to delete the folder if it has content. |
Boolean |
|
Folder ID - Enter the ID of the folder. Warning Depending on the enterprise settings, the folder will be deleted from Box or moved to the trash. |
String |
|
|
Delete metadata cascade policy - Delete a metadata cascade policy for a folder and a metadata instance attached to that folder. |
Cascade policy ID - Search for the UUID of the policy. Type to start searching. |
String |
|
Delete metadata template for file - Delete a metadata template from a file. |
Template - Choose the template to delete. |
Choice |
|
File ID - Enter the file ID. |
String |
|
|
Delete metadata template for folder - Delete a metadata template from a folder. |
Template - Choose the template to delete. |
Choice |
|
Folder ID - Enter the ID of the folder. |
String |
|
|
Delete shared link for a file - Delete a shared link for a file. |
File ID - Enter the ID of the file to delete the link for. |
String |
|
Delete shared link for a folder - Delete a shared link for a folder. |
Folder ID - Enter the ID of the folder. |
Choice |
|
Remove watermark from file - Delete the watermark from a file. |
File ID - Enter the ID of the file to remove the watermark from. |
String |
|
Remove watermark from folder - Delete the watermark on a folder. |
Folder ID - Enter the ID of the folder to remove the watermark from. |
String |
|
Download file - Download a file. |
File ID - Enter the ID of the file to download. |
String |
|
Delete web link - Move a web link to the trash. |
Web link id - Enter the ID of the web link to delete. |
String |
|
Get all the collaborations for a file - Retrieve a file's collaborations. |
File ID - Enter the ID of the file to get collaborations for. |
String |
|
Get all collaborations on a folder - Retrieve a folder's collaborations. |
Folder ID - Enter the ID of the folder to get collaborations for. |
String |
|
Get embedded preview link - Retrieve an expiring URL for an embedded preview session. |
File ID - Enter the ID of the file to get the expiring URL and embedded preview session for. |
String |
|
Get folder information - Retrieve metadata for a folder. |
Folder ID - Enter the ID of the folder. Warning The root folder of a Box account is always represented by the ID 0. |
Choice |
|
Extract text from file - Retrieve the file's text. |
File ID - Enter the ID of the file to extract text from. |
String |
|
Version ID - Enter the ID of the file version. |
String |
|
|
Get file information - Retrieves metadata for a file. |
File ID - Enter the ID of the file to retrieve metadata for. |
String |
|
Get metadata template - Return a metadata template. |
Template - Choose the template to add. |
Choice |
|
Get metadata cascade policies - Return a set of metadata cascade policies. |
Owner enterprise ID - Enter the ID of the owner of the policies. Warning If not specified, defaults to the current enterprise. |
String |
|
Folder - Search for a folder in your account where the policies apply. Type to start searching. |
String |
|
|
Find one file - Return a single file from a query. |
Content type - Choose the content type. |
Multi-Choice |
|
Trash search - Choose whether to search only trash, or only non-trash. |
Choice |
|
|
File extensions - Enter a single file extension or a comma-delimited list. |
String |
|
|
Ancestor folder IDs - Enter one or more folder IDs. Warning Requires a folder ID or a set of comma-delimited folder IDs. |
String |
|
|
Metadata filters - Enter the associated metadata to search for. |
JSON |
|
|
Query - Enter the search string. |
String |
|
|
Find one folder - Return a single folder from a query. |
Trash search - Choose whether to search only trash, or only non-trash. |
Choice |
|
Ancestor folder IDs - Enter one or more folder IDs. Requires a folder ID or a set of comma-delimited folder IDs. |
String |
|
|
Metadata filters - Enter the associated metadata to search for. |
JSON |
|
|
Query - Enter the search string. |
String |
|
|
Get all metadata for file - Return all metadata for a file. |
File ID - Enter the file ID. |
String |
|
Get all metadata for folder - Return all metadata for a folder. |
Folder ID - Enter the ID of the folder. |
String |
|
Get metadata cascade policy - Return information about a metadata cascade policy. |
Cascade policy ID - Enter the UUID of the policy. Type to start searching. |
String |
|
Find files - Return one or more files from a query. |
Content type - Choose the content type. |
Multi-Choice |
|
Trash search - Choose whether to search only trash, or only non-trash. |
Choice |
|
|
Ancestor folder IDs - Enter one or more folder IDs. |
String |
|
|
Metadata filters - Enter the associated metadata to search for. |
JSON |
|
|
Created range - Enter the date or range when the item was created. Warning Use RFC3339 timestamps separated by a required comma. For example: 2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00 |
String |
|
|
Updated range - Enter the date or range when the item was updated. Warning Use RFC3339 timestamps separated by a required comma. For example: 2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00 |
String |
|
|
Limit - Enter the maximum number of items to return. Warning The default is 30; maximum is 200. |
String |
|
|
Offset - Enter the numeric offset for the first entry in the results. Warning If specified, must be a multiple of the limit. |
String |
|
|
Query - Enter the search string. |
String |
|
|
File extensions - Limit searches to specific file extensions Warning The value can be a single file extension or a comma-delimited list of extensions |
String |
|
|
Find folder - Return one or more folders from a query. |
Trash search - Choose whether to search only trash, or only non-trash. |
Choice |
|
Ancestor folder IDs - Enter one or more folder IDs. Requires a folder ID or a set of comma-delimited folder IDs. |
String |
|
|
Metadata filters - Enter the associated metadata to search for. |
JSON |
|
|
Limit - Enter the maximum number of items to return. Warning The default is 30; maximum is 200. |
String |
|
|
Offset - Enter the numeric offset for the first entry in the results. Warning If specified, must be a multiple of the limit. |
String |
|
|
Query - Enter the search string. |
String |
|
|
Get metadata template for a file - Return the metadata template for a file. |
Template - Choose the template to use. Choose the template to return. |
Choice |
|
File ID - Enter the file ID. |
String |
|
|
Get metadata template for folder - Return the metadata template for a folder. |
Template - Choose the template to return. |
Choice |
|
Folder ID - Enter the ID of the folder. |
String |
|
|
Get watermark for file - Return the watermark on a file. |
File ID - Enter the ID of the file to return the watermark for. |
String |
|
Get watermark for folder - Return the watermark on a folder. |
Folder ID - Enter the ID of the folder to return the watermark for. |
String |
|
Read web link - Return the web link object. |
Web link id - Enter the ID of the web link |
String |
|
Add metadata to folder - Add a metadata template to a folder. |
Template - Choose the template to add. |
Choice |
|
Folder ID - Enter the ID of the folder. |
String |
|
|
Create metadata on file - creates a new metadata on file |
Template - Choose the template to use. |
Choice |
|
File ID - Enter the file ID. |
String |
|