Intercom Connector Module Connector Reference

Configurations

Config

Parameters

Name	Type	Description	Default Value	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.		x
Connection	Auth Connection Provider	The connection types to provide to this configuration.		x
Response Timeout	Number	The timeout for request to the remote service.	1
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout}	MINUTES
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.	AUTO
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 expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when it sees fit.

Name

Type

Description

Default Value

Required

Name

String

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

x

Connection

Auth Connection Provider

The connection types to provide to this configuration.

x

Response Timeout

Number

The timeout for request to the remote service.

1

Response Timeout Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the Response Timeout}

MINUTES

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

AUTO

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 expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when it sees fit.

Connection Types

Auth Connection Provider

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.

Parameters

Name	Type	Description	Default Value	Required
Default Headers	Array of Default Header
Query Parameters	Array of Default Query Param
Connection Timeout	Number	The timeout for establishing connections to the remote service	30
Connection Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Connection Timeout	SECONDS
Use Persistent Connections	Boolean	If false, each connection is closed after the first request is completed.	true
Max Connections	Number	The maximum number of outbound connections that are kept open at the same time	-1
Connection Idle Timeout	Number	A timeout for how long a connection can remain idle before it is closed	30
Connection Idle Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the connection Idle Timeout	SECONDS
Proxy Config	Proxy	Reusable configuration element for outbound connections through a proxy
Stream Response	Boolean	Whether or not received responses should be streamed	false
Response Buffer Size	Number	The space in bytes for the buffer where the HTTP response will be stored.	-1
Base Uri	String	Parameter base URI, each instance/tenant gets its own	https://api.intercom.io
TLS Configuration	Tls
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.
Consumer Key	String	The OAuth consumerKey as registered with the service provider		x
Consumer Secret	String	The OAuth consumerSecret as registered with the service provider		x
Authorization Url	String	The service provider’s authorization endpoint URL	https://app.intercom.com/oauth
Access Token Url	String	The service provider’s accessToken endpoint URL	https://api.intercom.io/auth/eagle/token
Scopes	String	The OAuth scopes to be requested during the dance. If not provided, it defaults to those in the annotation
Resource Owner Id	String	The resourceOwnerId which each component should use if it doesn’t reference otherwise.
Before	String	The name of a flow to execute right before starting the OAuth dance
After	String	The name of a flow to execute right after an accessToken has been received
Listener Config	String	A reference to a <http:listener-config /> to use to create the listener that catches the access token callback endpoint.		x
Callback Path	String	The path of the access token callback endpoint		x
Authorize Path	String	The path of the local http endpoint which triggers the OAuth dance		x
External Callback Url	String	If the callback endpoint is behind a proxy or should be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL it should use to access the callback
Object Store	String	A reference to the object store that should be used to store each resource owner id’s data. If not specified, runtime will automatically provision the default one.

Name

Type

Description

Default Value

Required

Default Headers

Array of Default Header

Query Parameters

Array of Default Query Param

Connection Timeout

Number

The timeout for establishing connections to the remote service

30

Connection Timeout Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the Connection Timeout

SECONDS

Use Persistent Connections

Boolean

If false, each connection is closed after the first request is completed.

true

Max Connections

Number

The maximum number of outbound connections that are kept open at the same time

-1

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed

30

Connection Idle Timeout Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the connection Idle Timeout

SECONDS

Proxy Config

Proxy

Reusable configuration element for outbound connections through a proxy

Stream Response

Boolean

Whether or not received responses should be streamed

false

Response Buffer Size

Number

The space in bytes for the buffer where the HTTP response will be stored.

-1

Base Uri

String

Parameter base URI, each instance/tenant gets its own

https://api.intercom.io

TLS Configuration

Tls

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.

Consumer Key

String

The OAuth consumerKey as registered with the service provider

x

Consumer Secret

String

The OAuth consumerSecret as registered with the service provider

x

Authorization Url

String

The service provider’s authorization endpoint URL

https://app.intercom.com/oauth

Access Token Url

String

The service provider’s accessToken endpoint URL

https://api.intercom.io/auth/eagle/token

Scopes

String

The OAuth scopes to be requested during the dance. If not provided, it defaults to those in the annotation

Resource Owner Id

String

The resourceOwnerId which each component should use if it doesn’t reference otherwise.

Before

String

The name of a flow to execute right before starting the OAuth dance

After

String

The name of a flow to execute right after an accessToken has been received

Listener Config

String

A reference to a <http:listener-config /> to use to create the listener that catches the access token callback endpoint.

x

Callback Path

String

The path of the access token callback endpoint

