Box Spoke

Request apps on the Store

Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

Integration Hub subscription

This spoke requires an Integration Hub subscription. For more information, see Legal schedules - IntegrationHub overview.

Spoke version

Box spoke v3.3.1 is the latest version.

Supported versions

API version v2.

Spoke requirements

Ensure that same languages are selected in your ServiceNow instance and Box account.

In your ServiceNow instance, select the required language by navigating to User Profile > Preferences > Display.
In your Box account, select the required language by navigating to Account Settings > Account > General Options.

Spoke flows

The Box spoke provides sample flows in the draft state to demonstrate automating Box tasks. To customize a sample flow, copy it to a new application scope. Available sample flows include:


Flow	Description
Move Attachment when created to Box	Moves attachment files from ServiceNow to Box when a new attachment record is added. Updates the trigger record with a shared link to the moved attachment file on Box.
On-boarding user	Creates a user in Box when you create a ServiceNow user in the Box User group.

Spoke actions

The Box spoke provides actions to automate Box tasks when events occur in ServiceNow. Available actions include:


Category	Action	Description
Document Management	Add Metadata to File	Stores the provided attributes information by adding it as metadata for Box files.
	Attach Box File to Record	Copies a file from Box and attaches it to the specified ServiceNow record.
	Lookup File ID	Retrieves the ID of the specified file in Box.
	Move Owned Item	Moves all items owned by the specified user in Box to the specified folder.
	Remove File	Removes the specified file from Box.
	Search Content Stream	Searches for files, folders, web links, and shared files across the user's content or across the entire enterprise.
	Upload File	Uploads the specified file to Box.
Document Sharing	Add Collaborator	Grants a user or group a specified level of access to a particular file or folder. Collaborators have one of these access levels. Co-Owner Editor Previewer Preview Uploader Uploader Viewer Viewer Uploader
	Create Shared Link	Create a direct and read-only link to a file or folder in Box.
	Look up Folder Collaborators By ID	Retrieves all the collaborators associated to the specified folder ID.
	Remove Collaborator	Removes the specified collaboration from a file or folder in Box.
Folder Management	Create Folder	Creates a folder in Box on behalf of the specified Box user account.
	Delete Folder	Deletes the specified folder in Box.
	Lookup Folder ID	Retrieves the ID of the specified folder in Box. Note: Items added to Box require 10 minutes to become accessible. For example, if one action creates a folder, a Lookup Folder ID action won’t return results until after 10 minutes have passed.
Group Management	Create Group	Creates a group in Box with the specified invitation preferences.
	Delete Group	Deletes the specified group in Box.
	Update Group	Updates the specified group in Box with the specified preferences.
Legal Hold Management	Assign Legal Hold Policy	Assigns a legal hold policy to a file, file version, folder, or user.
	Create Legal Hold Policy	Creates a legal hold policy.
	Look up All Legal Hold Policies Stream	Retrieves a list of legal hold policies of an enterprise.
	Look up Legal Hold Policy Assignment by ID	Retrieves a legal hold policy assignment for the specified ID.
	Look up Legal Hold Policy Assignments Stream	Retrieves a list of items assigned to a legal hold policy.
	Look up Legal Hold Policy by ID	Retrieves a legal hold policy for the specified ID.
	Remove legal hold policy	Deletes an existing legal hold policy.
	Unassign Legal Hold Policy	Removes the assignment of an item to a legal hold.
	Update Legal Hold Policy	Updates a legal hold policy.
Metadata Management	Look up Metadata Instance on File By File ID	Retrieves the metadata instance of the file with the specified file ID.
	Look up Metadata Instance on File by Scope and Template Key	Retrieves the metadata instance of a folder with the specified scope and template key.
	Look up Metadata Instance on Folder By Folder ID	Retrieves all the metadata of the folder with the specified folder ID. Note: Don’t use this action on a root folder that has a folder ID value as zero.
	Look up Metadata Instance on Folder by Scope and Template Key	Retrieves all the metadata of a folder with the specified scope and template key.
	Query Files or Folders by Metadata Stream	Searches for files or folders using SQL-like syntax and returns the matching results.
Retention Policy Management	Assign Retention Policy	Assigns a retention policy to an item.
	Create Retention Policy	Creates a retention policy.
	Look up Retention Policies	Retrieves all the retention policies of an enterprise.
	Look up Retention Policy Assignment By ID	Retrieves the retention policy with the specified ID.
	Look up Retention Policy Assignments Stream	Returns a list of all retention policy assignments associated with a specified retention policy.
	Look up Retention Policy by ID	Retrieves the retention policy with the specified ID.
	Update Retention Policy	Updates a retention policy.
User Management	Add User to Group	Adds the specified user to the specified group in Box.
	Create User	Creates a user account in Box.
	Delete User	Deletes the specified user in Box.
	Disable User	Sets the status of the specified user in Box to inactive.
	Enable User	sets the status of the specified user in Box to active.
	Lookup User ID	Retrieves the ID of the specified user in Box.
	Update User	Updates the specified user in Box with the specified role changes.
Webhook Management	Create Webhook	Creates a webhook.
	Look up Webhook By ID	Retrieves the webhook with the specified ID.
	Look up Webhooks Stream	Retrieves all the defined webhooks for the specified application.
	Remove Webhook	Removes a webhook.
	Update Webhook	Updates a webhook.

Box spoke module

Bi-directional webhooks can be set up to be notified about the required events. A webhook registry defines the conditions that must be met to notify the ServiceNow app. These conditions are based on the events in Box that you want to be notified about. When the conditions are met, the specified trigger name triggers the associated subflow, which in turn automates the Box tasks.

Webhooks require separate setup and can be used independently without using the spoke actions. The Box spoke adds the Box Spoke application to your instance and includes the following modules.

Table 1. Box module
Module	Description
Box Webhook Registry	Create and view the Plivo webhooks in ServiceNow.
Legal Hold Policies	View the list of available Box legal policies.
Retention Policies	View the list of available Box retention policies.

Box account requirements

The Box spoke requires creating a custom app on your Box account to generate OAuth 2.0 tokens. See Create an OAuth application.

Connection and credential alias requirements

Integration Hub uses aliases to manage connection and credential information, and OAuth credentials. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using multiple environments. If the connection or credential information changes, you don't need to update any actions that use the connection.

This spoke uses the following alias records to authorize actions.


Connection & Credential alias	Description	Connection alias requirements
Box	Connection to the Box Collaboration and File Management APIs.	Connection type: HTTP Connection URL: https://api.box.com
Box Upload	Connection to the Box upload service.	Connection type: HTTP Connection URL: https://upload.box.com

To use the spoke connection aliases, create an associated Connection record and an associated Credential record for each alias. For information about setting up the spoke, see Set up the Box spoke.