Actions Developer Guide

Introducing Actions
Action Objects
Apex Actions
Apply Case Classification Recommendations
B2B Commerce Checkout Flow Actions
Commerce Checkout Flow Actions
Create Service Report Actions
Custom Notification Actions
Email Alert Actions
Flow Actions
Generate Work Orders Actions
Get Assessment Response Summary
Knowledge Actions
Lead Action
Live Message Notification Actions
Omni-Channel Action
Apply Payment Action
Payment Sale Action
PlatformAction
Post to Chatter Actions
Perform Survey Sentiment Analysis
Quick Actions
Refresh Metric Actions
Sales Engagement Actions
Salesforce Omnichannel Inventory Actions
Salesforce Order Management Actions
Send Notification Actions
Session-Based Permission Set Actions
Simple Email Actions
Slack Actions
Submit for Approval Actions
Survey Invitation Actions
Work Plan and Work Step Actions
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Slack Actions

Manage Slack channels, channel members, and messages.

Supported REST HTTP Methods

REST methods aren’t currently supported for Slack actions.

URI
Get a list of available Slack actions:
/services/data/vXX.X/actions/standard/slack_action_name
Formats
JSON, XML
HTTP Methods
GET, HEAD, POST
Authentication
Authorization: Bearer token

Archive Slack Channel

Archive a Slack channel. Available in API version 54.0.

This action is available only if you enable the connection to Slack in Setup and the user who runs the flow is connected to Slack. Otherwise, the action fails.

URI: /services/data/vXX.X/actions/standard/slackArchiveChannel

Table 1. Inputs
Input Details
slackAppIdForToken
Type
string
Description

Required. Specifies the ID of the Slack app that executes the action.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

slackWorkspaceIdForToken
Type
string
Description

Required. Specifies the ID of the Slack workspace where the Slack app is installed.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

You can obtain the Slack workspace ID by logging in to Slack.com and launching Slack in your browser. The workspace ID is the penultimate parameter in the URL. For example, in this URL, the workspace ID is T01234ABCDE:

https://app.slack.com/client/T01234ABCDE/C56789FGHIJ
userIdForToken
Type
string
Description

Specifies the Salesforce user ID of the user that the flow uses to connect to Slack. If you don’t specify a user ID, the Slack app executes the action.

The user or Slack app that executes the action must be a member of the channel.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

slackChannelId
Type
string
Description

Required. Specifies the ID of the Slack channel to execute the action on. This is also known as the Slack conversation ID.

You can obtain the Slack conversation ID by logging in to Slack.com and launching Slack in your browser. The conversation ID is the last parameter in the URL. For example, in this URL, the conversation ID is C56789FGHIJ:

https://app.slack.com/client/T01234ABCDE/C56789FGHIJ

Check Users Are Connected to Slack

Determine whether a collection of Salesforce users is connected to a given Slack app. Available in API version 54.0.

This action is available only if you enable the connection to Slack in Setup. Otherwise, the action fails. Additionally, the user that initiates the flow and any users impacted by the action must have logged in to a Salesforce Slack app at least once.

URI: /services/data/vXX.X/actions/standard/slackCheckUsersAreConnectedToSlack

Table 2. Inputs
Input Details
slackAppIdForToken
Type
string
Description

Required. Specifies the ID of the Slack app that executes the action.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

slackWorkspaceIdForToken
Type
string
Description

Required. Specifies the ID of the Slack workspace where the Slack app is installed.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

You can obtain the Slack workspace ID by logging in to Slack.com and launching Slack in your browser. The workspace ID is the penultimate parameter in the URL. For example, in this URL, the workspace ID is T01234ABCDE:

https://app.slack.com/client/T01234ABCDE/C56789FGHIJ
userIdsToCheck
Type
string
Description
Required. Specifies the collection resource that contains the Salesforce user IDs to check. The maximum number of user IDs is 1,000.
Table 3. Outputs
Output Details
userIdsConnectedTo Slack
Type
string
Description
The Salesforce user IDs connected to Slack.
userIdsNotConnectedTo Slack
Type
string
Description
The Salesforce user IDs that are not connected to Slack.