x

Authorize Path

String

The path of the local http endpoint which triggers the OAuth dance

x

External Callback Url

String

If the callback endpoint is behind a proxy or should be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL it should use to access the callback

Object Store

String

A reference to the object store that should be used to store each resource owner id’s data. If not specified, runtime will automatically provision the default one.

Associated Sources

On New Contact Trigger
On New Conversation Trigger

Operations

Create Contact

<mule-intercom-connector:create-contacts>

Creates a new contact using the Intercom API’s create contact request This operation makes an HTTP POST request to the /contacts endpoint

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration used		x
Create-Contact-Request	Any	The content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Custom Query Parameters	Object
Custom Headers	Object
Response Timeout	Number	The timeout for request to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.
Target Variable	String	The name of a variable to store 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]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration used

x

Create-Contact-Request

Any

The content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

The name of a variable to store 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]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

MULE-INTERCOM-CONNECTOR:BAD_REQUEST
MULE-INTERCOM-CONNECTOR:CLIENT_ERROR
MULE-INTERCOM-CONNECTOR:CONNECTIVITY
MULE-INTERCOM-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-INTERCOM-CONNECTOR:NOT_ACCEPTABLE
MULE-INTERCOM-CONNECTOR:NOT_FOUND
MULE-INTERCOM-CONNECTOR:RETRY_EXHAUSTED
MULE-INTERCOM-CONNECTOR:SERVER_ERROR
MULE-INTERCOM-CONNECTOR:SERVICE_UNAVAILABLE
MULE-INTERCOM-CONNECTOR:TIMEOUT
MULE-INTERCOM-CONNECTOR:TOO_MANY_REQUESTS
MULE-INTERCOM-CONNECTOR:UNAUTHORIZED
MULE-INTERCOM-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Archive Contact

<mule-intercom-connector:create-contacts-archive-by-id>

Archives a single contact using the Intercom API’s archive contact request This operation makes an HTTP POST request to the /contacts/{id}/archive endpoint

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration used		x
id	String	id		x
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Custom Query Parameters	Object		#[null]
Custom Headers	Object
Response Timeout	Number	The timeout for request to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.
Target Variable	String	The name of a variable to store 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]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration used

x

id

String

id

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configure to use repeatable streams.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

The name of a variable to store 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]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

MULE-INTERCOM-CONNECTOR:BAD_REQUEST
MULE-INTERCOM-CONNECTOR:CLIENT_ERROR
MULE-INTERCOM-CONNECTOR:CONNECTIVITY
MULE-INTERCOM-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-INTERCOM-CONNECTOR:NOT_ACCEPTABLE
MULE-INTERCOM-CONNECTOR:NOT_FOUND
MULE-INTERCOM-CONNECTOR:RETRY_EXHAUSTED
MULE-INTERCOM-CONNECTOR:SERVER_ERROR
MULE-INTERCOM-CONNECTOR:SERVICE_UNAVAILABLE
MULE-INTERCOM-CONNECTOR:TIMEOUT
MULE-INTERCOM-CONNECTOR:TOO_MANY_REQUESTS
MULE-INTERCOM-CONNECTOR:UNAUTHORIZED
MULE-INTERCOM-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Search Contact

<mule-intercom-connector:create-contacts-search>

Searches for a contact using the Intercom API’s search for contacts request This operation makes an HTTP POST request to the /contacts/search endpoint

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration used		x
Search-Contact-Request	Any	The content to use	#[payload]
Output Mime Type	String	The mime type of the payload that this operation outputs.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Iterable Repeatable File Store Iterable non-repeatable-iterable	Configure to use repeatable streams.
Custom Query Parameters	Object
Custom Headers	Object
Response Timeout	Number	The timeout for request to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	String	The name of a variable to store 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]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration used

x

Search-Contact-Request

Any

The content to use

#[payload]

Output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

The name of a variable to store 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]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type	Array of Any

For Configurations

Config

Throws

MULE-INTERCOM-CONNECTOR:BAD_REQUEST
MULE-INTERCOM-CONNECTOR:CLIENT_ERROR
MULE-INTERCOM-CONNECTOR:CONNECTIVITY
MULE-INTERCOM-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-INTERCOM-CONNECTOR:NOT_ACCEPTABLE
MULE-INTERCOM-CONNECTOR:NOT_FOUND
MULE-INTERCOM-CONNECTOR:SERVER_ERROR
MULE-INTERCOM-CONNECTOR:SERVICE_UNAVAILABLE
MULE-INTERCOM-CONNECTOR:TIMEOUT
MULE-INTERCOM-CONNECTOR:TOO_MANY_REQUESTS
MULE-INTERCOM-CONNECTOR:UNAUTHORIZED
MULE-INTERCOM-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Open Conversation

