Box Connector Reference 5.3 | MuleSoft Documentation
| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * BOX:BAD_REQUEST
  * BOX:CLIENT_ERROR
  * BOX:CONNECTIVITY
  * BOX:INTERNAL_SERVER_ERROR
  * BOX:NOT_ACCEPTABLE
  * BOX:NOT_FOUND
  * BOX:RETRY_EXHAUSTED
  * BOX:SERVER_ERROR
  * BOX:SERVICE_UNAVAILABLE
  * BOX:TIMEOUT
  * BOX:TOO_MANY_REQUESTS
  * BOX:UNAUTHORIZED
  * BOX:UNSUPPORTED_MEDIA_TYPE


## Update web link
`<box:update-web-links-by-web-link-id>`
Updates a web link object. This operation makes an HTTP PUT request to the /web_links/{web_link_id} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Web link id | The ID of the web link.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * BOX:BAD_REQUEST
  * BOX:CLIENT_ERROR
  * BOX:CONNECTIVITY
  * BOX:INTERNAL_SERVER_ERROR
  * BOX:NOT_ACCEPTABLE
  * BOX:NOT_FOUND
  * BOX:RETRY_EXHAUSTED
  * BOX:SERVER_ERROR
  * BOX:SERVICE_UNAVAILABLE
  * BOX:TIMEOUT
  * BOX:TOO_MANY_REQUESTS
  * BOX:UNAUTHORIZED
  * BOX:UNSUPPORTED_MEDIA_TYPE


## Update webhook
`<box:update-webhooks-by-webhook-id>`
Updates a webhook. This operation makes an HTTP PUT request to the /webhooks/{webhook_id} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Webhook id | The ID of the webhook.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * BOX:BAD_REQUEST
  * BOX:CLIENT_ERROR
  * BOX:CONNECTIVITY
  * BOX:INTERNAL_SERVER_ERROR
  * BOX:NOT_ACCEPTABLE
  * BOX:NOT_FOUND
  * BOX:RETRY_EXHAUSTED
  * BOX:SERVER_ERROR
  * BOX:SERVICE_UNAVAILABLE
  * BOX:TIMEOUT
  * BOX:TOO_MANY_REQUESTS
  * BOX:UNAUTHORIZED
  * BOX:UNSUPPORTED_MEDIA_TYPE


## On Download File Trigger
`<box:on-download-file-listener>`
Initiates a flow when a download file event occurs.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Folder ID | ID of the folder.  
Include sub-folders | Determines whether to include subfolders or not.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Primary Node Only | Whether this source should only be executed on the primary node when running in a cluster.  
Scheduling Strategy |  scheduling-strategy | Configures the scheduler that triggers the polling.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Redelivery Policy |  Redelivery Policy | Defines a policy for processing the redelivery of the same message.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### For Configurations
  * 

## On New File in Folder
`<box:on-new-file-in-folder-listener>`
Initiates a flow when a file is created in a folder.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Folder ID | ID of the folder.  
Include sub-folders | Determines whether to include subfolders or not.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Primary Node Only | Whether this source should only be executed on the primary node when running in a cluster.  
Scheduling Strategy |  scheduling-strategy | Configures the scheduler that triggers the polling.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Redelivery Policy |  Redelivery Policy | Defines a policy for processing the redelivery of the same message.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### For Configurations
  * 

## On New Folder
`<box:on-new-folder-listener>`
Initiates a flow when a folder is created in a folder.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Folder ID | ID of the folder.  
Include sub-folders | Determines whether to include subfolders or not.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Primary Node Only | Whether this source should only be executed on the primary node when running in a cluster.  
Scheduling Strategy |  scheduling-strategy | Configures the scheduler that triggers the polling.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Redelivery Policy |  Redelivery Policy | Defines a policy for processing the redelivery of the same message.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### For Configurations
  *
| A retry strategy in case of connectivity errors.  
### For Configurations
  * 

## On New Folder
`<box:on-new-folder-listener>`
Initiates a flow when a folder is created in a folder.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Folder ID | ID of the folder.  
Include sub-folders | Determines whether to include subfolders or not.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Primary Node Only | Whether this source should only be executed on the primary node when running in a cluster.  
Scheduling Strategy |  scheduling-strategy | Configures the scheduler that triggers the polling.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Redelivery Policy |  Redelivery Policy | Defines a policy for processing the redelivery of the same message.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### For Configurations
  * 