Create Slack Channel

Create a Slack channel. Available in API version 54.0.

This action is available only if you enable the connection to Slack in Setup and the user who runs the flow is connected to Slack. Otherwise, the action fails.

URI: /services/data/vXX.X/actions/standard/slackCreateChannel

Table 4. Inputs
Input Details
slackAppIdForToken
Type
string
Description

Required. Specifies the ID of the Slack app that executes the action.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

slackWorkspaceIdForToken
Type
string
Description

Required. Specifies the ID of the Slack workspace where the Slack app is installed.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

You can obtain the Slack workspace ID by logging in to Slack.com and launching Slack in your browser. The workspace ID is the penultimate parameter in the URL. For example, in this URL, the workspace ID is T01234ABCDE:

https://app.slack.com/client/T01234ABCDE/C56789FGHIJ
userIdForToken
Type
string
Description

Specifies the Salesforce user ID of the user that the flow uses to connect to Slack. If you don’t specify a user ID, the Slack app executes the action.

The user or Slack app that executes the action must be a member of the channel.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

slackChannelName
Type
string
Description
Required. Specifies the name of the new Slack channel.
isChannelPrivate
Type
boolean
Description
Indicates whether the new channel is private. For more information about channel types, see https://slack.com/help/articles/360017938993-What-is-a-channel.

The default value is false.
slackWorkspaceIdForChannel
Type
string
Description
Specifies the ID of the workspace that contains new channel.
Table 5. Outputs
Output Details
slackChannelId
Type
string
Description
The ID of the new channel.

Edit Slack Message

Edit a message that was previously sent to Slack.

This action is available only if you enable the connection to Slack in Setup and the user who runs the flow is connected to Slack. Otherwise, the action fails.

URI: /services/data/vXX.X/actions/standard/slackUpdateMessage

Table 6. Inputs
Input Details
slackAppIdForToken
Type
string
Description

Required. Specifies the ID of the Slack app that executes the action.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

The Slack app must be a member of the conversation that contains the message to edit.
slackWorkspaceIdForToken
Type
string
Description

Required. Specifies the ID of the Slack workspace where the Slack app is installed.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

You can obtain the Slack workspace ID by logging in to Slack.com and launching Slack in your browser. The workspace ID is the penultimate parameter in the URL. For example, in this URL, the workspace ID is T01234ABCDE:

https://app.slack.com/client/T01234ABCDE/C56789FGHIJ
userIdForToken
Type
string
Description

Specifies the Salesforce user ID of the user that the flow uses to connect to Slack. If you don’t specify a user ID, the Slack app executes the action.

The user or Slack app that executes the action must be a member of the channel.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

slackConversationId
Type
string
Description

Required. Specifies the ID of the channel or direct message to send the message to. Alternatively, specify a Slack user ID if the message was sent to the user via the Messages tab of the Slack app.

You can obtain the Slack conversation ID by logging in to Slack.com and launching Slack in your browser. The conversation ID is the last parameter in the URL. For example, in this URL, the conversation ID is C56789FGHIJ:

https://app.slack.com/client/T01234ABCDE/C56789FGHIJ
slackMessage
Type
string
Description
Required. Specifies the message to send. For best results, include no more than 4,000 characters. Slack truncates messages containing more than 40,000 characters. Enter a value or select a resource.

Slack supports text formatting with Slack mrkdown. To disable formatting for a plain text message that contains Slack mrkdown, use an escape sequence.

Slack does not support text formatting with HTML and renders rich text messages as plain text.
slackMessageTimestamp
Type
string
Description
Required. Specifies the timestamp of the sent message, for example, 1234567890.123456.

The numerals before the period character (.) specify a Unix timestamp. The numerals after the period character specify microseconds.

