Box Listener

Updated on: May 14, 2025
Published on: Mar 18, 2025
Read Time: 3 minute(s)

Accessing this feature

Your access to the feature described in this article depends on your license package and pricing plan. To learn which features are available to your organization and how to add more, contact your Hyperscience representative.

With our Box Listener Input Block, you can process content stored in Box. This content can then be mapped back to Box content as metadata or sent to other downstream systems.

The Box Listener Input Block is available in both SaaS and on-premise versions of the Hyperscience application.

Sample use cases

Users can take extracted metadata from Box’s content and map it to the metadata fields on the content itself.
Users can take extracted data from Box’s content and send it downstream for further processing via an HTTP Notifier Block or another Output Block.

Block settings table

In addition to the settings outlined below, you can also configure the settings described in Universal Integration Block Settings.

Name	Required?	Description
Folder To Scan For Submissions	Yes	The ID of the Box folder the connector scans for image files.
Folder to Move Completed Files	Yes	The ID of the Box folder that files are sent to after ingestion.
File Extensions	Yes	A list of the extensions eligible for processing.
Other File Extension Types	No	A comma-separated list of file extensions that do not appear above.
Private-Key	Yes	The privateKey from the JWT credentials JSON file.
Passphrase	Yes	The passphrase from the JWT credentials JSON file.
Public-Key ID	Yes	The publicKeyID from the JWT credentials JSON file.
Client ID	Yes	The clientID from the JWT credentials JSON file.
Client Secret	Yes	The clientSecret from the JWT credentials JSON file.
Enterprise ID	Yes	The enterpriseID from the JWT credentials JSON file.
Polling Interval (In Seconds)	No	Frequency for monitoring the source folder for submissions.
Warm-up Interval (In Seconds)	No	Time a file must remain unmodified before processing.

Setting up Box Listener

1. Create a Box Custom App with server authentication (JWT).

Follow the steps in Box's Setup with JWT.

Have Box generate a public/private keypair by going to the Configuration tab of the Developer Console.
Set the App Access Level to App Access Only and select Write all files and folders stored in Box.

When you finish, click Download as JSON to save the JWT credentials. You will need this for your Box connections in Hyperscience.

2. Obtain the email address of the app's Service Account.

After your app has been authorized, go to the General Settings tab of the Developer Console and copy the email address found in Service Account Info.

3. Add the Service Account as a collaborator and obtain the IDs of the source and target folders.

Using the Service Account's email address, invite the Service Account to collaborate on the folder as an Editor. Go to the folder in Box and copy the folder ID from the URL.

4. Create the Box Folder Listener connection in Hyperscience.

Follow the steps to add a Box Folder Listener connection as described in Managing Connections.

5. Configure the Box Folder Listener connection.

Enter the connection information as described in the Block settings table.