Workable Connector 0.1.0 Reference | MuleSoft Documentation

Configurations

Config

Default configuration.

Parameters

Name	Type	Description	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.	x
Connection	Bearer Auth	The connection types to provide to this configuration.	x
Name	String	The identifier of this element used to reference it in other components.	x
Expiration Policy	Expiration Policy	Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

Name

Type

Description

Default Value

Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

Bearer Auth

The connection types to provide to this configuration.

x

Name

String

The identifier of this element used to reference it in other components.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

Connection Types

Bearer Auth

Provides access to the Workable API using a bearer token.

Parameters

Name	Type	Description	Required
baseUri	String	The base URI for the Workable API.	x
token	String	The API key token for authentication.	x
TLS Configuration	TLS	The TLS configuration for secure connections.
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Name

Type

Description

Default Value

Required

baseUri

String

The base URI for the Workable API.

x

token

String

The API key token for authentication.

x

TLS Configuration

TLS

The TLS configuration for secure connections.

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Operations

addCandidateComment

<workable:add-candidate-comment>

Adds a comment to a candidate record.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
id	String	Candidate identifier associated with the comment.		x
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

id

String

Candidate identifier associated with the comment.

x

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Config

Throws

WORKABLE:BAD_REQUEST
WORKABLE:CLIENT_ERROR
WORKABLE:CONNECTIVITY
WORKABLE:FORBIDDEN
WORKABLE:INTERNAL_SERVER_ERROR
WORKABLE:NOT_FOUND
WORKABLE:SECURITY
WORKABLE:SERVER_ERROR
WORKABLE:TIMEOUT
WORKABLE:TOO_MANY_REQUESTS
WORKABLE:UNAUTHORIZED
WORKABLE:UNPROCESSABLE_ENTITY

addCandidateRating

<workable:add-candidate-rating>

Adds a rating to a candidate record.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
id	String	Candidate identifier to rate.		x
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

id

String

Candidate identifier to rate.

x

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Config

Throws

WORKABLE:BAD_REQUEST
WORKABLE:CLIENT_ERROR
WORKABLE:CONNECTIVITY
WORKABLE:FORBIDDEN
WORKABLE:INTERNAL_SERVER_ERROR
WORKABLE:NOT_FOUND
WORKABLE:SECURITY
WORKABLE:SERVER_ERROR
WORKABLE:TIMEOUT
WORKABLE:TOO_MANY_REQUESTS
WORKABLE:UNAUTHORIZED
WORKABLE:UNPROCESSABLE_ENTITY

copyCandidateToJob

<workable:copy-candidate-to-job>

Copies a candidate to a different job.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
id	String	Candidate identifier to copy.		x
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

id

String

Candidate identifier to copy.

x

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Config

Throws

WORKABLE:BAD_REQUEST
WORKABLE:CLIENT_ERROR
WORKABLE:CONNECTIVITY
WORKABLE:FORBIDDEN
WORKABLE:INTERNAL_SERVER_ERROR
WORKABLE:NOT_FOUND
WORKABLE:SECURITY
WORKABLE:SERVER_ERROR
WORKABLE:TIMEOUT
WORKABLE:TOO_MANY_REQUESTS
WORKABLE:UNAUTHORIZED
WORKABLE:UNPROCESSABLE_ENTITY

createCandidateForJob

<workable:create-candidate-for-job>

Creates a candidate for a specific job.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
shortcode	String	Job shortcode that receives the candidate.		x
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

shortcode

String

Job shortcode that receives the candidate.

x

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Config

Throws

WORKABLE:CLIENT_ERROR
WORKABLE:CONNECTIVITY
WORKABLE:FORBIDDEN
WORKABLE:NOT_FOUND
WORKABLE:SECURITY
WORKABLE:SERVER_ERROR
WORKABLE:TIMEOUT
WORKABLE:UNAUTHORIZED
WORKABLE:UNPROCESSABLE_ENTITY

createCandidateInTalentPool

<workable:create-candidate-in-talent-pool>

Creates a candidate in the talent pool.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

x

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Config

Throws