You can store the Slack Message Timestamp output parameter of the Send Slack Message, Edit Slack Message, or Send Message To Launch Flow (Beta) action as a resource to use later.
viewApiName
Type
string
Description
Specifies the API name of the view that the message is sent with.
recordId
Type
string
Description
Specifies the Salesforce record ID to send to the view.
Table 7. Outputs
Output Details
slackMessageTimestamp
Type
string
Description
The timestamp of the sent message.

Get Information About Slack Conversation

Retrieve the name of a Slack channel and find out whether it’s archived. Archived channels are closed to new activity, but users can still view and search an archived channel’s message history. Available in API version 54.0.

This action is available only if you enable the connection to Slack in Setup and the user who runs the flow is connected to Slack. Otherwise, the action fails.

URI: /services/data/vXX.X/actions/standard/slackGetConversationInfo

Table 8. Inputs
Input Details
slackAppIdForToken
Type
string
Description

Required. Specifies the ID of the Slack app that executes the action.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

slackWorkspaceIdForToken
Type
string
Description

Required. Specifies the ID of the Slack workspace where the Slack app is installed.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

You can obtain the Slack workspace ID by logging in to Slack.com and launching Slack in your browser. The workspace ID is the penultimate parameter in the URL. For example, in this URL, the workspace ID is T01234ABCDE:

https://app.slack.com/client/T01234ABCDE/C56789FGHIJ
userIdForToken
Type
string
Description

Specifies the Salesforce user ID of the user that the flow uses to connect to Slack. If you don’t specify a user ID, the Slack app executes the action.

The user or Slack app that executes the action must be a member of the channel.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

slackConversationId
Type
string
Description

Required. Specifies the ID of the channel to obtain information about.

You can obtain the Slack conversation ID by logging in to Slack.com and launching Slack in your browser. The conversation ID is the last parameter in the URL. For example, in this URL, the conversation ID is C56789FGHIJ:

https://app.slack.com/client/T01234ABCDE/C56789FGHIJ
Table 9. Outputs
Output Details
slackConversationId
Type
string
Description

The ID of the channel that you retrieved information about.
slackConversationName
Type
string
Description

The name of the channel that you retrieved information about.
isConversationArchived
Type
boolean
Description

Indicates whether the channel is archived.

Invite Users to Slack Channel

Add users who are connected to a given Slack app to a Slack channel or direct message. Available in API version 54.0.

This action is available only if you enable the connection to Slack in Setup and the user who runs the flow is connected to Slack. Otherwise, the action fails. Additionally, the user that initiates the flow and any users impacted by the action must have logged in to a Salesforce Slack app at least once.

URI: /services/data/vXX.X/actions/standard/slackInviteUsersToChannel

Table 10. Inputs
Input Details
slackAppIdForToken
Type
string
Description

Required. Specifies the ID of the Slack app that executes the action.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

slackWorkspaceIdForToken
Type
string
Description

Required. Specifies the ID of the Slack workspace where the Slack app is installed.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

You can obtain the Slack workspace ID by logging in to Slack.com and launching Slack in your browser. The workspace ID is the penultimate parameter in the URL. For example, in this URL, the workspace ID is T01234ABCDE:

https://app.slack.com/client/T01234ABCDE/C56789FGHIJ
userIdForToken
Type
string
Description

Specifies the Salesforce user ID of the user that the flow uses to connect to Slack. If you don’t specify a user ID, the Slack app executes the action.

The user or Slack app that executes the action must be a member of the channel.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

slackChannelId
Type
string
Description

Required. Specifies the ID of the Slack channel to execute the action on. This is also known as the Slack conversation ID.

You can obtain the Slack conversation ID by logging in to Slack.com and launching Slack in your browser. The conversation ID is the last parameter in the URL. For example, in this URL, the conversation ID is C56789FGHIJ:

