Slack Connector Documentation 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	Oauth Connection Token Connection	The connection types that can be provided to this configuration.		x

Name

Type

Description

Default Value

Required

Name

String

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

Connection

Oauth Connection
Token Connection

The connection types that can be provided to this configuration.

Connection Types

Oauth Connection

Parameters

Name	Type	Description	Default Value	Required
Connection Timeout	Number		5000
Host	String
Port	Number
Username	String
Password	String
NTLM Domain	String
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy
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://slack.com/oauth/authorize
Access Token Url	String	The service provider's accessToken endpoint URL	https://slack.com/api/oauth.access
Scopes	String	The OAuth scopes to be requested during the dance. If not provided, it will default to those in the annotation	chat:write:user
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 be executed right before starting the OAuth dance
After	String	The name of a flow to be executed right after an accessToken has been received
Listener Config	String	A reference to a to be used in order to create the listener that will catch 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

Connection Timeout

Number

5000

Host

String

Port

Number

Username

String

Password

String

NTLM Domain

String

Reconnection

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

Consumer Key

String

The OAuth consumerKey as registered with the service provider

Consumer Secret

String

The OAuth consumerSecret as registered with the service provider

Authorization Url

String

The service provider's authorization endpoint URL

https://slack.com/oauth/authorize

Access Token Url

String

The service provider's accessToken endpoint URL

https://slack.com/api/oauth.access

Scopes

String

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

chat:write:user

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 be executed right before starting the OAuth dance

After

String

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

Listener Config

String

A reference to a to be used in order to create the listener that will catch the access token callback endpoint.

Callback Path

String

The path of the access token callback endpoint

Authorize Path

String

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

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.

Token Connection

Parameters

Name

Type

Description

Default Value

Required

Connection Timeout

Number

5000

Token

String

Host

String

Port

Number

Username

String

Password

String

NTLM Domain

String

Reconnection

Associated Sources

Listener

Operations

List Channels

http://www.mulesoft.org/schema/mule/slack:list-channels

This method returns a list of all channels in the team. This includes channels the caller is in, channels theyare not currently in, and archived channels but does not include private channels. The number of(non-deactivated) members in each channel is also returned.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Cursor	String	Paginate through collections of data by setting the cursor parameter to a next_cursor attributereturned by a previous request's response_metadata. Default value fetches the first "page" of thecollection. See pagination for more detail.
Exclude Archived	Boolean	Exclude archived channels from the list	false
Exclude Members	Boolean	Exclude the members collection from each channel	false
Limit	Number	The maximum number of items to return. Fewer than the requested number of items may be returned,even if the end of the users list hasn't been reached.	0
Output Mime Type	String	The mime type of the payload that this operation outputs.
Output Encoding	String	The encoding of the payload that this operation outputs.
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream [non-repeatable-stream]	Configure if repeatable streams should be used and their behaviour
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored 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 to use.

Cursor

String

Paginate through collections of data by setting the cursor parameter to a next_cursor attributereturned by a previous request's response_metadata. Default value fetches the first "page" of thecollection. See pagination for more detail.

Exclude Archived

Boolean

Exclude archived channels from the list

false

Exclude Members

Boolean

Exclude the members collection from each channel

false

Limit

Number

The maximum number of items to return. Fewer than the requested number of items may be returned,even if the end of the users list hasn't been reached.

Output Mime Type

String

The mime type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Streaming Strategy

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

Configure if repeatable streams should be used and their behaviour

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Binary

For Configurations.

Config

Throws

SLACK:RETRY_EXHAUSTED
SLACK:CONNECTIVITY
SLACK:ACCOUNT_INACTIVE
SLACK:NOT_AUTHED
SLACK:CHANNEL_LISTING
SLACK:INVALID_AUTH

List Groups

http://www.mulesoft.org/schema/mule/slack:list-groups

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Exclude Archived	Boolean		false
Exclude Members	Boolean		false
Output Mime Type	String	The mime type of the payload that this operation outputs.
Output Encoding	String	The encoding of the payload that this operation outputs.
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream [non-repeatable-stream]	Configure if repeatable streams should be used and their behaviour
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored 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 to use.

Exclude Archived

Boolean

false

Exclude Members

Boolean

false

Output Mime Type

String

The mime type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Streaming Strategy

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

Configure if repeatable streams should be used and their behaviour

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Binary

For Configurations.

Config

Throws

SLACK:RETRY_EXHAUSTED
SLACK:CONNECTIVITY
SLACK:ACCOUNT_INACTIVE
SLACK:NOT_AUTHED
SLACK:CHANNEL_LISTING
SLACK:INVALID_AUTH