WORKABLE:CLIENT_ERROR
WORKABLE:CONNECTIVITY
WORKABLE:FORBIDDEN
WORKABLE:SECURITY
WORKABLE:SERVER_ERROR
WORKABLE:TIMEOUT
WORKABLE:UNAUTHORIZED
WORKABLE:UNPROCESSABLE_ENTITY

disqualifyCandidate

<workable:disqualify-candidate>

Disqualifies a candidate from further consideration.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
id	String	Candidate identifier to disqualify.		x
body	Any	Payload that defines the disqualification details.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation output.
Target Value	String	Expression evaluated against the operation output and stored in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

id

String

Candidate identifier to disqualify.

x

body

Any

Payload that defines the disqualification details.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation output.

Target Value

String

Expression evaluated against the operation output and stored in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Null

Attributes Type

Any

For Configurations

Config

Throws

WORKABLE:BAD_REQUEST
WORKABLE:CLIENT_ERROR
WORKABLE:CONNECTIVITY
WORKABLE:FORBIDDEN
WORKABLE:INTERNAL_SERVER_ERROR
WORKABLE:NOT_FOUND
WORKABLE:SECURITY
WORKABLE:SERVER_ERROR
WORKABLE:TIMEOUT
WORKABLE:TOO_MANY_REQUESTS
WORKABLE:UNAUTHORIZED
WORKABLE:UNPROCESSABLE_ENTITY

getAllCandidates

<workable:get-all-candidates>

Retrieves all candidates that meet the provided filter criteria.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
limit	Number	The maximum number of results to return.
since_id	String	Returns candidates created after the specified candidate ID.
max_id	String	Returns candidates created before the specified candidate ID.
created_after	DateTime	Returns candidates created after the specified date and time.
updated_after	DateTime	Returns candidates updated after the specified date and time.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

limit

Number

The maximum number of results to return.

since_id

String

Returns candidates created after the specified candidate ID.

max_id

String

Returns candidates created before the specified candidate ID.

created_after

DateTime

Returns candidates created after the specified date and time.

updated_after

DateTime

Returns candidates updated after the specified date and time.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Config

Throws

WORKABLE:BAD_REQUEST
WORKABLE:CLIENT_ERROR
WORKABLE:CONNECTIVITY
WORKABLE:FORBIDDEN
WORKABLE:NOT_FOUND
WORKABLE:SECURITY
WORKABLE:SERVER_ERROR
WORKABLE:TIMEOUT
WORKABLE:UNAUTHORIZED

getCandidateActivities

<workable:get-candidate-activities>

Retrieves activity records for a candidate.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
id	String	Candidate identifier whose activities you want to retrieve.		x
limit	Number	The maximum number of results to return.
offset	Number	Number of activity records to skip before returning results.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

id

String

Candidate identifier whose activities you want to retrieve.

x

limit

Number

The maximum number of results to return.

offset

Number

Number of activity records to skip before returning results.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Config

Throws

WORKABLE:BAD_REQUEST
WORKABLE:CLIENT_ERROR
WORKABLE:CONNECTIVITY
WORKABLE:FORBIDDEN
WORKABLE:INTERNAL_SERVER_ERROR
WORKABLE:NOT_FOUND
WORKABLE:SECURITY
WORKABLE:SERVER_ERROR
WORKABLE:TIMEOUT
WORKABLE:TOO_MANY_REQUESTS
WORKABLE:UNAUTHORIZED

getCandidateById

<workable:get-candidate-by-id>

Retrieves a candidate by identifier.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
id	String	Candidate identifier to retrieve.		x
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

id

String

Candidate identifier to retrieve.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Config

Throws

WORKABLE:BAD_REQUEST
WORKABLE:CLIENT_ERROR
WORKABLE:CONNECTIVITY
WORKABLE:FORBIDDEN
WORKABLE:NOT_FOUND
WORKABLE:SECURITY
WORKABLE:SERVER_ERROR
WORKABLE:TIMEOUT
WORKABLE:UNAUTHORIZED

getCandidateOffer

<workable:get-candidate-offer>

Retrieves the offer details for a candidate.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
id	String	Candidate identifier whose offer you want to retrieve.		x
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable .	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

id