https://app.slack.com/client/T01234ABCDE/C56789FGHIJ
slackWorkspaceIdForChannel
Type
string
Description
Specifies the ID of the workspace that contains the channel to invite users to.
userIdsToInvite
Type
string
Description
Required. Specifies the collection resource that contains the Salesforce user IDs of the users to invite.

Pin or Unpin Slack Message

Pin or unpin a message in a Slack channel or direct message. Pin messages so that they’re readily available from the conversation header. Available in API version 54.0.

This action is available only if you enable the connection to Slack in Setup and the user who runs the flow is connected to Slack. Otherwise, the action fails.

URI: /services/data/vXX.X/actions/standard/slackPinMessage

Table 11. Inputs
Input Details
slackAppIdForToken
Type
string
Description

Required. Specifies the ID of the Slack app that executes the action.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

The Slack app must be a member of the conversation that contains the message to pin or unpin.
slackWorkspaceIdForToken
Type
string
Description

Required. Specifies the ID of the Slack workspace where the Slack app is installed.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

You can obtain the Slack workspace ID by logging in to Slack.com and launching Slack in your browser. The workspace ID is the penultimate parameter in the URL. For example, in this URL, the workspace ID is T01234ABCDE:

https://app.slack.com/client/T01234ABCDE/C56789FGHIJ
userIdForToken
Type
string
Description

Specifies the Salesforce user ID of the user that the flow uses to connect to Slack. If you don’t specify a user ID, the Slack app executes the action.

The user or Slack app that executes the action must be a member of the channel.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

slackConversationId
Type
string
Description

Required. Specifies the ID of the Slack channel to execute the action on. This is also known as the Slack conversation ID.

You can obtain the Slack conversation ID by logging in to Slack.com and launching Slack in your browser. The conversation ID is the last parameter in the URL. For example, in this URL, the conversation ID is C56789FGHIJ:

https://app.slack.com/client/T01234ABCDE/C56789FGHIJ
slackMessageTimestamp
Type
string
Description
Required. Specifies the timestamp of the sent message, for example, 1234567890.123456.

The numerals before the period character (.) specify a Unix timestamp. The numerals after the period character specify microseconds.
doesPinMessage
Type
boolean
Description
Required. Indicates whether to pin the message to the the conversation header. A value of true pins the message. A value of false unpins the message.

Send Slack Message

Send a message to a Slack channel or direct message. Available in API version 54.0.

This action is available only if you enable the connection to Slack in Setup and the user who runs the flow is connected to Slack. Otherwise, the action fails.

URI: /services/data/vXX.X/actions/standard/slackPostMessage

Table 12. Inputs
Input Details
slackAppIdForToken
Type
string
Description

Required. Specifies the ID of the Slack app that executes the action.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

slackWorkspaceIdForToken
Type
string
Description

Required. Specifies the ID of the Slack workspace where the Slack app is installed.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

You can obtain the Slack workspace ID by logging in to Slack.com and launching Slack in your browser. The workspace ID is the penultimate parameter in the URL. For example, in this URL, the workspace ID is T01234ABCDE:

https://app.slack.com/client/T01234ABCDE/C56789FGHIJ
userIdForToken
Type
string
Description

Specifies the Salesforce user ID of the user that the flow uses to connect to Slack. If you don’t specify a user ID, the Slack app executes the action.

The user or Slack app that executes the action must be a member of the channel.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

slackConversationId
Type
string
Description

Required. Specifies the ID of the Slack channel to execute the action on. This is also known as the Slack conversation ID.

You can obtain the Slack conversation ID by logging in to Slack.com and launching Slack in your browser. The conversation ID is the last parameter in the URL. For example, in this URL, the conversation ID is C56789FGHIJ:

https://app.slack.com/client/T01234ABCDE/C56789FGHIJ
slackBotName
Type
string
Description
Specifies the name of the bot that sends the message in Slack.
slackMessage
Type
string
Description
Required. Specifies the message to send. For best results, include no more than 4,000 characters. Slack truncates messages containing more than 40,000 characters. Enter a value or select a resource.

