Slack tools

Look up the Slack tools, selectors, permissions, inputs, and outputs available to tool steps and agent steps.

This reference lists the shipped Slack tool catalog. See the Slack overview for authentication and setup.

Tool catalog

The catalog uses the Slack bot scopes required by each tool. Read tools inspect workspace data. Write tools change messages, reactions, or canvases.

Tools

readread_channel

Read messages from a Slack channel in reverse chronological order (newest first). Reading direct message history needs the ID of that conversation, not the ID of the user on the other side.

Requiresread

Parameters

channel_idstringRequired

Channel, private group, or direct message conversation ID, such as C0ABC12345 or D0ABC12345. A user ID is not accepted here

oldeststring

Start of the time range, as a Slack timestamp

lateststring

End of the time range, as a Slack timestamp

limitinteger

Messages to return, 1 to 100 (default 100)

cursorstring

Pagination cursor from a previous request

readread_thread

Read a Slack thread: the parent message and all of its replies. Requires the channel ID and the timestamp of the parent message.

Requiresread

Parameters

channel_idstringRequired

Channel, private group, or direct message conversation ID, such as C0ABC12345 or D0ABC12345. A user ID is not accepted here

message_tsstringRequired

Timestamp of the parent message, such as 1234567890.123456

oldeststring

Start of the time range, as a Slack timestamp

lateststring

End of the time range, as a Slack timestamp

limitinteger

Messages to return, 1 to 1000 (default 100)

cursorstring

Pagination cursor from a previous request

- key: read_thread
  tool: read_thread
  connection: slack_acme # Replace with the slug of your integration connection.
  with:
    channel_id: "C0ABC12345 or D0ABC12345"
    message_ts: 1234567890

readget_permalink

Get a permanent link to a Slack message, including a reply in a thread. Requires the channel ID and the message timestamp.

Requiresread

Parameters

channel_idstringRequired

Channel, private group, or direct message conversation ID, such as C0ABC12345 or D0ABC12345. A user ID is not accepted here

message_tsstringRequired

Timestamp of the message, such as 1234567890.123456

- key: get_permalink
  tool: get_permalink
  connection: slack_acme # Replace with the slug of your integration connection.
  with:
    channel_id: "C0ABC12345 or D0ABC12345"
    message_ts: 1234567890

readread_channel_info

Retrieve metadata for a single Slack channel by ID: name, topic, purpose, privacy, and archive status. Use this to learn what a channel is for before reading or posting. To read its messages, use read_channel instead.

Requiresread

Parameters

channel_idstringRequired

Channel, private group, or direct message conversation ID, such as C0ABC12345 or D0ABC12345. A user ID is not accepted here

include_num_membersboolean

Include the channel member count (default false)

- key: read_channel_info
  tool: read_channel_info
  connection: slack_acme # Replace with the slug of your integration connection.
  with:
    channel_id: "C0ABC12345 or D0ABC12345"

readread_channel_members

List the user IDs of the members of a Slack channel. Pair it with read_user_profile to resolve a member to a name.

Requiresread

Parameters

channel_idstringRequired

Channel, private group, or direct message conversation ID, such as C0ABC12345 or D0ABC12345. A user ID is not accepted here

limitinteger

Members to return per page (default 100)

cursorstring

Pagination cursor from a previous request

- key: read_channel_members
  tool: read_channel_members
  connection: slack_acme # Replace with the slug of your integration connection.
  with:
    channel_id: "C0ABC12345 or D0ABC12345"

readread_user_profile

Retrieve profile information for a Slack user, including contact details, status, timezone, and role.

Requiresread

Parameters

user_idstringRequired

Slack user ID, such as U0ABC12345

include_localeboolean

Include the user's locale information (default false)

readsearch_channels

Search the channels this integration can see, by name, topic, or purpose. Returns channel names, IDs, topics, purposes, and archive status. Names are typically lowercase with hyphens. Space-separated terms all have to match. Only the requested page is searched, so page through with the returned cursor when a channel is missing.

Requiresread

Parameters

querystringRequired

Search query for finding channels

channel_typesstring

Comma-separated channel types: public_channel, private_channel. Defaults to public_channel

include_archivedboolean

Include archived channels in the results

limitinteger

Channels to scan per page (default 100)

cursorstring

Pagination cursor from a previous request

writesend_message

Send a message to a Slack channel or user. To send a direct message, pass the user ID as the channel ID. Supports standard Markdown: bold, italic, strikethrough, links, lists, blockquotes, inline code, and code blocks. Returns the posted message timestamp.

Requireswrite

Parameters

channel_idstringRequired

Channel, private group, or direct message conversation ID. Pass a user ID to open a direct message with that user

messagestringRequired

Message content, written as standard Markdown

Maximum length 12,000.

thread_tsstring

Timestamp of the parent message to reply in its thread

reply_broadcastboolean

Also send the thread reply to the channel

- key: send_message
  tool: send_message
  connection: slack_acme # Replace with the slug of your integration connection.
  with:
    channel_id: <channel_id>
    message: <message>

writeschedule_message

Schedule a message for future delivery to a Slack channel. Does not send immediately. post_at has to be at least 2 minutes in the future and at most 120 days out. Once scheduled, the message cannot be edited.

Requireswrite

Parameters

channel_idstringRequired

Channel, private group, or direct message conversation ID. Pass a user ID to open a direct message with that user

messagestringRequired

Message content, written as standard Markdown

Maximum length 12,000.

post_atintegerRequired

Unix timestamp at which to send the message

thread_tsstring

Timestamp of the parent message to reply in its thread

reply_broadcastboolean

Also send the thread reply to the channel

- key: schedule_message
  tool: schedule_message
  connection: slack_acme # Replace with the slug of your integration connection.
  with:
    channel_id: <channel_id>
    message: <message>
    post_at: 1

writeupdate_message

Update an already posted Slack message, replacing its content. Supports the same standard Markdown as send_message.

Requireswrite

Parameters

channel_idstringRequired

Channel, private group, or direct message conversation ID, such as C0ABC12345 or D0ABC12345. A user ID is not accepted here

message_tsstringRequired

Timestamp of the message to update

messagestringRequired

Message content, written as standard Markdown

Maximum length 12,000.

- key: update_message
  tool: update_message
  connection: slack_acme # Replace with the slug of your integration connection.
  with:
    channel_id: "C0ABC12345 or D0ABC12345"
    message_ts: <message_ts>
    message: <message>

writeadd_reaction

Add an emoji reaction to a Slack message.

Requireswrite

Parameters

channel_idstringRequired

Channel, private group, or direct message conversation ID, such as C0ABC12345 or D0ABC12345. A user ID is not accepted here

message_tsstringRequired

Timestamp of the message to react to

emojistringRequired

Emoji name without the surrounding colons, such as white_check_mark

- key: add_reaction
  tool: add_reaction
  connection: slack_acme # Replace with the slug of your integration connection.
  with:
    channel_id: "C0ABC12345 or D0ABC12345"
    message_ts: <message_ts>
    emoji: white_check_mark

writecreate_canvas

Create a standalone Slack canvas from Markdown and return its ID. Not available on free teams.

Requireswrite

Parameters

titlestringRequired

Concise, descriptive canvas name. Do not repeat it in the content

contentstringRequired

Canvas body, written as standard Markdown

Was this page helpful?

Edit this page on GitHub

Tool catalog

Tools

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

On this page