<mule-intercom-connector:create-conversations-parts-by-id>

Opens a conversation that is snoozed or closed using the Intercom API’s open conversation request. This operation makes an HTTP POST request to the /conversations/{id}/parts endpoint

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration used		x
id	String	id		x
Open-Conversation-Request	Any	The content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Custom Query Parameters	Object
Custom Headers	Object
Response Timeout	Number	The timeout for request to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	String	The name of a variable to store 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]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration used

x

id

String

id

x

Open-Conversation-Request

Any

The content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

The name of a variable to store 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]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

MULE-INTERCOM-CONNECTOR:BAD_REQUEST
MULE-INTERCOM-CONNECTOR:CLIENT_ERROR
MULE-INTERCOM-CONNECTOR:CONNECTIVITY
MULE-INTERCOM-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-INTERCOM-CONNECTOR:NOT_ACCEPTABLE
MULE-INTERCOM-CONNECTOR:NOT_FOUND
MULE-INTERCOM-CONNECTOR:RETRY_EXHAUSTED
MULE-INTERCOM-CONNECTOR:SERVER_ERROR
MULE-INTERCOM-CONNECTOR:SERVICE_UNAVAILABLE
MULE-INTERCOM-CONNECTOR:TIMEOUT
MULE-INTERCOM-CONNECTOR:TOO_MANY_REQUESTS
MULE-INTERCOM-CONNECTOR:UNAUTHORIZED
MULE-INTERCOM-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Reply To Conversation

<mule-intercom-connector:create-conversations-reply-by-last>

Replies to a conversation with a message from an admin or on behalf of a contact, or with a note for admins. Using Intercom Api’s reply to a conversation request This operation makes an HTTP POST request to the /conversations/{last}/reply endpoint

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration used		x
last	String	last		x
Reply-Conversation-Request	Any	The content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Custom Query Parameters	Object
Custom Headers	Object
Response Timeout	Number	The timeout for request to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.
Target Variable	String	The name of a variable to store 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]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration used

x

last

String

last

x

Reply-Conversation-Request

Any

The content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

The name of a variable to store 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]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

MULE-INTERCOM-CONNECTOR:BAD_REQUEST
MULE-INTERCOM-CONNECTOR:CLIENT_ERROR
MULE-INTERCOM-CONNECTOR:CONNECTIVITY
MULE-INTERCOM-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-INTERCOM-CONNECTOR:NOT_ACCEPTABLE
MULE-INTERCOM-CONNECTOR:NOT_FOUND
MULE-INTERCOM-CONNECTOR:RETRY_EXHAUSTED
MULE-INTERCOM-CONNECTOR:SERVER_ERROR
MULE-INTERCOM-CONNECTOR:SERVICE_UNAVAILABLE
MULE-INTERCOM-CONNECTOR:TIMEOUT
MULE-INTERCOM-CONNECTOR:TOO_MANY_REQUESTS
MULE-INTERCOM-CONNECTOR:UNAUTHORIZED
MULE-INTERCOM-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Search for Conversations

<mule-intercom-connector:create-conversations-search>

Searches for an operation Using Intercom Api’s search for a conversation request This operation makes an HTTP POST request to the /conversations/search endpoint

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration used		x
Search-Conversations-Request	Any	The content to use	#[payload]
Output Mime Type	String	The mime type of the payload that this operation outputs.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Iterable Repeatable File Store Iterable non-repeatable-iterable	Configure to use repeatable streams.
Custom Query Parameters	Object
Custom Headers	Object
Response Timeout	Number	The timeout for request to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	String	The name of a variable to store 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]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration used

x

Search-Conversations-Request

Any

The content to use

#[payload]

Output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

The name of a variable to store 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]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type	Array of Any

For Configurations

Config

Throws

MULE-INTERCOM-CONNECTOR:BAD_REQUEST
MULE-INTERCOM-CONNECTOR:CLIENT_ERROR
MULE-INTERCOM-CONNECTOR:CONNECTIVITY
MULE-INTERCOM-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-INTERCOM-CONNECTOR:NOT_ACCEPTABLE
MULE-INTERCOM-CONNECTOR:NOT_FOUND
MULE-INTERCOM-CONNECTOR:SERVER_ERROR
MULE-INTERCOM-CONNECTOR:SERVICE_UNAVAILABLE
MULE-INTERCOM-CONNECTOR:TIMEOUT
MULE-INTERCOM-CONNECTOR:TOO_MANY_REQUESTS
MULE-INTERCOM-CONNECTOR:UNAUTHORIZED
MULE-INTERCOM-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get Contact

