Contact Us 1-800-596-4880
  1. Homepage
  2. Bird Connector (1.1)

  3. Bird Connector Reference

All Connectors

Bird Connector 1.1 Reference

Configurations

Config

Default configuration.

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

API Key

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 Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Connection Types

API Key
Parameters
Name Type Description Default Value Required

apiKey

String

API key used to authenticate requests to the Bird API.

x

baseUri

String

Base URI for the Bird API.

x

TLS Configuration

TLS

Configures TLS for the connection.

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.

Supported Operations

Operations

Create Contact

<bird:create-contact>

Creates a contact.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

body

Any

Request body for the operation.

#[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

Throws

  • BIRD:CLIENT_ERROR

  • BIRD:CONFLICT

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:NOT_FOUND

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

Create Conversation

<bird:create-conversation>

Creates a conversation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

body

Any

Request body for the operation.

#[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

Throws

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:NOT_FOUND

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

  • BIRD:UNPROCESSABLE_ENTITY

Create Conversation Message

<bird:create-conversation-message>

Creates a conversation message.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

conversationId

String

ID of the conversation.

x

body

Any

Request body for the operation.

#[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

Throws

  • BIRD:BAD_REQUEST

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:NOT_FOUND

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

Delete Contact

<bird:delete-contact>

Deletes a contact.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

contactId

String

ID of the contact.

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’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

Null

Attributes Type

Any

For Configurations

Throws

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:NOT_FOUND

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

Delete Conversation

<bird:delete-conversation>

Deletes a conversation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

conversationId

String

ID of the conversation.

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’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

Null

Attributes Type

Any

For Configurations

Throws

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:NOT_FOUND

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

Delete Conversation Message

<bird:delete-conversation-message>

Deletes a conversation message.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

conversationId

String

ID of the conversation.

x

messageId

String

ID of the message.

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’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

Null

Attributes Type

Any

For Configurations

Throws

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:NOT_FOUND

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

Get Channel

<bird:get-channel>

Gets a channel.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

channelId

String

ID of the channel.

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’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

Throws

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:NOT_FOUND

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

Get Channel Message Status

<bird:get-channel-message-status>

Gets the status of a channel message.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

channelId

String

ID of the channel.

x

messageId

String

ID of the message.

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’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

Throws

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:NOT_FOUND

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

  • BIRD:UNPROCESSABLE_ENTITY

Get Contact

<bird:get-contact>

Gets a contact.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

contactId

String

ID of the contact.

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’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

Throws

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:NOT_FOUND

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

Get Conversation

<bird:get-conversation>

Gets a conversation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

conversationId

String

ID of the conversation.

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’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

Throws

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:NOT_FOUND

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

Get Conversation Message

<bird:get-conversation-message>

Gets a conversation message.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

conversationId

String

ID of the conversation.

x

messageId

String

ID of the message.

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’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

Throws

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:NOT_FOUND

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

  • BIRD:UNPROCESSABLE_ENTITY

List Channel Messages

<bird:list-channel-messages>

Lists channel messages.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

channelId

String

ID of the channel.

x

limit

Number

Maximum number of results to return.

pageToken

String

Token for pagination to retrieve the next page of results.

status

Enumeration, one of:

  • accepted

  • rejected

  • processing

  • scheduled

  • sent

  • sending_failed

  • delivered

  • delivery_failed

  • deleted

  • skipped

Status used to filter channel messages.

emailSubject

String

Email subject used to filter channel messages.

startAt

DateTime

Start date and time used to filter channel messages.

endAt

DateTime

End date and time used to filter channel messages.

Config Ref

ConfigurationProvider

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

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

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

Array of Any

For Configurations

Throws

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:NOT_FOUND

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

  • BIRD:UNPROCESSABLE_ENTITY

List Channels

<bird:list-channels>

Lists channels.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

limit

Number

Maximum number of results to return.

pageToken

String

Token for pagination to retrieve the next page of results.

Config Ref

ConfigurationProvider

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

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

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

Array of Any

For Configurations

Throws

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

List Contact

<bird:list-contact>

Lists contacts.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

limit

Number

Maximum number of results to return.

pageToken

String

Token for pagination to retrieve the next page of results.

search

String

Search text used to filter contacts.

Config Ref

ConfigurationProvider

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

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

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

Array of Any

For Configurations

Throws

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

List Conversation Messages

<bird:list-conversation-messages>

Lists conversation messages.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

conversationId

String

