Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Enable Box Automate

Your Box admin must (and any add-on products you use in flows, such as Box AI Studio) for the enterprise to begin using Automate. If a scope or feature is not available in the Developer Console, contact Box Support or your account team with the user or app context you plan to use.

​
Manual Start API

You can trigger Manual Start workflows programmatically using the Box API.
EndpointMethodDescription
List workflows with Manual Start triggerGETRetrieve all Automate workflows with a Manual Start trigger set for a given folder. Returns a workflow list. Folder ID is required.
Trigger a Manual Start workflowPOSTTrigger a specific workflow with chosen files.

​
Request Parameters:

  • files - provide file IDs in the request body (optional if triggering on a folder; max 20 files per request)
  • fields defined at start - when a workflow requires runtime fields (for example, task assignees, notification recipients), include them in the API call. Missing required fields return an error.
Use the Custom HTTP Request outcome to connect your Box Automate workflows to external apps and APIs. The HTTPS request outcome is available for all Enterprise Advanced users with Automate enabled. However, your Admin needs to either add Connectors to the allow-list in settings or enable you to add your own from the builder.
Note: If your admin has turned off the option to add your own connectors, you can only select from pre-approved connectors in the dropdown.
To add a Custom HTTP request outcome:
  1. Open Workflow Builder.
  2. Add the Custom HTTP request outcome.
  3. Fill in the fields:
  • URL: Choose a connector, or add a new one if allowed.
  • Method: Select GET, POST, DELETE, PUT, or PATCH.
  • Query Parameters: Add any key-value pairs you need.
  • Authentication: Choose an auth type and enter the required info.
  • Headers: Add optional headers.
  • Body: Enter the JSON request body.
  • Description: Briefly say what the request does.
Authentication options:
  • OAuth 2.0 Client Credentials: Client ID, Client Secret, Authorization URL, Token URL, Scopes
  • Basic Auth: Username and password
  • Bearer Token: Token
  • API Key: API key
  • Custom Header: Header name and value
Test Your Connection
  1. After configuring your outcome, click the Test button.
  2. Review the test response code to confirm the connection works.
  3. The builder automatically captures response properties and creates variables for you.
  4. Use the JSON path: https://jsonpath.com/ to verify and see the variables from the test response.