<mule-intercom-connector:get-contacts-by-id>

Retrieves contact by id using the Intercom API’s retrieve contact request This operation makes an HTTP GET request to the /contacts/{id} endpoint

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration used		x
id	String	id		x
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Custom Query Parameters	Object		#[null]
Custom Headers	Object
Response Timeout	Number	The timeout for request to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.
Target Variable	String	The name of a variable to store 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]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration used

x

id

String

id

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configure to use repeatable streams.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

The name of a variable to store 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]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

MULE-INTERCOM-CONNECTOR:BAD_REQUEST
MULE-INTERCOM-CONNECTOR:CLIENT_ERROR
MULE-INTERCOM-CONNECTOR:CONNECTIVITY
MULE-INTERCOM-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-INTERCOM-CONNECTOR:NOT_ACCEPTABLE
MULE-INTERCOM-CONNECTOR:NOT_FOUND
MULE-INTERCOM-CONNECTOR:RETRY_EXHAUSTED
MULE-INTERCOM-CONNECTOR:SERVER_ERROR
MULE-INTERCOM-CONNECTOR:SERVICE_UNAVAILABLE
MULE-INTERCOM-CONNECTOR:TIMEOUT
MULE-INTERCOM-CONNECTOR:TOO_MANY_REQUESTS
MULE-INTERCOM-CONNECTOR:UNAUTHORIZED
MULE-INTERCOM-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Unauthorize

<mule-intercom-connector:unauthorize>

Deletes all the access token information of a given resource owner id so that it’s impossible to execute any operation for that user without doing the authorization dance again

Parameters

Name	Type	Description	Required
Configuration	String	The name of the configuration used	x
Resource Owner Id	String	The id of the resource owner which access should be invalidated
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component	x

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration used

x

Resource Owner Id

String

The id of the resource owner which access should be invalidated

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

For Configurations

Config

Update Contact

<mule-intercom-connector:update-contacts-by-id>

Updates a contact using the Intercom API’s update a contact request This operation makes an HTTP PUT request to the /contacts/{id} endpoint

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration used		x
id	String	id		x
Update-Contact-Request	Any	The content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Custom Query Parameters	Object
Custom Headers	Object
Response Timeout	Number	The timeout for request to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	String	The name of a variable to store 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]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration used

x

id

String

id

x

Update-Contact-Request

Any

The content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

The name of a variable to store 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]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

MULE-INTERCOM-CONNECTOR:BAD_REQUEST
MULE-INTERCOM-CONNECTOR:CLIENT_ERROR
MULE-INTERCOM-CONNECTOR:CONNECTIVITY
MULE-INTERCOM-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-INTERCOM-CONNECTOR:NOT_ACCEPTABLE
MULE-INTERCOM-CONNECTOR:NOT_FOUND
MULE-INTERCOM-CONNECTOR:RETRY_EXHAUSTED
MULE-INTERCOM-CONNECTOR:SERVER_ERROR
MULE-INTERCOM-CONNECTOR:SERVICE_UNAVAILABLE
MULE-INTERCOM-CONNECTOR:TIMEOUT
MULE-INTERCOM-CONNECTOR:TOO_MANY_REQUESTS
MULE-INTERCOM-CONNECTOR:UNAUTHORIZED
MULE-INTERCOM-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Sources

On New Contact Trigger

<mule-intercom-connector:on-new-contact-trigger>

Parameters

Name	Type	Description	Required
Configuration	String	The name of the configuration used	x
Created at	Number	Timestamp value as lower bound for new contacts
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component	x
Primary Node Only	Boolean	Whether this source should only be executed on the primary node when running in Cluster
Scheduling Strategy	scheduling-strategy	Configures the scheduler that triggers the polling	x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Redelivery Policy	Redelivery Policy	Defines a policy for processing the redelivery of the same message
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration used

x

Created at

Number

Timestamp value as lower bound for new contacts

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in Cluster

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configure to use repeatable streams.

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

On New Conversation Trigger

<mule-intercom-connector:on-new-conversation-trigger>

Parameters

Name	Type	Description	Required
Configuration	String	The name of the configuration used	x
Created at	Number	Timestamp value as lower bound for new conversations
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component	x
Primary Node Only	Boolean	Whether this source should only be executed on the primary node when running in Cluster
Scheduling Strategy	scheduling-strategy	Configures the scheduler that triggers the polling	x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Redelivery Policy	Redelivery Policy	Defines a policy for processing the redelivery of the same message
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration used

