Slack

Discover more about the Slack connector and how to use it on the Digibee Integration Platform.

Slack sends messages to users or channels in Slack, a cloud-based communication and collaboration platform designed for teams.

Parameters

Take a look at the configuration parameters for the connector. Parameters supported by Double Braces expressions are marked with (DB).

General tab

ParameterDescriptionDefault valueData type

Dynamic Account

When active, the connector will use the account dynamically. Otherwise, it will use the account statically.

False

Boolean

Account Name (DB)

The name of the dynamic account used to connect to Slack. This account must have been previously configured in a Store Account connector in the pipeline for this process to take effect.

It is only available if the Dynamic Account parameter is active.

N/A

String

Account

The Slack account to be used by the connector. Supported type: OAuth Bearer.

It is only available if the Dynamic Account parameter is inactive.

N/A

String

Channel or User (DB)

To send the message, specify either the channel name with #channel-name or the Slack user with @member-id.

N/A

String

Message (DB)

The content of the message to be sent. Learn more about how to format the content of the message.

N/A

String

Fail On Error

If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the "success" property.

False

Boolean

Documentation tab

ParameterDescriptionDefault valueData type

Documentation

Section for documenting any necessary information about the connector configuration and business rules.

N/A

String

Slack in action

Sending a message to a Slack channel

When sending a message to a Slack channel, ensure you include the following details:

  • Channel or User: use #channel-name, such as #general-information.

  • Message: the content of the message.

If the operation is successful, you will receive the following output:

{
	"success": true
}

Sending a message to a Slack user

When sending a message to a Slack user, ensure you include the following details:

  • Channel or User: use @member-id, such as @U06E4PHBHKL. To find the member ID, expand the user's profile in Slack, click the three-dot icon, and select Copy member ID.

  • Message: the content of the message.

If the operation is successful, you will receive the following output:

{
	"success": true
}

Formatting the text of a message

To format the content of a message, use the Markdown structure specified in the Slack documentation. This allows you to apply formatting such as bold and italic, as well as mention channels, users, and groups.

For example, if you want your message to appear in Slack like this:

Good morning! The due date for joining the #general-information channel is today. @Anne, make sure you don’t miss the information there!

You should write it in the Message parameter like this:

_Good morning!_
The due date for joining the <#C08H6O68ACC> channel is *today*. <@U06E4PHBHKL>, make sure you don’t miss the information there!

Refer to Slack's Formatting text for app surfaces documentation to learn more about using various formatting options.

Last updated