String

Candidate identifier whose offer you want to retrieve.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable .

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Config

Throws

WORKABLE:BAD_REQUEST
WORKABLE:CLIENT_ERROR
WORKABLE:CONNECTIVITY
WORKABLE:FORBIDDEN
WORKABLE:INTERNAL_SERVER_ERROR
WORKABLE:NOT_FOUND
WORKABLE:SECURITY
WORKABLE:SERVER_ERROR
WORKABLE:TIMEOUT
WORKABLE:TOO_MANY_REQUESTS
WORKABLE:UNAUTHORIZED

moveCandidateToStage

<workable:move-candidate-to-stage>

Moves a candidate to a different recruitment stage.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
id	String	Candidate identifier to move.		x
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

id

String

Candidate identifier to move.

x

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Null

Attributes Type

Any

For Configurations

Config

Throws

WORKABLE:BAD_REQUEST
WORKABLE:CLIENT_ERROR
WORKABLE:CONNECTIVITY
WORKABLE:FORBIDDEN
WORKABLE:INTERNAL_SERVER_ERROR
WORKABLE:NOT_FOUND
WORKABLE:SECURITY
WORKABLE:SERVER_ERROR
WORKABLE:TIMEOUT
WORKABLE:TOO_MANY_REQUESTS
WORKABLE:UNAUTHORIZED
WORKABLE:UNPROCESSABLE_ENTITY

revertCandidateDisqualification

<workable:revert-candidate-disqualification>

Reverts a candidate disqualification.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
id	String	Candidate identifier to reinstate.		x
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

id

String

Candidate identifier to reinstate.

x

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Null

Attributes Type

Any

For Configurations

Config

Throws

WORKABLE:BAD_REQUEST
WORKABLE:CLIENT_ERROR
WORKABLE:CONNECTIVITY
WORKABLE:FORBIDDEN
WORKABLE:INTERNAL_SERVER_ERROR
WORKABLE:NOT_FOUND
WORKABLE:SECURITY
WORKABLE:SERVER_ERROR
WORKABLE:TIMEOUT
WORKABLE:TOO_MANY_REQUESTS
WORKABLE:UNAUTHORIZED

updateCandidate

<workable:update-candidate>

Updates candidate details.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
id	String	Candidate identifier to update.		x
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

id

String

Candidate identifier to update.

x

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Config

Throws

WORKABLE:BAD_REQUEST
WORKABLE:CLIENT_ERROR
WORKABLE:CONNECTIVITY
WORKABLE:FORBIDDEN
WORKABLE:NOT_FOUND
WORKABLE:SECURITY
WORKABLE:SERVER_ERROR
WORKABLE:TIMEOUT
WORKABLE:UNAUTHORIZED
WORKABLE:UNPROCESSABLE_ENTITY

updateCandidateTags

<workable:update-candidate-tags>

Updates tags assigned to a candidate.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
id	String	Candidate identifier whose tags you want to update.		x
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

id

String

Candidate identifier whose tags you want to update.

x

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Config

Throws

WORKABLE:BAD_REQUEST
WORKABLE:CLIENT_ERROR
WORKABLE:CONNECTIVITY
WORKABLE:FORBIDDEN
WORKABLE:INTERNAL_SERVER_ERROR
WORKABLE:NOT_FOUND
WORKABLE:SECURITY
WORKABLE:SERVER_ERROR
WORKABLE:TIMEOUT
WORKABLE:TOO_MANY_REQUESTS
WORKABLE:UNAUTHORIZED
WORKABLE:UNPROCESSABLE_ENTITY

Types

TLS

Configures TLS to provide secure communications for the Mule app.

Field	Type	Description
Enabled Protocols	String	A comma-separated list of protocols enabled for this context.
Enabled Cipher Suites	String	A comma-separated list of cipher suites enabled for this context.
Trust Store	Truststore	Configures the TLS truststore.
Key Store	Keystore	Configures the TLS keystore.
Revocation Check	Standard Revocation Check Custom OCSP Responder CRL File	Configures a revocation checking mechanism.

Field

Type

Description

Default Value

Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Truststore

Configures the TLS truststore.

Key Store

