Slack

Learn how to use Slack with Composio

Overview

Enum

SLACK

Description

Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to channels:history,chat:write,team:read,channels:read,users:read,reminders:write,reactions:read,reactions:write
user_scopes
stringDefaults to channels:history,chat:write,team:read,channels:read,users:read,reminders:write,reactions:read
verification_token
string
token
stringRequired
verification_token
string

Actions

Sets or updates the do not disturb (dnd) snooze duration in minutes for the authenticated user, pausing notifications immediately for the specified time.

Action Parameters

num_minutes
stringRequired
token
stringRequired

Action Response

data
object
error
successful
boolean
Adds an alias for an existing custom emoji in a slack enterprise grid organization.

Action Parameters

alias_for
stringRequired
name
stringRequired
token
stringRequired

Action Response

data
object
error
successful
boolean
Adds a custom emoji to a slack workspace given a unique name and an image url; subject to workspace emoji limits.

Action Parameters

name
stringRequired
token
stringRequired
url
stringRequired

Action Response

data
object
error
successful
boolean
Adds a reference to an external file (e.g., google drive, dropbox) to slack for discovery and sharing, requiring a unique `external id` and an `external url` accessible by slack.

Action Parameters

external_id
string
external_url
string
filetype
string
indexable_file_contents
string
preview_image
string
title
string
token
string

Action Response

data
object
error
successful
boolean
Stars a channel, file, file comment, or a specific message in slack.

Action Parameters

channel
string
file
string
file_comment
string
timestamp
string

Action Response

data
object
error
successful
boolean
Adds channels to an idp user group's list of default channels, meaning new group members are automatically added to them; these channels supplement, and do not replace, any existing defaults.

Action Parameters

channel_ids
stringRequired
team_id
string
usergroup_id
stringRequired

Action Response

data
object
error
successful
boolean
Assigns an existing enterprise user, not already in the target workspace, to a specific slack workspace within an enterprise grid organization, optionally adding them to channels and defining their guest status.

Action Parameters

channel_ids
string
is_restricted
boolean
is_ultra_restricted
boolean
team_id
stringRequired
user_id
stringRequired

Action Response

data
object
error
successful
boolean
Restricts access to a private slack channel to members of a specified idp group by linking the group to the channel's allowlist within an enterprise grid organization; `team id` is required for single-workspace channels, otherwise optional.

Action Parameters

channel_id
stringRequired
group_id
stringRequired
team_id
string
token
stringRequired

Action Response

data
object
error
successful
boolean
Adds a specified emoji reaction to an existing message in a slack channel, identified by its timestamp; does not remove or retrieve reactions.

Action Parameters

channel
stringRequired
name
stringRequired
timestamp
stringRequired

Action Response

data
object
error
successful
boolean
Approves a pending app installation request within a slack workspace; requires admin privileges.

Action Parameters

app_id
string
request_id
string
team_id
string

Action Response

data
object
error
successful
boolean
Approves an existing, pending invite request for a slack workspace; this action is irreversible.

Action Parameters

invite_request_id
stringRequired
team_id
string

Action Response

data
object
error
successful
boolean
Deprecated: retrieves permissions for the app; use `list app permissions on a team` instead.

Action Parameters

Action Response

data
object
error
successful
boolean
Deprecated: use 'list app permissions scopes on a team' instead; retrieves oauth scopes for the authenticated slack app.

Action Parameters

Action Response

data
object
error
successful
boolean
Archives a slack public or private channel, making it read-only; the primary 'general' channel cannot be archived.

Action Parameters

channel_id
stringRequired

Action Response