Slack supports text formatting with Slack mrkdown. To disable formatting for a plain text message that contains Slack mrkdown, use an escape sequence.

Slack does not support text formatting with HTML and renders rich text messages as plain text.
viewApiName
Type
string
Description
Specifies the API name of the view that the message is sent with.
recordId
Type
string
Description
Specifies the Salesforce record ID to send to the view.
slackMessageTimestamp
Type
string
Description
Required. Specifies the timestamp of the sent message, for example, 1234567890.123456.

The numerals before the period character (.) specify a Unix timestamp. The numerals after the period character specify microseconds.

You can store the Slack Message Timestamp output parameter of the Send Slack Message, Edit Slack Message, or Send Message To Launch Flow (Beta) action as a resource to use later.
Table 13. Outputs
Output Details
slackMessageTimestamp
Type
string
Description
The timestamp of the sent message.

Send Slack Message to Launch Flow (Beta)

Send a message to a Slack channel or direct message that includes a button from which a recipient can launch a screen flow. Available in API version 55.0.

This action is available only if you enable the connection to Slack in Setup and the user who runs the flow is connected to Slack. Otherwise, the action fails.

URI: /services/data/vXX.X/actions/standard/slackSendMessageToLaunchFlow

Table 14. Inputs
Input Details
slackAppIdForToken
Type
string
Description

Required. Specifies the ID of the Slack app that executes the action.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

slackWorkspaceIdForToken
Type
string
Description

Required. Specifies the ID of the Slack workspace where the Slack app is installed.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

You can obtain the Slack workspace ID by logging in to Slack.com and launching Slack in your browser. The workspace ID is the penultimate parameter in the URL. For example, in this URL, the workspace ID is T01234ABCDE:

https://app.slack.com/client/T01234ABCDE/C56789FGHIJ
userIdForToken
Type
string
Description

Specifies the Salesforce user ID of the user that the flow uses to connect to Slack. If you don’t specify a user ID, the Slack app executes the action.

The user or Slack app that executes the action must be a member of the channel.

The flow uses the slackAppIdForToken,slackWorkspaceIdForToken, and userIdForToken values to retrieve an access token.

slackConversationId
Type
string
Description

Required. Specifies the ID of the Slack channel to execute the action on. This is also known as the Slack conversation ID.

You can obtain the Slack conversation ID by logging in to Slack.com and launching Slack in your browser. The conversation ID is the last parameter in the URL. For example, in this URL, the conversation ID is C56789FGHIJ:

https://app.slack.com/client/T01234ABCDE/C56789FGHIJ
slackBotName
Type
string
Description
Specifies the name of the bot that sends the message in Slack.
slackMessage
Type
string
Description
Required. Specifies the message to send. For best results, include no more than 4,000 characters. Slack truncates messages containing more than 40,000 characters. Enter a value or select a resource.

Slack supports text formatting with Slack mrkdown. To disable formatting for a plain text message that contains Slack mrkdown, use an escape sequence.

Slack does not support text formatting with HTML and renders rich text messages as plain text.
slackButtonLabel
Type
string
Description
Required. Specifies the label for the button that appears below the message. The user clicks the button to launch the flow from Slack.

Slack supports text formatting with Slack mrkdown. To disable formatting for a plain text message that contains Slack mrkdown, use an escape sequence.

Slack does not support text formatting with HTML and renders rich text messages as plain text.
slackMessageTimestamp
Type
string
Description
Required. Specifies the timestamp of the sent message, for example, 1234567890.123456.

The numerals before the period character (.) specify a Unix timestamp. The numerals after the period character specify microseconds.

You can store the Slack Message Timestamp output parameter of the Send Slack Message, Edit Slack Message, or Send Message To Launch Flow (Beta) action as a resource to use later.
Table 15. Outputs
Output Details
slackMessageTimestamp
Type
string
Description
The timestamp of the sent message.