List Ims

http://www.mulesoft.org/schema/mule/slack:list-ims

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Exclude Archived	Boolean		false
Exclude Members	Boolean		false
Output Mime Type	String	The mime type of the payload that this operation outputs.
Output Encoding	String	The encoding of the payload that this operation outputs.
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream [non-repeatable-stream]	Configure if repeatable streams should be used and their behaviour
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored 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 to use.

Exclude Archived

Boolean

false

Exclude Members

Boolean

false

Output Mime Type

String

The mime type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Streaming Strategy

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

Configure if repeatable streams should be used and their behaviour

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Binary

For Configurations.

Config

Throws

SLACK:RETRY_EXHAUSTED
SLACK:CONNECTIVITY
SLACK:ACCOUNT_INACTIVE
SLACK:NOT_AUTHED
SLACK:CHANNEL_LISTING
SLACK:INVALID_AUTH

Post Message

http://www.mulesoft.org/schema/mule/slack:post-message

This operation lets you post a message to a public channel, private channel, or direct message/IM channel.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Channel	String	Channel, private group, or IM channel to send message to. Can be an encoded ID, ora name.		x
Message	String	Text of the message to send. This field is usually required, unless you're providingonly attachments instead.
Attachments	Binary	A JSON-based array of structured attachments, presented as a URL-encoded string.
Output Mime Type	String	The mime type of the payload that this operation outputs.
Output Encoding	String	The encoding of the payload that this operation outputs.
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream [non-repeatable-stream]	Configure if repeatable streams should be used and their behaviour
As User	Boolean	Pass true to post the message as the authed user, instead of as a bot. Defaults to false.	false
Send As	String
Icon Url	String
Icon Emoji	String
Link Names	Boolean		false
Parse	Boolean		false
Reply Broadcast	Boolean		false
Thread Time Stamp	String
Unfurl Links	Boolean		false
Unfurl Media	Boolean		false
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored 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 to use.

Channel

String

Channel, private group, or IM channel to send message to. Can be an encoded ID, ora name.

Message

String

Text of the message to send. This field is usually required, unless you're providingonly attachments instead.

Attachments

Binary

A JSON-based array of structured attachments, presented as a URL-encoded string.

Output Mime Type

String

The mime type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Streaming Strategy

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

Configure if repeatable streams should be used and their behaviour

As User

Boolean

Pass true to post the message as the authed user, instead of as a bot. Defaults to false.

false

Send As

String

Icon Url

String

Icon Emoji

String

Link Names

Boolean

false

Parse

Boolean

false

Reply Broadcast

Boolean

false

Thread Time Stamp

String

Unfurl Links

Boolean

false

Unfurl Media

Boolean

false

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Binary

Attributes Type

Binary

For Configurations.

Config

Throws

SLACK:RETRY_EXHAUSTED
SLACK:CONNECTIVITY
SLACK:ACCOUNT_INACTIVE
SLACK:NOT_AUTHED
SLACK:PUBLISHING
SLACK:INVALID_AUTH

Unauthorize

http://www.mulesoft.org/schema/mule/slack: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	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Resource Owner Id	String	The id of the resource owner which access should be invalidated

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Resource Owner Id

String

The id of the resource owner which access should be invalidated

For Configurations.

Config

Sources

Listener

http://www.mulesoft.org/schema/mule/slack:listener

Parameters

Name	Type	Description	Required
Configuration	String	The name of the configuration to use.	x
Output Mime Type	String	The mime type of the payload that this operation outputs.
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 to use.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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

String

For Configurations.

Config

Types

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 will fail 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 will fail 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	Default Value	Required
Frequency	Number	How often (in ms) to reconnect
Count	Number	How many reconnection attempts to make

Field

Type

Description

Default Value

Required

Frequency

Number

How often (in ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field	Type	Description	Default Value	Required
Frequency	Number	How often (in ms) to reconnect

Field

Type

Description

Default Value

Required

Frequency

Number

How often (in ms) to reconnect

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
Use Secure Hash	Boolean	Whether to use a secure hash algorithm to identify a redelivered message
Message Digest Algorithm	String	The secure hashing algorithm to use. If not set, the default is SHA-256.
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.
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

Use Secure Hash

Boolean

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

Message Digest Algorithm

String

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

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.

Object Store

[ObjectStore]

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

Repeatable In Memory Stream

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

Field

Type

Description

Default Value

Required

Initial Buffer Size

Number

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

Buffer Size Increment

Number

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

Max Buffer Size

Number

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

Buffer Unit

Enumeration, one of:

BYTE
KB
MB
GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field	Type	Description	Default Value	Required
Max 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

Max 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