x

Created at

Number

Timestamp value as lower bound for new conversations

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in Cluster

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configure to use repeatable streams.

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Types

Default Header

Field	Type	Description	Default Value	Required
Key	String			x
Value	String			x

Field

Type

Description

Default Value

Required

Key

String

x

Value

String

x

Default Query Param

Field	Type	Description	Default Value	Required
Key	String			x
Value	String			x

Field

Type

Description

Default Value

Required

Key

String

x

Value

String

x

Proxy

Field

Type

Description

Default Value

Required

Host

String

x

Port

Number

x

Username

String

Password

String

Non Proxy Hosts

String

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

Key Store

Revocation Check

Standard Revocation Check
Custom Ocsp Responder
Crl File

Trust Store

Field	Type	Description
Path	String	The location (that is 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 (that is 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.

Key Store

Field	Type	Description
Path	String	The location (that is 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 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.

Field

Type

Description

Default Value

Required

Path

String

The location (that is 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 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
Only End Entities	Boolean	Only verify the last element of the certificate chain.
Prefer Crls	Boolean	Try CRL instead of OCSP first.
No Fallback	Boolean	Do not use the secondary checking method (the one not selected before).
Soft Fail	Boolean	Avoid verification failure when the revocation server can not be reached or is busy.

Field

Type

Description

Default Value

Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not 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 (must be in the trust store), if present.

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

Crl File

Field	Type	Description	Default Value	Required
Path	String	The path to the 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	Reconnect Reconnect Forever	The 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

The reconnection strategy to use.

Reconnect

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

Field

Type

Description

Default Value

Required

Frequency

Number

How often in milliseconds to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking 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 will run in a separate, non-blocking thread

Field

Type

Description

Default Value

Required

Frequency

Number

How often in milliseconds to reconnect

Blocking

Boolean

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

Expiration Policy

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	A time unit that qualifies the maxIdleTime attribute

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

A time unit that qualifies the maxIdleTime attribute

Http Response Attributes

Field	Type	Required
Status Code	Number	x
Headers	Object	x
Reason Phrase	String	x

Field

Type

Description

Default Value

Required

Status Code

Number

x

Headers

Object

x

Reason Phrase

String

x

Repeatable In Memory Stream

Field	Type	Description
Initial Buffer Size	Number	The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.
Buffer Size Increment	Number	This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.
Max Buffer Size	Number	The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.
Buffer Unit	Enumeration, one of: BYTE KB MB GB	The unit in which all these attributes are expressed

Field

Type

Description

Default Value

Required

Initial Buffer Size

Number

The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

BYTE
KB
MB
GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field	Type	Description	Default Value	Required
In Memory Size	Number	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: BYTE KB MB GB	The unit in which maxInMemorySize is expressed

Field

Type

Description

Default Value

Required

In Memory Size

Number

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:

BYTE
KB
MB
GB

The unit in which maxInMemorySize is expressed

Redelivery Policy

Field	Type	Description
Max Redelivery Count	Number	The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message
Message Digest Algorithm	String	The secure hashing algorithm to use. If not set, the default is SHA-256.
Message Identifier	Redelivery Policy Message Identifier	Defines which strategy is used to identify the messages.
Object Store	ObjectStore	The object store where the redelivery counter for each message is going to be stored.

Field

Type

Description

Default Value

Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Message Identifier

Redelivery Policy Message Identifier

Defines which strategy is used to identify the messages.

Object Store

ObjectStore

The object store where the redelivery counter for each message is going to be stored.

Redelivery Policy Message Identifier

Field	Type	Description	Default Value	Required
Use Secure Hash	Boolean	Whether to use a secure hash algorithm to identify a redelivered message.
Id Expression	String	Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Field

Type

Description

Default Value

Required

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Repeatable In Memory Iterable

Field	Type	Description
Initial Buffer Size	Number	The amount of instances that is initially be allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.
Buffer Size Increment	Number	This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.
Max Buffer Size	Number	The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Field

Type

Description

Default Value

Required

Initial Buffer Size

Number

The amount of instances that is initially be allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Repeatable File Store Iterable

Field	Type	Description	Default Value	Required
In Memory Objects	Number	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: BYTE KB MB GB	The unit in which maxInMemorySize is expressed

Field

Type

Description

Default Value

Required

In Memory Objects

Number

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:

BYTE
KB
MB
GB

The unit in which maxInMemorySize is expressed