data
object
error
successful
boolean
Archives a slack conversation by its id, rendering it read-only and hidden while retaining history, ideal for cleaning up inactive channels; be aware that some channels (like #general or certain dms) cannot be archived and this may impact connected integrations.

Action Parameters

channel
string

Action Response

data
object
error
successful
boolean
Associates specified slack workspaces (teams) with an existing idp user group as its default workspaces, requiring all workspaces and the group to be within the same organization.

Action Parameters

auto_provision
boolean
team_ids
stringRequired
usergroup_id
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: posts a message to a slack channel, direct message, or private channel. use `sends a message to a slack channel` instead.<<DEPRECATED use sends_a_message_to_a_slack_channel>>

Action Parameters

as_user
boolean
attachments
string
blocks
string
channel
stringRequired
icon_emoji
string
icon_url
string
link_names
boolean
mrkdwn
boolean
parse
string
reply_broadcast
boolean
text
string
thread_ts
string
unfurl_links
boolean
unfurl_media
boolean
username
string

Action Response

data
object
error
successful
boolean
Calls slack's `api.test` method to check api status, optionally specifying an error to trigger or an arbitrary parameter to echo.

Action Parameters

error
string
foo
string

Action Response

data
object
error
successful
boolean
Use to validate the current authentication token and get basic identity (user/bot, team) information; it does not return token scopes.

Action Parameters

Action Response

data
object
error
successful
boolean
Closes a slack direct message (dm) or multi-person direct message (mpdm) channel, removing it from the user's sidebar without deleting history; this action affects only the calling user's view.

Action Parameters

channel
string

Action Response

data
object
error
successful
boolean
Deprecated: use `fetch conversation history`. retrieves message history from a slack conversation accessible by the authenticated user/bot, with pagination and time filtering.

Action Parameters

channel
string
cursor
string
inclusive
boolean
latest
integer
limit
integer
oldest
integer

Action Response

data
object
error
successful
boolean
Deprecated (use `retrieve conversation information`): retrieves metadata (name, purpose, creation date) for a slack conversation, excluding messages.

Action Parameters

channel
string
include_locale
boolean
include_num_members
boolean

Action Response

data
object
error
successful
boolean
(deprecated) retrieves public channels, private channels, mpims, and ims from a slack workspace; use `list all slack team channels with various filters` instead.

Action Parameters

cursor
string
exclude_archived
boolean
limit
integerDefaults to 1
types
string

Action Response

data
object
error
successful
boolean
Converts a public channel to private; this is irreversible and the channel must already exist.

Action Parameters

channel_id
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new team within a slack enterprise grid organization; the organization must be on an enterprise grid plan.

Action Parameters

team_description
string
team_discoverability
string
team_domain
stringRequired
team_name
stringRequired

Action Response

data
object
error
successful
boolean
Creates a slack reminder with specified text and time; time accepts unix timestamps, seconds from now, or natural language (e.g., 'in 15 minutes', 'every thursday at 2pm').

Action Parameters

text
stringRequired
time
stringRequired
user
string

Action Response

data
object
error
successful
boolean
Creates a new user group (often referred to as a subteam) in a slack workspace.

Action Parameters

channels
string
description
string
handle
string
include_count
boolean
name
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new public or private slack channel with a unique name; the channel can be org-wide, or team-specific if `team id` is given (required if `org wide` is false or not provided).

Action Parameters

description
string
is_private
booleanRequired
name
stringRequired
org_wide
boolean
team_id
string

Action Response

data
object
error
successful
boolean
Customizes url previews (unfurling) in a specific slack message using a url-encoded json in `unfurls` to define custom content or remove existing previews.

Action Parameters

channel
stringRequired
ts
stringRequired
unfurls
string
user_auth_message
string
user_auth_required
boolean
user_auth_url
string

Action Response

data
object
error
successful
boolean
Deletes a message, identified by its channel id and timestamp, from a slack channel, private group, or direct message conversation; the authenticated user or bot must be the original poster.

Action Parameters

as_user
boolean
channel
string
ts
integer

Action Response

data
object
error
successful
boolean
Deletes a specific comment from a file in slack; this action is irreversible.

Action Parameters

file
string
id
string

Action Response

data
object
error
successful
boolean
Permanently deletes an existing file from a slack workspace using its unique file id; this action is irreversible and also removes any associated comments or shares.

Action Parameters

file
string

Action Response

data
object
error
successful
boolean
Permanently and irreversibly deletes a specified public or private channel, including all its messages and files, within a slack enterprise grid organization.

Action Parameters

channel_id
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a pending, unsent scheduled message from the specified slack channel, identified by its `scheduled message id`.

Action Parameters

as_user
boolean
channel
stringRequired
scheduled_message_id
stringRequired

Action Response

data
object
error
successful
boolean
Deletes an existing slack reminder, typically when it is no longer relevant or a task is completed; this operation is irreversible.

Action Parameters

reminder
string

Action Response

data
object
error
successful
boolean
Deletes the slack profile photo for the user identified by the token, reverting them to the default avatar; this action is irreversible and succeeds even if no custom photo was set.

Action Parameters

token
stringRequired

Action Response

data
object
error
successful
boolean
Denies a pending slack workspace invite request that is currently active; this action is irreversible.

Action Parameters

invite_request_id
stringRequired
team_id
string

Action Response

data
object
error
successful
boolean
Disables a specified, currently enabled slack user group by its unique id, effectively archiving it by setting its 'date delete' timestamp; the group is not permanently deleted and can be re-enabled.

Action Parameters

include_count
boolean
usergroup
stringRequired

Action Response

data
object
error
successful
boolean
Disconnects a shared channel within a slack enterprise grid from specified, currently connected, workspace(s), permanently altering its sharing settings; not applicable to dms.

Action Parameters

channel_id
stringRequired
leaving_team_ids
string

Action Response

data
object
error
successful
boolean
Enables a disabled user group in slack using its id, reactivating it for mentions and permissions; this action only changes the enabled status and cannot create new groups or modify other properties.

Action Parameters

include_count
boolean
usergroup
stringRequired

Action Response

data
object
error
successful
boolean
Enables public sharing for an existing slack file by generating a publicly accessible url; this action does not create new files.

Action Parameters

file
string

Action Response

data
object
error
successful
boolean
Ends an ongoing slack call, identified by its id (obtained from `calls.add`), optionally specifying the call's duration.

Action Parameters

duration
integer
id
stringRequired

Action Response

data
object
error
successful
boolean
Ends the authenticated user's current do not disturb (dnd) session in slack, affecting only dnd status and making them available; if dnd is not active, slack acknowledges the request without changing status.

Action Parameters

Action Response

data
object
error
successful
boolean
Immediately ends the user's active do not disturb (dnd) snooze in slack, allowing them to resume receiving notifications.

Action Parameters

Action Response

data
object
error
successful
boolean
Exchanges a temporary, single-use slack oauth `code` for an access token; used in the oauth flow and does not require a pre-existing api token.

Action Parameters

client_id
string
client_secret
string
code
string
redirect_uri
string
single_channel
boolean

Action Response

data
object
error
successful
boolean
Exchanges a temporary slack authorization code, obtained via oauth callback, for a workspace access token.

Action Parameters

client_id
string
client_secret
string
code
string
redirect_uri
string
single_channel
boolean

Action Response

data
object
error
successful
boolean
Call this action to complete the slack oauth 2.0 flow by exchanging a temporary authorization `code` and client credentials for an access token, providing the original `redirect uri` if it was used in the initial authorization step.

Action Parameters

client_id
string
client_secret
string
code
stringRequired
redirect_uri
string

Action Response

data
object
error
successful
boolean
Fetches information for a specified, existing slack bot user; will not work for regular user accounts or other integration types.

Action Parameters

bot
string

Action Response

data
object
error
successful
boolean
Fetches a chronological list of messages and events from a specified slack conversation, accessible by the authenticated user/bot, with options for pagination and time range filtering.

Action Parameters

channel
string
cursor
string
inclusive
boolean
latest
integer
limit
integer
oldest
integer

Action Response

data
object
error
successful
boolean
Fetches comprehensive metadata about the current slack team, or a specified team if the provided id is accessible.

Action Parameters

team
string

Action Response

data
object
error
successful
boolean
Fetches the do not disturb (dnd) status for a comma-separated list of specified slack user ids.

Action Parameters

users
string

Action Response

data
object
error
successful
boolean
Fetches reactions for a slack message, file, or file comment, requiring one of: channel and timestamp; file id; or file comment id.

Action Parameters

channel
string
file
string
file_comment
string
full
boolean
timestamp
string

Action Response

data
error
successful
boolean
Retrieves replies to a specific parent message in a slack conversation, using the channel id and the parent message's timestamp (`ts`).

Action Parameters

channel
string
cursor
string
inclusive
boolean
latest
integer
limit
integer
oldest
integer
ts
string

Action Response

data
object
error
successful
boolean
Retrieves detailed settings for a specific slack workspace, primarily for administrators in an enterprise grid organization to view or audit workspace configurations.

Action Parameters

team_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the slack user object for an active user by their registered email address; fails with 'users not found' if the email is unregistered or the user is inactive.

Action Parameters

email
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves billable status (not amounts or settings) for users in a slack team; only provides meaningful data if billing features are active on the workspace.

Action Parameters

user
string

Action Response

data
object
error
successful
boolean
Retrieves conversation preferences (e.g., who can post, who can thread) for a specified channel, primarily for use within slack enterprise grid environments.

Action Parameters

channel_id
stringRequired

Action Response

data
object
error
successful
boolean
For slack enterprise grid, retrieves workspace ids connected to a given channel, typically for administrators to audit multi-workspace channel access.

Action Parameters

channel_id
stringRequired
cursor
string
limit
integer

Action Response

data
object
error
successful
boolean
Fetches potentially delayed integration activity logs for the current slack team, filterable by app, change type, service, or user, to audit integration activities.

Action Parameters

app_id
string
change_type
string
count
string
page
string
service_id
string
user
string

Action Response

data
object
error
successful
boolean
Retrieves paginated access logs for the current slack team, detailing user login events for security auditing and monitoring workspace access, typically requiring admin privileges and a supporting slack plan.

Action Parameters

before
string
count
string
page
string

Action Response

data
object
error
successful
boolean
Retrieves detailed information for an existing slack reminder specified by its id; this is a read-only operation.

Action Parameters

reminder
string

Action Response

data
object
error
successful
boolean
Retrieves a slack user's current real-time presence (e.g., 'active', 'away') to determine their availability, noting this action does not provide historical data or status reasons.

Action Parameters

user
string

Action Response

data
object
error
successful
boolean
Signals to slack that an identified workflow step (`workflow step execute id`) of an active custom workflow has failed, providing an error message; this action only reports the failure and does not attempt to retry or resolve it.

Action Parameters

error
stringRequired
workflow_step_execute_id
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new, uniquely named public or private channel in slack.

Action Parameters

is_private
boolean
name
string

Action Response

data
object
error
successful
boolean
Forcibly terminates a specific user's active slack session, identified by `session id` within the specified `team id`, mainly for administrative security needs like immediate access revocation when other methods are inadequate.

Action Parameters

session_id
integerRequired
team_id
stringRequired

Action Response

data
object
error
successful
boolean
Invites users to an existing slack channel using their valid slack user ids.

Action Parameters

channel
string
users
string

Action Response

data
object
error
successful
boolean
Invites users to a specified slack channel; this action is restricted to enterprise grid workspaces and requires the authenticated user to be a member of the target channel.

Action Parameters

channel_id
stringRequired
user_ids
stringRequired

Action Response

data
object
error
successful
boolean
Invites a user to a slack workspace and specified channels by email; use `resend=true` to re-process an existing invitation for a user not yet signed up.

Action Parameters

channel_ids
stringRequired
custom_message
string
email
stringRequired
guest_expiration_ts
string
is_restricted
boolean
is_ultra_restricted
boolean
real_name
string
resend
boolean
team_id
stringRequired

Action Response

data
object
error
successful
boolean
Joins an existing slack conversation (public channel, private channel, or multi-person direct message) by its id, if the authenticated user has permission.

Action Parameters

channel
string

Action Response

data
object
error
successful
boolean
Leaves a slack conversation given its channel id; fails if leaving as the last member of a private channel or if used on a slack connect channel.

Action Parameters

channel
string

Action Response

data
object
error
successful
boolean
Retrieves all messages and files pinned to a specified channel; the caller must have access to this channel.

Action Parameters

channel
stringRequired

Action Response

data
array
error
successful
boolean
Lists all authenticated user's starred items (messages, files, comments, channels, dms, groups) in slack, with pagination.

Action Parameters

count
string
cursor
string
limit
integer
page
string

Action Response

data
object
error
successful
boolean
Retrieves conversations accessible to a specified user (or the authenticated user if no user id is provided), respecting shared membership for non-public channels.

Action Parameters

cursor
string
exclude_archived
boolean
limit
integer
types
string
user
string

Action Response

data
object
error
successful
boolean
Retrieves public channels, private channels, multi-person direct messages (mpims), and direct messages (ims) from a slack workspace, with options to filter by type and exclude archived channels.

Action Parameters

cursor
string
exclude_archived
boolean
limit
integerDefaults to 1
types
string

Action Response

data
object
error
successful
boolean
Retrieves a paginated list of all users, including comprehensive details, profile information, status, and team memberships, in a slack workspace; data may not be real-time.

Action Parameters

cursor
string
include_locale
boolean
limit
integerDefaults to 1

Action Response

data
object
error
successful
boolean
Lists all teams (workspaces) within a slack enterprise grid organization for auditing, management, or reporting.

Action Parameters

cursor
string
limit
integer

Action Response

data
object
error
successful
boolean
Retrieves a list of all user ids within a specified slack user group, with an option to include users from disabled groups.

Action Parameters

include_disabled
boolean
usergroup
stringRequired

Action Response

data
object
error
successful
boolean
Fetches a paginated list of approved applications for a slack workspace (using `team id`) or an enterprise grid organization (using `enterprise id`); if neither id is specified, the scope depends on the authentication context.

Action Parameters

cursor
string
enterprise_id
string
limit
integer
team_id
string

Action Response

data
object
error
successful
boolean
Lists approved invite requests for a slack workspace; if `team id` is omitted, requests are listed based on the token's default scope or primary workspace.

Action Parameters

cursor
string
limit
integer
team_id
string

Action Response

data
object
error
successful
boolean
Retrieves a list of permissions and resources granted to the slack application associated with the token.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves all oauth scopes (bot and user token) granted to the authenticated slack app on the current team.

Action Parameters

Action Response

data
object
error
successful
boolean
Lists resources (e.g., channels, users) the authenticated slack app can access in the workspace, noting the list is filtered by the app's current authentication scopes.

Action Parameters

cursor
string
limit
integer

Action Response

data
object
error
successful
boolean
Lists oauth grants and scopes users on a slack team approved for the calling application.

Action Parameters

cursor
string
limit
integer

Action Response

data
object
error
successful
boolean
Retrieves a list of all invite requests that have been *denied* for a slack workspace, primarily for auditing or reviewing past access decisions.

Action Parameters

cursor
string
limit
integer
team_id
string

Action Response

data
object
error
successful
boolean
Lists original connected channel information for specified enterprise key management (ekm) enabled channels, particularly disconnected or frozen ones, within an ekm-enabled slack workspace.

Action Parameters

channel_ids
string
cursor
string
limit
integer
team_ids
string

Action Response

data
object
error
successful
boolean
Retrieves a paginated list of all user-created custom emojis for a slack enterprise grid organization.

Action Parameters

cursor
string
limit
integer

Action Response

data
object
error
successful
boolean
Lists app installations authorized for a given slack event context, to determine app visibility for that event.

Action Parameters

cursor
string
event_context
stringRequired
limit
integer

Action Response

data
object
error
successful
boolean
Lists files and their metadata within a slack workspace, filterable by user, channel, timestamp, or type; this action returns metadata only, not file content.

Action Parameters

channel
string
count
string
page
string
show_files_hidden_by_limit
boolean
ts_from
integer
ts_to
integer
types
string
user
string

Action Response

data
object
error
successful
boolean
Lists identity provider (idp) group ids linked to a private slack channel; `team id` is required if the channel is not organization-wide.

Action Parameters

channel_id
stringRequired
team_id
string

Action Response

data
object
error
successful
boolean
Lists channels linked to an identity provider (idp) user group, optionally for a specific team if the token accesses multiple teams in an enterprise grid.

Action Parameters

include_num_members
boolean
team_id
string
usergroup_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a list of all pending invite requests for a slack workspace, primarily for administrators to manage outstanding invitations.

Action Parameters

cursor
string
limit
integer
team_id
string

Action Response

data
object
error
successful
boolean
Lists applications restricted from installation within a specific slack workspace (using `team id`) or an entire enterprise grid organization (using `enterprise id`).

Action Parameters

cursor
string
enterprise_id
string
limit
integer
team_id
string

Action Response

data
object
error
successful
boolean
Retrieves a list of pending (not yet delivered) messages scheduled in a specific slack channel, or across all accessible channels if no channel id is provided, optionally filtered by time and paginated.

Action Parameters

channel
string
cursor
string
latest
integer
limit
integer
oldest
integer

Action Response

data
object
error
successful
boolean
Lists metadata (not content) for remote files shared in a slack workspace, with support for filtering and pagination.

Action Parameters

channel
string
cursor
string
limit
integer
ts_from
integer
ts_to
integer

Action Response

data
object
error
successful
boolean
Retrieves all custom emojis for the slack workspace (image urls or aliases), not standard unicode emojis; does not include usage statistics or creation dates.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves a list of app installation requests for a slack workspace or enterprise grid organization.

Action Parameters

cursor
string
limit
integer
team_id
string

Action Response

data
object
error
successful
boolean
Lists user groups in a slack workspace, including user-created and default groups; results for large workspaces may be paginated.

Action Parameters

include_count
boolean
include_disabled
boolean
include_users
boolean

Action Response

data
object
error
successful
boolean
Lists all reactions added by a specific user to messages, files, or file comments in slack, useful for engagement analysis when the item content itself is not required.

Action Parameters

count
integer
cursor
string
full
boolean
limit
integer
page
integer
user
string

Action Response

data
object
error
successful
boolean
Lists all reminders with their details for the authenticated slack user; returns an empty list if no reminders exist.

Action Parameters

Action Response

data
object
error
successful
boolean
Lists all administrator user ids for a given slack workspace (team id), which must be part of an enterprise grid organization.

Action Parameters

cursor
string
limit
integer
team_id
stringRequired

Action Response

data
object
error
successful
boolean
Lists the owners of a specific slack workspace (team id) that is part of an enterprise grid organization.

Action Parameters

cursor
string
limit
integer
team_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a paginated list of admin users for a specified slack workspace.

Action Parameters

cursor
string
limit
integer
team_id
stringRequired

Action Response

data
object
error
successful
boolean
Manually sets a user's slack presence, overriding automatic detection; this setting persists across connections but can be overridden by user actions or slack's auto-away (e.g., after 10 mins of inactivity).

Action Parameters

presence
stringRequired

Action Response

data
object
error
successful
boolean
Converts slack user ids between workspace-specific (e.g., u12345) and global enterprise grid (e.g., wabcdef) formats; defaults to converting 'u' ids to 'w' ids, set `to old=true` to convert 'w' ids to 'u' ids.

Action Parameters

team_id
string
to_old
boolean
users
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: marks the authenticated user as active, typically when they return from inactivity.

Action Parameters

Action Response

data
object
error
successful
boolean
Marks a specific slack reminder as complete using its `reminder` id; **deprecated**: this slack api endpoint ('reminders.complete') was deprecated in march 2023 and is not recommended for new applications.

Action Parameters

reminder
string

Action Response

data
object
error
successful
boolean
Marks an active slack workflow step as completed via its `workflow step execute id` when its execution has successfully concluded, optionally providing json outputs for subsequent steps; this action only updates the step's status and does not execute the step itself.

Action Parameters

outputs
string
workflow_step_execute_id
stringRequired

Action Response

data
object
error
successful
boolean
Opens a modal view for a slack user in response to an interaction.

Action Parameters

trigger_id
stringRequired
view
stringRequired

Action Response

data
object
error
successful
boolean
Opens or resumes a slack direct message (dm) or multi-person direct message (mpim) by providing either user ids or an existing channel id.

Action Parameters

channel
string
return_im
boolean
users
string

Action Response

data
object
error
successful
boolean
Opens an interactive slack dialog modal to collect user information or display complex content, defined by a valid slack `dialog` json, using a `trigger id` from a recent user interaction (valid for only 3 seconds).

Action Parameters

dialog
stringRequired
trigger_id
stringRequired

Action Response

data
object
error
successful
boolean
Pins a message to a specified slack channel; the message must not already be pinned.

Action Parameters

channel
stringRequired
timestamp
string

Action Response

data
object
error
successful
boolean
Promotes a user to an admin in a slack enterprise grid workspace, provided the user is not the primary owner.

Action Parameters

team_id
stringRequired
user_id
stringRequired

Action Response

data
object
error
successful
boolean
Promotes a user to a workspace owner within a slack enterprise grid organization; this action is irreversible through the api.

Action Parameters

team_id
stringRequired
user_id
stringRequired

Action Response

data
object
error
successful
boolean
Publishes or updates the home tab view for a specified user in slack; this cannot be used for modals or messages.

Action Parameters

hash
string
user_id
stringRequired
view
stringRequired

Action Response

data
object
error
successful
boolean
Pushes a new view onto an existing view stack in a slack modal or home tab for dynamic multi-step interactions; view stack depth is limited (e.g., typically 3 for modals).

Action Parameters

trigger_id
stringRequired
view
stringRequired

Action Response

data
object
error
successful
boolean
Registers a new call in slack using `calls.add` for third-party call integration; `created by` is required if not using a user-specific token.

Action Parameters

created_by
string
date_start
integer
desktop_app_join_url
string
external_display_id
string
external_unique_id
stringRequired
join_url
stringRequired
title
string
users
string

Action Response

data
object
error
successful
boolean
Adds new participants (specified in `users` json with `slack id`/`external id`) to an ongoing slack call identified by its `id` (from `calls.add`).

Action Parameters

id
stringRequired
users
stringRequired

Action Response

data
object
error
successful
boolean
Removes specified participants from an active slack call; removal is irreversible and the call persists even if empty.

Action Parameters

id
stringRequired
users
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: creates a slack reminder; use `create a reminder` instead.

Action Parameters

text
stringRequired
time
stringRequired
user
string

Action Response

data
object
error
successful
boolean
Removes the slack reference to an external file (which must have been previously added via the remote files api), specified by either its `external id` or `file` id (one of which is required), without deleting the actual external file.

Action Parameters

external_id
string
file
string
token
string

Action Response

data
object
error
successful
boolean
Removes a star from a previously starred slack item (message, file, file comment, channel, group, or dm), requiring identification via `file`, `file comment`, `channel` (for channel/group/dm), or both `channel` and `timestamp` (for a message).

Action Parameters

channel
string
file
string
file_comment
string
timestamp
string

Action Response

data
object
error
successful
boolean
Removes a specified user from a slack conversation (channel); the caller must have permissions to remove users and cannot remove themselves using this action.

Action Parameters

channel
string
user
string

Action Response

data
object
error
successful
boolean
Disassociates channels from an idp group; this action does not delete the channels or the group itself and may affect user access.

Action Parameters

channel_ids
stringRequired
usergroup_id
stringRequired

Action Response

data
object
error
successful
boolean
Removes an existing custom emoji, specified by its name, from a slack enterprise grid organization, rendering it unavailable across all associated workspaces; this action is permanent and cannot be undone.

Action Parameters

name
stringRequired
token
stringRequired

Action Response

data
object
error
successful
boolean
Unlinks an already-linked identity provider (idp) group from a private slack channel to revoke its members' access; specify `team id` if the channel is not shared across an organization.

Action Parameters

channel_id
stringRequired
group_id
stringRequired
team_id
stringRequired
token
stringRequired

Action Response

data
object
error
successful
boolean
Removes an emoji reaction from a message, file, or file comment in slack.

Action Parameters

channel
string
file
string
file_comment
string
name
stringRequired
timestamp
string

Action Response

data
object
error
successful
boolean
Irreversibly removes a user from a slack workspace, permanently revoking their access; back up user data beforehand if needed as this action does not preserve it.

Action Parameters

team_id
stringRequired
user_id
stringRequired

Action Response

data
object
error
successful
boolean
Renames an existing custom emoji in a slack workspace, updating all its instances.

Action Parameters

name
stringRequired
new_name
stringRequired
token
stringRequired

Action Response

data
object
error
successful
boolean
Renames a slack channel, automatically adjusting the new name to meet naming conventions (e.g., converting to lowercase), which may affect integrations using the old name.

Action Parameters

channel
string
name
string

Action Response

data
object
error
successful
boolean
Renames a public or private slack channel; for enterprise grid workspaces, the user must be a workspace admin or channel manager.

Action Parameters

channel_id
stringRequired
name
stringRequired

Action Response

data
object
error
successful
boolean
Requests additional oauth `scopes` for a slack app, initiating an approval process with workspace administrators rather than granting permissions directly; requires a `trigger id` from a recent user interaction.

Action Parameters

scopes
stringRequired
trigger_id
stringRequired

Action Response

data
object
error
successful
boolean
Restricts an app (using `app id` and `team id`) or a pending app installation request (using `request id`) in a slack workspace.

Action Parameters

app_id
string
request_id
string
team_id
string

Action Response

data
object
error
successful
boolean
Retrieves the authenticated user's and their team's identity, with details varying based on oauth scopes (e.g., `identity.basic`, `identity.email`, `identity.avatar`).

Action Parameters

Action Response

data
array
error
successful
boolean
Retrieves a point-in-time snapshot of a specific slack call's information.

Action Parameters

id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves metadata for a slack conversation by id (e.g., name, purpose, creation date, with options for member count/locale), excluding message content; requires a valid channel id.

Action Parameters

channel
string
include_locale
boolean
include_num_members
boolean

Action Response

data
object
error
successful
boolean
Retrieves a paginated list of active member ids for a specified slack public channel, private channel, direct message (dm), or multi-person direct message (mpim).

Action Parameters

channel
string
cursor
string
limit
integer

Action Response

data
object
error
successful
boolean
Retrieves a slack user's current do not disturb (dnd) status to determine their availability before interaction; any specified user id must be a valid slack user id.

Action Parameters

user
string

Action Response

data
object
error
successful
boolean
Retrieves detailed metadata and paginated comments for a specific slack file id; does not download file content.

Action Parameters

count
string
cursor
string
file
string
limit
integer
page
string

Action Response

data
object
error
successful
boolean
Retrieves comprehensive information for a valid slack user id, excluding message history and channel memberships.

Action Parameters

include_locale
boolean
user
string

Action Response

data
object
error
successful
boolean
Fetches metadata and slack-specific status (like sharing status and permissions) for an externally hosted file that has been previously added/shared to slack, using either its unique slack file id or a creator-defined external guid.

Action Parameters

external_id
string
file
string

Action Response

data
object
error
successful
boolean
Retrieves all profile field definitions for a slack team, optionally filtered by visibility, to understand the team's profile structure.

Action Parameters

visibility
string

Action Response

data
object
error
successful
boolean
Retrieves profile information for a specified slack user (defaults to the authenticated user if `user` id is omitted); a provided `user` id must be valid.

Action Parameters

include_labels
boolean
user
string

Action Response

data
object
error
successful
boolean
Unarchives an existing, archived slack conversation using its channel id; this may affect workspace channel limits.

Action Parameters

channel
string

Action Response

data
object
error
successful
boolean
Permanently revokes the currently authenticated access token, for use cases such as user logout or if a token is suspected to be compromised; the `test` request parameter allows simulating revocation.

Action Parameters

test
boolean

Action Response

data
object
error
successful
boolean
Revokes a slack file's public url, making it private; this is a no-op if not already public and is irreversible.

Action Parameters

file
string

Action Response

data
object
error
successful
boolean
Schedules a message to a slack channel, dm, or private group for a future time (`post at`), requiring `text`, `blocks`, or `attachments` for content; scheduling is limited to 120 days in advance.

Action Parameters

as_user
boolean
attachments
string
blocks
string
channel
string
link_names
boolean
parse
string
post_at
string
reply_broadcast
boolean
text
string
thread_ts
integer
unfurl_links
boolean
unfurl_media
boolean

Action Response

data
object
error
successful
boolean
Searches for channels available to an administrator within a slack enterprise grid organization.

Action Parameters

cursor
string
limit
integer
query
string
search_channel_types
string
sort
string
sort_dir
string
team_ids
string

Action Response

data
object
error
successful
boolean
Searches messages in a slack workspace using a query with optional modifiers (e.g., `in:`, `from:`, `has:`, `before:`) across accessible channels, dms, and private groups.

Action Parameters

count
integerDefaults to 1
highlight
boolean
page
integer
query
stringRequired
sort
string
sort_dir
string

Action Response

data
object
error
successful
boolean
Deprecated: searches messages in a slack workspace; use `search for messages with query` for current functionality.

Action Parameters

count
integerDefaults to 1
highlight
boolean
page
integer
query
stringRequired
sort
string
sort_dir
string

Action Response

data
object
error
successful
boolean
Posts a message to a slack channel, direct message, or private group; requires content via `text`, `blocks`, or `attachments`.

Action Parameters

as_user
boolean
attachments
string
blocks
string
channel
stringRequired
icon_emoji
string
icon_url
string
link_names
boolean
mrkdwn
boolean
parse
string
reply_broadcast
boolean
text
string
thread_ts
string
unfurl_links
boolean
unfurl_media
boolean
username
string

Action Response

data
object
error
successful
boolean
Sends a temporary, private message, visible only to a specified user within a channel, where the user must be a member of the channel; if posting as a bot (`as user` is false), the bot also must be a member.

Action Parameters

as_user
boolean
attachments
string
blocks
string
channel
stringRequired
icon_emoji
string
icon_url
string
link_names
boolean
parse
string
text
string
thread_ts
string
user
stringRequired
username
string

Action Response

data
object
error
successful
boolean
Sets the purpose (a short description of its topic/goal, displayed in the header) for a slack conversation; the calling user must be a member.

Action Parameters

channel
string
purpose
string

Action Response

data
object
error
successful
boolean
Sets posting permissions and other preferences for a slack channel via a stringified json object.

Action Parameters

channel_id
stringRequired
prefs
stringRequired

Action Response

data
object
error
successful
boolean
Sets a future expiration unix timestamp for a guest user's account; not applicable to regular members.

Action Parameters

expiration_ts
integerRequired
team_id
stringRequired
user_id
stringRequired

Action Response

data
object
error
successful
boolean
Marks a message, specified by its timestamp (`ts`), as the most recently read for the authenticated user in the given `channel`, provided the user is a member of the channel and the message exists within it.

Action Parameters

channel
string
ts
integer

Action Response

data
object
error
successful
boolean
Updates a slack user's profile, setting either individual fields or multiple fields via a json object.

Action Parameters

name
string
profile
string
user
string
value
string

Action Response

data
object
error
successful
boolean
Sets or updates the topic for a specified slack conversation.

Action Parameters

channel
string
topic
string

Action Response

data
object
error
successful
boolean
Sets a user's slack profile photo using an image file (required); if cropping, `crop x`, `crop y`, and `crop w` must all be specified.

Action Parameters

crop_w
string
crop_x
string
crop_y
string
image
string
token
stringRequired

Action Response

data
object
error
successful
boolean
Sets a user to 'regular' in a slack enterprise grid workspace, typically to downgrade from an elevated role; the api does not return the user's previous role.

Action Parameters

team_id
stringRequired
user_id
stringRequired

Action Response

data
object
error
successful
boolean
Shares a channel with specified workspaces (using `target team ids`) or converts it to an organization-wide channel (if `org channel` is true, `target team ids` must not be provided) in a slack enterprise grid.

Action Parameters

channel_id
stringRequired
org_channel
boolean
target_team_ids
string
team_id
string

Action Response

data
object
error
successful
boolean
Sets default public channels for new members in a slack workspace; channels must be existing and within this workspace.

Action Parameters

channel_ids
stringRequired
team_id
stringRequired
token
stringRequired

Action Response

data
object
error
successful
boolean
Updates the description for a specified slack workspace, overwriting any existing description.

Action Parameters

description
stringRequired
team_id
stringRequired

Action Response

data
object
error
successful
boolean
Sets the discoverability for a slack workspace within an enterprise grid organization.

Action Parameters

discoverability
stringRequired
team_id
stringRequired

Action Response

data
object
error
successful
boolean
Sets or updates the icon for a specific slack workspace within an enterprise grid organization.

Action Parameters

image_url
stringRequired
team_id
stringRequired
token
stringRequired

Action Response

data
object
error
successful
boolean
Updates the name of a slack workspace for a given `team id`; the `team id` must refer to a valid and existing slack workspace.

Action Parameters

name
stringRequired
team_id
stringRequired

Action Response

data
object
error
successful
boolean
Sends a 'me message' (e.g., '/me is typing') to a slack channel, where it's displayed as a third-person user action; messages are plain text and the channel must exist and be accessible.

Action Parameters

channel
string
text
string

Action Response

data
object
error
successful
boolean
Shares a remote file, which must already be registered with slack, into specified slack channels or direct message conversations.

Action Parameters

channels
string
external_id
string
file
string

Action Response

data
object
error
successful
boolean
Initiates a slack rtm session providing a single-use websocket url (valid 30s) for event streaming; does not set initial presence status.

Action Parameters

batch_presence_aware
boolean
presence_sub
boolean

Action Response

data
object
error
successful
boolean
Displays a permissions modal to a specified slack user to request additional user-level oauth scopes for the app, requiring a valid `trigger id` from a recent user interaction.

Action Parameters

scopes
stringRequired
trigger_id
stringRequired
user
stringRequired

Action Response

data
object
error
successful
boolean
Unarchives a specified public or private slack channel that is currently archived, using its channel id.

Action Parameters

channel_id
stringRequired

Action Response

data
object
error
successful
boolean
Uninstalls a currently installed slack app from a workspace or enterprise organization by revoking all its tokens; this action is irreversible.

Action Parameters

client_id
string
client_secret
string

Action Response

data
object
error
successful
boolean
Unpins a message, identified by its timestamp, from a specified channel if the message is currently pinned there; this operation is destructive.

Action Parameters

channel
stringRequired
timestamp
string

Action Response

data
object
error
successful
boolean
Updates metadata or content details for an existing remote file in slack; this action cannot upload new files or change the fundamental file type.

Action Parameters

external_id
string
external_url
string
file
string
filetype
string
indexable_file_contents
string
preview_image
string
title
string
token
string

Action Response

data
object
error
successful
boolean
Updates a slack message, identified by `channel` id and `ts` timestamp, by modifying its `text`, `attachments`, or `blocks`; provide at least one content field, noting `attachments`/`blocks` are replaced if included (`[]` clears them).

Action Parameters

as_user
string
attachments
string
blocks
string
channel
stringRequired
link_names
string
parse
string
text
string
ts
stringRequired

Action Response

data
object
error
successful
boolean
Updates an existing slack user group, which must be specified by an existing `usergroup` id, with new optional details such as its name, description, handle, or default channels.

Action Parameters

channels
string
description
string
handle
string
include_count
boolean
name
string
usergroup
stringRequired

Action Response

data
object
error
successful
boolean
Updates an existing slack view (e.g., a modal or home tab) with a new view definition.

Action Parameters

external_id
string
hash
string
view
string
view_id
string

Action Response

data
object
error
successful
boolean
Updates the title, join url, or desktop app join url for an existing slack call identified by its id.

Action Parameters

desktop_app_join_url
string
id
stringRequired
join_url
string
title
string

Action Response

data
object
error
successful
boolean
Replaces all members of an existing slack user group with a new list of valid user ids.

Action Parameters

include_count
boolean
usergroup
stringRequired
users
stringRequired

Action Response

data
object
error
successful
boolean
Updates a slack workflow step's configuration (inputs, outputs, name, or image) using `workflow step edit id` from a `view submission` payload; `inputs` and `outputs` must be valid json strings conforming to slack's structure if provided.

Action Parameters

inputs
string
outputs
string
step_image_url
string
step_name
string
workflow_step_edit_id
stringRequired

Action Response

data
object
error
successful
boolean
Uploads a file to slack, requiring either `content` (for text) or `file` (for binary data), optionally sharing it in specified `channels` or as a reply via `thread ts`.

Action Parameters

channels
string
content
string
file
string
filename
string
filetype
string
initial_comment
string
thread_ts
integer
title
string
token
string

Action Response

data
object
error
successful
boolean
Fetches detailed information (excluding message history or channel memberships) for a specific slack user; deprecated, use retrieve detailed user information.

Action Parameters

include_locale
boolean
user
string

Action Response

data
object
error
successful
boolean
**deprecated.** retrieves all users in a slack workspace; use `list all slack team users with pagination` instead for current functionality and pagination.

Action Parameters

cursor
string
include_locale
boolean
limit
integerDefaults to 1

Action Response

data
object
error
successful
boolean
**deprecated: use `find user by email address` instead.** retrieves the slack user object for an active user by their registered email address; fails with 'users not found' if the email is unregistered or the user is inactive.

Action Parameters

email
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: use `retrieve user profile information`. retrieves profile information for a slack user (defaults to authenticated user if `user` id is omitted); a provided `user` id must be valid.

Action Parameters

include_labels
boolean
user
string

Action Response

data
object
error
successful
boolean
Invalidates a slack user's active sessions (user id must exist) forcing re-authentication: set `mobile only=true` to target mobile, `web only=true` for web, both flags for both types, or neither (or both false) to wipe all sessions.

Action Parameters

mobile_only
boolean
user_id
stringRequired
web_only
boolean

Action Response

data
object
error
successful
boolean