## On New Task Created
`<box:on-new-task-created-listener>`
Initiates a flow when a task assignment is created.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Assigned To | The user to assign the task to.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Primary Node Only | Whether this source should only be executed on the primary node when running in a cluster.  
Scheduling Strategy |  scheduling-strategy | Configures the scheduler that triggers the polling.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Redelivery Policy |  Redelivery Policy | Defines a policy for processing the redelivery of the same message.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### For Configurations
  * 

## Types
### Default Header
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
### Default Query Param
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
### Proxy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Non Proxy Hosts  
### Reconnection
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Fails Deployment | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy  
Reconnection Strategy | 
  *   * Reconnect Forever

| The reconnection strategy to use  
### Reconnect
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Frequency | How often (in ms) to reconnect  
Blocking | If false, the reconnection strategy will run in a separate, non-blocking thread  
How many reconnection attempts to make  
### Reconnect Forever
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Frequency | How often (in ms) to reconnect  
Blocking | If false, the reconnection strategy runs in a separate, non-blocking thread.  
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Enabled Protocols | A comma-separated list of protocols enabled for this context.  
Enabled Cipher Suites | A comma-separated list of cipher suites enabled for this context.  
Trust Store  
Key Store  
Revocation Check | 
  * Standard Revocation Check
  * Custom Ocsp Responder

  
### Trust Store
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.  
Password | The password used to protect the trust store.  
The type of store used.  
Algorithm | The algorithm used by the trust store.  
Insecure | If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.  
### Key Store
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.  
The type of store used.  
When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.  
Key Password | The password used to protect the private key.  
Password | The password used to protect the key store.  
Algorithm | The algorithm used by the key store.  
### Standard Revocation Check
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Only End Entities | Only verify the last element of the certificate chain.  
Prefer Crls | Try CRL instead of OCSP first.  
No Fallback | Do not use the secondary checking method (the one not selected before).  
Soft Fail | Avoid verification failure when the revocation server can not be reached or is busy.  
### Custom Ocsp Responder
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The URL of the OCSP responder.  
Cert Alias | Alias of the signing certificate for the OCSP response (must be in the trust store), if present.  
### Crl File
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The path to the CRL file.  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Max Idle Time | A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration  
Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
| A time unit that qualifies the maxIdleTime attribute  
### Http Response Attributes
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Status Code  
Reason Phrase  
### Repeatable In Memory Stream
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Initial Buffer Size | This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.  
Buffer Size Increment | This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.  
Max Buffer Size | This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.  
Buffer Unit |  Enumeration, one of: | The unit in which all these attributes are expressed  
### Repeatable File Store Stream
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
In Memory Size | Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.  
Buffer Unit |  Enumeration, one of: | The unit in which maxInMemorySize is expressed  
### Redelivery Policy
Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Max Redelivery Count | Maximum number of times that a delivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.  
Message Digest Algorithm | Secure hashing algorithm to use if the **Use Secure Hash** field is `true`. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s `hashCode()` returned.  
Message Identifier |  Redelivery Policy Message Identifier | Configures the non-repeatable streaming strategy by which Mule disables repeatable streams. Use this strategy if your use case requires reading the content only once.  
Object Store |  ObjectStore | Configures the object store that stores the redelivery counter for each message.  
### Redelivery Policy Message Identifier
Configures how to identify a redelivered message and how to find out when the message was redelivered.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Use Secure Hash | If `true`, Mule uses a secure hash algorithm to identify a redelivered message.  
Id Expression | Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if the **Use Secure Hash** field is false.  
### Repeatable In Memory Iterable
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Initial Buffer Size | This is the number of instances initially allowed to be kept in memory in order to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it will be expanded according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.  
Buffer Size Increment | This is by how much the buffer size will be expanded if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, and that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. Default value is 100 instances.  
Max Buffer Size | This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.  
### Repeatable File Store Iterable
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
In Memory Objects | This is the maximum amount of instances that will be kept in memory. If more than that is required, then it will start to buffer the content on disk.  
Buffer Unit |  Enumeration, one of: | The unit in which maxInMemorySize is expressed  
## See Also
MuleSoft Help Center