ID of the conversation.

x

limit

Number

Maximum number of results to return.

pageToken

String

Token for pagination to retrieve the next page of results.

reverse

Boolean

Whether to return messages in reverse order.

false

Config Ref

ConfigurationProvider

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

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

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

Array of Any

For Configurations

Throws

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:NOT_FOUND

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

List Conversations

<bird:list-conversations>

Lists conversations.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

limit

Number

Maximum number of results to return.

pageToken

String

Token for pagination to retrieve the next page of results.

resource

String

Resource used to filter conversations.

Config Ref

ConfigurationProvider

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

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

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

Array of Any

For Configurations

Throws

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

List KYC Forms

<bird:list-kyc-forms>

Lists KYC forms.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

limit

Number

Maximum number of results to return.

pageToken

String

Token for pagination to retrieve the next page of results.

Config Ref

ConfigurationProvider

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

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

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

Array of Any

For Configurations

Throws

  • BIRD:BAD_REQUEST

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

Send Channel Message

<bird:send-channel-message>

Sends a channel message.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

channelId

String

ID of the channel.

x

body

Any

Request body for the operation.

#[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

Throws

  • BIRD:BAD_REQUEST

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

  • BIRD:UNPROCESSABLE_ENTITY

Send Verification

<bird:send-verification>

Sends a verification.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

body

Any

Request body for the operation.

#[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

Throws

  • BIRD:BAD_REQUEST

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

  • BIRD:UNPROCESSABLE_ENTITY

Update Contact

<bird:update-contact>

Updates a contact.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

contactId

String

ID of the contact.

x

body

Any

Request body for the operation.

#[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

Throws

  • BIRD:CLIENT_ERROR

  • BIRD:CONFLICT

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:NOT_FOUND

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

  • BIRD:UNPROCESSABLE_ENTITY

Update Conversation

<bird:update-conversation>

Updates a conversation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

conversationId

String

ID of the conversation.

x

body

Any

Request body for the operation.

#[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

Throws

  • BIRD:BAD_REQUEST

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:NOT_FOUND

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

Update Conversation Message

<bird:update-conversation-message>

Updates a conversation message.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

workspaceId

String

ID of the workspace.

x

conversationId

String

ID of the conversation.

x

messageId

String

ID of the message.

x

body

Any

Request body for the operation.

#[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

Throws

  • BIRD:BAD_REQUEST

  • BIRD:CLIENT_ERROR

  • BIRD:CONNECTIVITY

  • BIRD:FORBIDDEN

  • BIRD:NOT_FOUND

  • BIRD:SECURITY

  • BIRD:SERVER_ERROR

  • BIRD:TIMEOUT

  • BIRD:UNAUTHORIZED

Types

TLS

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

Trust Store

Configures the trust store for TLS certificate validation.

Key Store

Key Store

Configures the key store for client authentication.

Revocation Check

Configures certificate revocation checking.

Trust Store

Field Type Description Default Value Required

Path

String

The location, 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 are performed, which makes connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location, 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 to use. If not defined, the first key in the file is 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

Field Type Description Default Value Required

Only End Entities

Boolean

Verifies only the last element of the certificate chain.

Prefer Crls

Boolean

Tries CRL instead of OCSP first.

No Fallback

Boolean

Does not use the secondary checking method, which is the method not selected before.

Soft Fail

Boolean

Avoids verification failure when the revocation server cannot be reached or is busy.

Custom OCSP Responder

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, which must be in the trust store, if present.

CRL File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

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

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often, in milliseconds, to reconnect.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, nonblocking thread.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often, in milliseconds, to reconnect.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, nonblocking thread.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time that a dynamic configuration instance can remain idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute.

Error Mapping

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

Error type to map.

Target

String

Error type to which the source error is mapped.

x

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

The number of instances initially allowed in memory to consume the stream and provide random access to it. If the stream contains more data than fits in this buffer, the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxBufferSize. The default value is 100 instances.

Buffer Size Increment

Number

The amount by which the buffer size expands if it exceeds its initial size. A value of zero or less prevents the buffer from expanding, which raises a STREAM_MAXIMUM_SIZE_EXCEEDED error when the buffer is full. The default value is 100 instances.

Max Buffer Size

Number

The maximum amount of memory to use. If more memory is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value of zero or less means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

In Memory Objects

Number

The maximum number of instances to keep in memory. If more are required, the content is buffered on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which inMemoryObjects is expressed.
Back to top