Keystore

Configures the TLS keystore.

Revocation Check

Standard Revocation Check
Custom OCSP Responder
CRL File

Configures a revocation checking mechanism.

Truststore

Configures the truststore for TLS.

Field	Type	Description
Path	String	The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.
Password	String	The password used to protect the trust store.
Type	String	The type of store used.
Algorithm	String	The algorithm used by the trust store.
Insecure	Boolean	If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Field

Type

Description

Default Value

Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field	Type	Description
Path	String	The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.
Type	String	The type of store used.
Alias	String	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	String	The password used to protect the private key.
Password	String	The password used to protect the key store.
Algorithm	String	The algorithm used by the key store.

Field

Type

Description

Default Value

Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

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

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field	Type	Description
Only End Entities	Boolean	Specifies whether to verify only the last element in the certificate chain.
Prefer Crls	Boolean	Specifies whether to check the Certification Revocation List (CRL) first for certificate validity.
No Fallback	Boolean	Specifies whether to avoid using the secondary method to check certificate validity.
Soft Fail	Boolean	Specifies whether to avoid verification failure when the revocation server cannot be reached.

Field

Type

Description

Default Value

Required

Only End Entities

Boolean

Specifies whether to verify only the last element in the certificate chain.

Prefer Crls

Boolean

Specifies whether to check the Certification Revocation List (CRL) first for certificate validity.

No Fallback

Boolean

Specifies whether to avoid using the secondary method to check certificate validity.

Soft Fail

Boolean

Specifies whether to avoid verification failure when the revocation server cannot be reached.

Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

Field	Type	Description	Default Value	Required
Url	String	The URL of the OCSP responder.
Cert Alias	String	Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

Field

Type

Description

Default Value

Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

CRL File

Specifies the location of the certification revocation list (CRL) file.

Field	Type	Description	Default Value	Required
Path	String	Path to the CRL file.

Field

Type

Description

Default Value

Required

Path

String

Path to the CRL file.

Reconnection

Configures a reconnection strategy for an operation.

Field	Type	Description	Default Value	Required
Fails Deployment	Boolean	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.
Reconnection Strategy	Reconnect Reconnect Forever	Reconnection strategy to use.

Field

Type

Description

Default Value

Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

Reconnect
Reconnect Forever

Reconnection strategy to use.

Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field	Type	Description
Frequency	Number	Specifies how often to attempt to reconnect, in milliseconds.
Blocking	Boolean	If false, the reconnection strategy will run in a separate, non-blocking thread.
Count	Number	Specifies how many reconnection attempts the Mule app can make.

Field

Type

Description

Default Value

Required

Frequency

Number

Specifies how often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

Count

Number

Specifies how many reconnection attempts the Mule app can make.

Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field	Type	Description	Default Value	Required
Frequency	Number	Specifies how often to attempt to reconnect, in milliseconds.
Blocking	Boolean	If false, the reconnection strategy will run in a separate, non-blocking thread.

Field

Type

Description

Default Value

Required

Frequency

Number

Specifies how often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

Expiration Policy

Configures an expiration policy strategy.

Field	Type	Description	Default Value	Required
Max Idle Time	Number	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 DAYS	Time unit for the Max Idle Time field.

Field

Type

Description

Default Value

Required

Max Idle Time

Number

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
DAYS

Time unit for the Max Idle Time field.

Error Mapping

Defines an error mapping entry.

Field	Type	Description	Default Value	Required
Source	Enumeration, one of: ANY REDELIVERY_EXHAUSTED TRANSFORMATION EXPRESSION SECURITY CLIENT_SECURITY SERVER_SECURITY ROUTING CONNECTIVITY RETRY_EXHAUSTED TIMEOUT	Source of the error.
Target	String	Target of the error.		x

Field

Type

Description

Default Value

Required

Source

Enumeration, one of:

ANY
REDELIVERY_EXHAUSTED
TRANSFORMATION
EXPRESSION
SECURITY
CLIENT_SECURITY
SERVER_SECURITY
ROUTING
CONNECTIVITY
RETRY_EXHAUSTED
TIMEOUT

Source of the error.

Target

String

Target of the error.

x