Net::Async::Slack::Commands - supported API methods for Net::Async::Slack
These are available on the top-level Net::Async::Slack instance, and are autogenerated from the API specification.
Approve an app for installation on a workspace.
API method documentation
Takes the following named parameters:
app_id - The id of the app to approve. (string, optional)
app_id
request_id - The id of the request to approve. (string, optional)
request_id
team_id - (string, optional)
team_id
Resolves to a structure representing the response.
List approved apps for an org or workspace.
limit - The maximum number of items to return. Must be between 1 - 1000 both inclusive. (integer, optional)
limit
cursor - Set `cursor` to `next_cursor` returned by the previous call to list items in the next page (string, optional)
cursor
enterprise_id - (string, optional)
enterprise_id
List app requests for a team/workspace.
Restrict an app for installation on a workspace.
app_id - The id of the app to restrict. (string, optional)
request_id - The id of the request to restrict. (string, optional)
List restricted apps for an org or workspace.
Archive a public or private channel.
channel_id - The channel to archive. (string, required)
channel_id
Convert a public channel to a private channel.
channel_id - The channel to convert to private. (string, required)
Create a public or private channel-based conversation.
name - Name of the public or private channel to create. (string, required)
name
description - Description of the public or private channel to create. (string, optional)
description
is_private - When `true`, creates a private channel instead of a public channel (boolean, required)
is_private
org_wide - When `true`, the channel will be available org-wide. Note: if the channel is not `org_wide=true`, you must specify a `team_id` for this channel (boolean, optional)
org_wide
team_id - The workspace to create the channel in. Note: this argument is required unless you set `org_wide=true`. (string, optional)
Delete a public or private channel.
channel_id - The channel to delete. (string, required)
Disconnect a connected channel from one or more workspaces.
channel_id - The channel to be disconnected from some workspaces. (string, required)
leaving_team_ids - The team to be removed from the channel. Currently only a single team id can be specified. (string, optional)
leaving_team_ids
List all disconnected channels—i.e., channels that were once connected to other workspaces and then disconnected—and the corresponding original channel IDs for key revocation with EKM.
channel_ids - A comma-separated list of channels to filter to. (string, optional)
channel_ids
team_ids - A comma-separated list of the workspaces to which the channels you would like returned belong. (string, optional)
team_ids
cursor - Set `cursor` to `next_cursor` returned by the previous call to list items in the next page. (string, optional)
Get conversation preferences for a public or private channel.
channel_id - The channel to get preferences for. (string, required)
Get all the workspaces a given public or private channel is connected to within this Enterprise org.
channel_id - The channel to determine connected workspaces within the organization for. (string, required)
Invite a user to a public or private channel.
user_ids - The users to invite. (string, required)
user_ids
channel_id - The channel that the users will be invited to. (string, required)
Rename a public or private channel.
channel_id - The channel to rename. (string, required)
name - (string, required)
Add an allowlist of IDP groups for accessing a channel
team_id - The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization. (string, optional)
group_id - The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID to be an allowlist for the private channel. (string, required)
group_id
channel_id - The channel to link this group to. (string, required)
List all IDP Groups linked to a channel
channel_id - (string, required)
Remove a linked IDP group linked from a private channel
team_id - The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization. (string, required)
group_id - The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID to remove from the private channel. (string, required)
channel_id - The channel to remove the linked group from. (string, required)
Search for public or private channels in an Enterprise organization.
team_ids - Comma separated string of team IDs, signifying the workspaces to search through. (string, optional)
query - Name of the the channel to query by. (string, optional)
query
limit - Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10. (integer, optional)
search_channel_types - The type of channel to include or exclude in the search. For example `private` will search private channels, while `private_exclude` will exclude them. For a full list of types, check the [Types section](#types). (string, optional)
search_channel_types
sort - Possible values are `relevant` (search ranking based on what we think is closest), `name` (alphabetical), `member_count` (number of users in the channel), and `created` (date channel was created). You can optionally pair this with the `sort_dir` arg to change how it is sorted (string, optional)
sort
sort_dir - Sort direction. Possible values are `asc` for ascending order like (1, 2, 3) or (a, b, c), and `desc` for descending order like (3, 2, 1) or (c, b, a) (string, optional)
sort_dir
Set the posting permissions for a public or private channel.
channel_id - The channel to set the prefs for (string, required)
prefs - The prefs for this channel in a stringified JSON format. (string, required)
prefs
Set the workspaces in an Enterprise grid org that connect to a public or private channel.
channel_id - The encoded `channel_id` to add or remove to workspaces. (string, required)
team_id - The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel. (string, optional)
target_team_ids - A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide. (string, optional)
target_team_ids
org_channel - True if channel has to be converted to an org channel (boolean, optional)
org_channel
Unarchive a public or private channel.
channel_id - The channel to unarchive. (string, required)
Add an emoji.
name - The name of the emoji to be removed. Colons (`:myemoji:`) around the value are not required, although they may be included. (string, required)
url - The URL of a file to use as an image for the emoji. Square images under 128KB and with transparent backgrounds work best. (string, required)
url
Add an emoji alias.
name - The name of the emoji to be aliased. Colons (`:myemoji:`) around the value are not required, although they may be included. (string, required)
alias_for - The alias of the emoji. (string, required)
alias_for
List emoji for an Enterprise Grid organization.
Remove an emoji across an Enterprise Grid organization
Rename an emoji.
name - The name of the emoji to be renamed. Colons (`:myemoji:`) around the value are not required, although they may be included. (string, required)
new_name - The new name of the emoji. (string, required)
new_name
Approve a workspace invite request.
team_id - ID for the workspace where the invite request was made. (string, optional)
invite_request_id - ID of the request to invite. (string, required)
invite_request_id
List all approved workspace invite requests.
team_id - ID for the workspace where the invite requests were made. (string, optional)
cursor - Value of the `next_cursor` field sent as part of the previous API response (string, optional)
limit - The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive (integer, optional)
List all denied workspace invite requests.
limit - The number of results that will be returned by the API on each invocation. Must be between 1 - 1000 both inclusive (integer, optional)
Deny a workspace invite request.
List all pending workspace invite requests.
List all of the admins on a given workspace.
limit - The maximum number of items to return. (integer, optional)
team_id - (string, required)
Create an Enterprise team.
team_domain - Team domain (for example, slacksoftballteam). (string, required)
team_domain
team_name - Team name (for example, Slack Softball Team). (string, required)
team_name
team_description - Description for the team. (string, optional)
team_description
team_discoverability - Who can join the team. A team's discoverability can be `open`, `closed`, `invite_only`, or `unlisted`. (string, optional)
team_discoverability
List all teams on an Enterprise organization
limit - The maximum number of items to return. Must be between 1 - 100 both inclusive. (integer, optional)
List all of the owners on a given workspace.
Fetch information about settings in a workspace
Set the default channels of a workspace.
team_id - ID for the workspace to set the default channel for. (string, required)
channel_ids - An array of channel IDs. (string, required)
Set the description of a given workspace.
team_id - ID for the workspace to set the description for. (string, required)
description - The new description for the workspace. (string, required)
An API method that allows admins to set the discoverability of a given workspace
team_id - The ID of the workspace to set discoverability on. (string, required)
discoverability - This workspace's discovery setting. It must be set to one of `open`, `invite_only`, `closed`, or `unlisted`. (string, required)
discoverability
Sets the icon of a workspace.
image_url - Image URL for the icon (string, required)
image_url
team_id - ID for the workspace to set the icon for. (string, required)
Set the name of a given workspace.
team_id - ID for the workspace to set the name for. (string, required)
name - The new name of the workspace. (string, required)
Add one or more default channels to an IDP group.
usergroup_id - ID of the IDP group to add default channels for. (string, required)
usergroup_id
team_id - The workspace to add default channels in. (string, optional)
channel_ids - Comma separated string of channel IDs. (string, required)
Associate one or more default workspaces with an organization-wide IDP group.
usergroup_id - An encoded usergroup (IDP Group) ID. (string, required)
team_ids - A comma separated list of encoded team (workspace) IDs. Each workspace *MUST* belong to the organization associated with the token. (string, required)
auto_provision - When `true`, this method automatically creates new workspace accounts for the IDP group members. (boolean, optional)
auto_provision
List the channels linked to an org-level IDP group (user group).
usergroup_id - ID of the IDP group to list default channels for. (string, required)
team_id - ID of the the workspace. (string, optional)
include_num_members - Flag to include or exclude the count of members per channel. (boolean, optional)
include_num_members
Remove one or more default channels from an org-level IDP group (user group).
usergroup_id - ID of the IDP Group (string, required)
channel_ids - Comma-separated string of channel IDs (string, required)
Add an Enterprise user to a workspace.
team_id - The ID (`T1234`) of the workspace. (string, required)
user_id - The ID of the user to add to the workspace. (string, required)
user_id
is_restricted - True if user should be added to the workspace as a guest. (boolean, optional)
is_restricted
is_ultra_restricted - True if user should be added to the workspace as a single-channel guest. (boolean, optional)
is_ultra_restricted
channel_ids - Comma separated values of channel IDs to add user in the new workspace. (string, optional)
Invite a user to a workspace.
email - The email address of the person to invite. (string, required)
email
channel_ids - A comma-separated list of `channel_id`s for this user to join. At least one channel is required. (string, required)
custom_message - An optional message to send to the user in the invite email. (string, optional)
custom_message
real_name - Full name of the user. (string, optional)
real_name
resend - Allow this invite to be resent in the future if a user has not signed up yet. (default: false) (boolean, optional)
resend
is_restricted - Is this user a multi-channel guest user? (default: false) (boolean, optional)
is_ultra_restricted - Is this user a single channel guest user? (default: false) (boolean, optional)
guest_expiration_ts - Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date. (string, optional)
guest_expiration_ts
List users on a workspace
limit - Limit for how many users to be retrieved per page (integer, optional)
Remove a user from a workspace.
user_id - The ID of the user to remove. (string, required)
Invalidate a single session for a user by session_id
team_id - ID of the team that the session belongs to (string, required)
session_id - (integer, required)
session_id
Wipes all valid sessions on all devices for a given user
user_id - The ID of the user to wipe sessions for (string, required)
mobile_only - Only expire mobile sessions (default: false) (boolean, optional)
mobile_only
web_only - Only expire web sessions (default: false) (boolean, optional)
web_only
Set an existing guest, regular user, or owner to be an admin user.
user_id - The ID of the user to designate as an admin. (string, required)
Set an expiration for a guest user
user_id - The ID of the user to set an expiration for. (string, required)
expiration_ts - Timestamp when guest account should be disabled. (integer, required)
expiration_ts
Set an existing guest, regular user, or admin user to be a workspace owner.
user_id - Id of the user to promote to owner. (string, required)
Set an existing guest user, admin user, or owner to be a regular user.
user_id - The ID of the user to designate as a regular user. (string, required)
Checks API calling code.
error - Error response to return (string, optional)
error
foo - example property to return (string, optional)
foo
Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.
event_context - (string, required)
event_context
cursor - (string, optional)
limit - (integer, optional)
Returns list of permissions this app has on a team.
Allows an app to request additional scopes
scopes - A comma separated list of scopes to request for (string, required)
scopes
trigger_id - Token used to trigger the permissions API (string, required)
trigger_id
Returns list of resource grants this app has on a team.
cursor - Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail. (string, optional)
Returns list of scopes this app has on a team.
Returns list of user grants and corresponding scopes this app has on a team.
Enables an app to trigger a permissions modal to grant an app access to a user access scope.
scopes - A comma separated list of user scopes to request for (string, required)
trigger_id - Token used to trigger the request (string, required)
user - The user this scope is being requested for (string, required)
user
Uninstalls your app from a workspace.
client_id - Issued when you created your application. (string, optional)
client_id
client_secret - Issued when you created your application. (string, optional)
client_secret
Revokes a token.
test - Setting this parameter to `1` triggers a _testing mode_ where the specified token will not actually be revoked. (boolean, optional)
test
Checks authentication & identity.
Gets information about a bot user.
bot - Bot user to get info on (string, optional)
bot
Registers a new Call.
external_unique_id - An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service. (string, required)
external_unique_id
external_display_id - An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object. (string, optional)
external_display_id
join_url - The URL required for a client to join the Call. (string, required)
join_url
desktop_app_join_url - When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL. (string, optional)
desktop_app_join_url
date_start - Call start time in UTC UNIX timestamp format (integer, optional)
date_start
title - The name of the Call. (string, optional)
title
created_by - The valid Slack user ID of the user who created this Call. When this method is called with a user token, the `created_by` field is optional and defaults to the authed user of the token. Otherwise, the field is required. (string, optional)
created_by
users - The list of users to register as participants in the Call. [Read more on how to specify users here](/apis/calls#users). (string, optional)
users
Ends a Call.
id - `id` returned when registering the call using the [`calls.add`](/methods/calls.add) method. (string, required)
id
duration - Call duration in seconds (integer, optional)
duration
Returns information about a Call.
id - `id` of the Call returned by the [`calls.add`](/methods/calls.add) method. (string, required)
Registers new participants added to a Call.
id - `id` returned by the [`calls.add`](/methods/calls.add) method. (string, required)
users - The list of users to add as participants in the Call. [Read more on how to specify users here](/apis/calls#users). (string, required)
Registers participants removed from a Call.
users - The list of users to remove as participants in the Call. [Read more on how to specify users here](/apis/calls#users). (string, required)
Updates information about a Call.
join_url - The URL required for a client to join the Call. (string, optional)
Deletes a message.
ts - Timestamp of the message to be deleted. (number, optional)
ts
channel - Channel containing the message to be deleted. (string, optional)
channel
as_user - Pass true to delete the message as the authed user with `chat:write:user` scope. [Bot users](/bot-users) in this context are considered authed users. If unused or false, the message will be deleted with `chat:write:bot` scope. (boolean, optional)
as_user
Deletes a pending scheduled message from the queue.
channel - The channel the scheduled_message is posting to (string, required)
scheduled_message_id - `scheduled_message_id` returned from call to chat.scheduleMessage (string, required)
scheduled_message_id
Retrieve a permalink URL for a specific extant message
channel - The ID of the conversation or channel containing the message (string, required)
message_ts - A message's `ts` value, uniquely identifying it within a channel (string, required)
message_ts
Share a me message into a channel.
channel - Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name. (string, optional)
text - Text of the message to send. (string, optional)
text
Sends an ephemeral message to a user in a channel.
as_user - Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false. (boolean, optional)
attachments - A JSON-based array of structured attachments, presented as a URL-encoded string. (string, optional)
attachments
blocks - A JSON-based array of structured blocks, presented as a URL-encoded string. (string, optional)
blocks
channel - Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. (string, required)
icon_emoji - Emoji to use as the icon for this message. Overrides `icon_url`. Must be used in conjunction with `as_user` set to `false`, otherwise ignored. See [authorship](#authorship) below. (string, optional)
icon_emoji
icon_url - URL to an image to use as the icon for this message. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below. (string, optional)
icon_url
link_names - Find and link channel names and usernames. (boolean, optional)
link_names
parse - Change how messages are treated. Defaults to `none`. See [below](#formatting). (string, optional)
parse
text - How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail. (string, optional)
thread_ts - Provide another message's `ts` value to post this message in a thread. Avoid using a reply's `ts` value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread. (string, optional)
thread_ts
user - `id` of the user who will receive the ephemeral message. The user should be in the channel specified by the `channel` argument. (string, required)
username - Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below. (string, optional)
username
Sends a message to a channel.
as_user - Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [authorship](#authorship) below. (string, optional)
channel - Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details. (string, required)
mrkdwn - Disable Slack markup parsing by setting to `false`. Enabled by default. (boolean, optional)
mrkdwn
reply_broadcast - Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`. (boolean, optional)
reply_broadcast
thread_ts - Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead. (string, optional)
unfurl_links - Pass true to enable unfurling of primarily text-based content. (boolean, optional)
unfurl_links
unfurl_media - Pass false to disable unfurling of media content. (boolean, optional)
unfurl_media
Schedules a message to be sent to a channel.
channel - Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details. (string, optional)
post_at - Unix EPOCH timestamp of time in future to send the message. (string, optional)
post_at
parse - Change how messages are treated. Defaults to `none`. See [chat.postMessage](chat.postMessage#formatting). (string, optional)
as_user - Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [chat.postMessage](chat.postMessage#authorship). (boolean, optional)
thread_ts - Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead. (number, optional)
Returns a list of scheduled messages.
channel - The channel of the scheduled messages (string, optional)
latest - A UNIX timestamp of the latest value in the time range (number, optional)
latest
oldest - A UNIX timestamp of the oldest value in the time range (number, optional)
oldest
limit - Maximum number of original entries to return. (integer, optional)
cursor - For pagination purposes, this is the `cursor` value returned from a previous call to `chat.scheduledmessages.list` indicating where you want to start this call from. (string, optional)
Provide custom unfurl behavior for user-posted URLs
channel - Channel ID of the message (string, required)
ts - Timestamp of the message to add unfurl behavior to. (string, required)
unfurls - URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments. (string, optional)
unfurls
user_auth_message - Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior (string, optional)
user_auth_message
user_auth_required - Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domain (boolean, optional)
user_auth_required
user_auth_url - Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded. (string, optional)
user_auth_url
Updates a message.
as_user - Pass true to update the message as the authed user. [Bot users](/bot-users) in this context are considered authed users. (string, optional)
attachments - A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting `text`. If you don't include this field, the message's previous `attachments` will be retained. To remove previous `attachments`, include an empty array for this field. (string, optional)
blocks - A JSON-based array of [structured blocks](/block-kit/building), presented as a URL-encoded string. If you don't include this field, the message's previous `blocks` will be retained. To remove previous `blocks`, include an empty array for this field. (string, optional)
channel - Channel containing the message to be updated. (string, required)
link_names - Find and link channel names and usernames. Defaults to `none`. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, `none`. (string, optional)
parse - Change how messages are treated. Defaults to `client`, unlike `chat.postMessage`. Accepts either `none` or `full`. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, `client`. (string, optional)
text - New text for the message, using the [default formatting rules](/reference/surfaces/formatting). It's not required when presenting `blocks` or `attachments`. (string, optional)
ts - Timestamp of the message to be updated. (string, required)
Archives a conversation.
channel - ID of conversation to archive (string, optional)
Closes a direct message or multi-person direct message.
channel - Conversation to close. (string, optional)
Initiates a public or private channel-based conversation
name - Name of the public or private channel to create (string, optional)
is_private - Create a private channel instead of a public one (boolean, optional)
Fetches a conversation's history of messages and events.
channel - Conversation ID to fetch history for. (string, optional)
latest - End of time range of messages to include in results. (number, optional)
oldest - Start of time range of messages to include in results. (number, optional)
inclusive - Include messages with latest or oldest timestamp in results only when either timestamp is specified. (boolean, optional)
inclusive
limit - 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. (integer, optional)
Retrieve information about a conversation.
channel - Conversation ID to learn more about (string, optional)
include_locale - Set this to `true` to receive the locale for this conversation. Defaults to `false` (boolean, optional)
include_locale
include_num_members - Set to `true` to include the member count for the specified conversation. Defaults to `false` (boolean, optional)
Invites users to a channel.
channel - The ID of the public or private channel to invite user(s) to. (string, optional)
users - A comma separated list of user IDs. Up to 1000 users may be listed. (string, optional)
Joins an existing conversation.
channel - ID of conversation to join (string, optional)
Removes a user from a conversation.
channel - ID of conversation to remove user from. (string, optional)
user - User ID to be removed. (string, optional)
Leaves a conversation.
channel - Conversation to leave (string, optional)
Lists all channels in a Slack team.
exclude_archived - Set to `true` to exclude archived channels from the list (boolean, optional)
exclude_archived
types - Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im` (string, optional)
types
limit - The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000. (integer, optional)
Sets the read cursor in a channel.
channel - Channel or conversation to set the read cursor for. (string, optional)
ts - Unique identifier of message you want marked as most recently seen in this conversation. (number, optional)
Retrieve members of a conversation.
channel - ID of the conversation to retrieve members for (string, optional)
Opens or resumes a direct message or multi-person direct message.
channel - Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead. (string, optional)
users - Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a `channel` when not supplying `users`. (string, optional)
return_im - Boolean, indicates you want the full IM channel definition in the response. (boolean, optional)
return_im
Renames a conversation.
channel - ID of conversation to rename (string, optional)
name - New name for conversation. (string, optional)
Retrieve a thread of messages posted to a conversation
channel - Conversation ID to fetch thread from. (string, optional)
ts - Unique identifier of a thread's parent message. `ts` must be the timestamp of an existing message with 0 or more replies. If there are no replies then just the single message referenced by `ts` will return - it is just an ordinary, unthreaded message. (number, optional)
Sets the purpose for a conversation.
channel - Conversation to set the purpose of (string, optional)
purpose - A new, specialer purpose (string, optional)
purpose
Sets the topic for a conversation.
channel - Conversation to set the topic of (string, optional)
topic - The new topic string. Does not support formatting or linkification. (string, optional)
topic
Reverses conversation archival.
channel - ID of conversation to unarchive (string, optional)
Open a dialog with a user
dialog - The dialog definition. This must be a JSON-encoded string. (string, required)
dialog
trigger_id - Exchange a trigger to post to the user. (string, required)
Ends the current user's Do Not Disturb session immediately.
Ends the current user's snooze mode immediately.
Retrieves a user's current Do Not Disturb status.
user - User to fetch status for (defaults to current user) (string, optional)
Turns on Do Not Disturb mode for the current user, or changes its duration.
num_minutes - Number of minutes, from now, to snooze until. (string, required)
num_minutes
Retrieves the Do Not Disturb status for up to 50 users on a team.
users - Comma-separated list of users to fetch Do Not Disturb status for (string, optional)
Lists custom emoji for a team.
Deletes an existing comment on a file.
file - File to delete a comment from. (string, optional)
file
id - The comment to delete. (string, optional)
Deletes a file.
file - ID of file to delete. (string, optional)
Gets information about a file.
file - Specify a file by providing its ID. (string, optional)
count - (string, optional)
count
page - (string, optional)
page
limit - The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. (integer, optional)
cursor - Parameter for pagination. File comments are paginated for a single file. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection of comments. See [pagination](/docs/pagination) for more details. (string, optional)
List for a team, in a channel, or from a user with applied filters.
user - Filter files created by a single user. (string, optional)
channel - Filter files appearing in a specific channel, indicated by its ID. (string, optional)
ts_from - Filter files created after this timestamp (inclusive). (number, optional)
ts_from
ts_to - Filter files created before this timestamp (inclusive). (number, optional)
ts_to
types - Filter files by type ([see below](#file_types)). You can pass multiple values in the types argument, like `types=spaces,snippets`.The default value is `all`, which does not filter the list. (string, optional)
show_files_hidden_by_limit - Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit. (boolean, optional)
show_files_hidden_by_limit
Adds a file from a remote service
external_id - Creator defined GUID for the file. (string, optional)
external_id
title - Title of the file being shared. (string, optional)
filetype - type of file (string, optional)
filetype
external_url - URL of the remote file. (string, optional)
external_url
preview_image - Preview of the document via `multipart/form-data`. (string, optional)
preview_image
indexable_file_contents - A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file. (string, optional)
indexable_file_contents
Retrieve information about a remote file added to Slack
Remove a remote file.
Share a remote file into a channel.
file - Specify a file registered with Slack by providing its ID. Either this field or `external_id` or both are required. (string, optional)
external_id - The globally unique identifier (GUID) for the file, as set by the app registering the file with Slack. Either this field or `file` or both are required. (string, optional)
channels - Comma-separated list of channel IDs where the file will be shared. (string, optional)
channels
Updates an existing remote file.
indexable_file_contents - File containing contents that can be used to improve searchability for the remote file. (string, optional)
Revokes public/external sharing access for a file
file - File to revoke (string, optional)
Enables a file for public/external sharing.
file - File to share (string, optional)
For Enterprise Grid workspaces, map local user IDs to global user IDs
users - A comma-separated list of user ids, up to 400 per request (string, required)
team_id - Specify team_id starts with `T` in case of Org Token (string, optional)
to_old - Specify `true` to convert `W` global user IDs to workspace-specific `U` IDs. Defaults to `false`. (boolean, optional)
to_old
Exchanges a temporary OAuth verifier code for an access token.
code - The `code` param returned via the OAuth callback. (string, optional)
code
redirect_uri - This must match the originally submitted URI (if one was sent). (string, optional)
redirect_uri
single_channel - Request the user to add your app only to a single channel. Only valid with a [legacy workspace app](https://api.slack.com/legacy-workspace-apps). (boolean, optional)
single_channel
Exchanges a temporary OAuth verifier code for a workspace token.
single_channel - Request the user to add your app only to a single channel. (boolean, optional)
code - The `code` param returned via the OAuth callback. (string, required)
Pins an item to a channel.
channel - Channel to pin the item in. (string, required)
timestamp - Timestamp of the message to pin. (string, optional)
timestamp
Lists items pinned to a channel.
channel - Channel to get pinned items for. (string, required)
Un-pins an item from a channel.
channel - Channel where the item is pinned to. (string, required)
timestamp - Timestamp of the message to un-pin. (string, optional)
Adds a reaction to an item.
channel - Channel where the message to add reaction to was posted. (string, required)
name - Reaction (emoji) name. (string, required)
timestamp - Timestamp of the message to add reaction to. (string, required)
Gets reactions for an item.
channel - Channel where the message to get reactions for was posted. (string, optional)
file - File to get reactions for. (string, optional)
file_comment - File comment to get reactions for. (string, optional)
file_comment
full - If true always return the complete reaction list. (boolean, optional)
full
timestamp - Timestamp of the message to get reactions for. (string, optional)
Lists reactions made by a user.
user - Show reactions made by this user. Defaults to the authed user. (string, optional)
count - (integer, optional)
page - (integer, optional)
cursor - Parameter for pagination. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See [pagination](/docs/pagination) for more details. (string, optional)
Removes a reaction from an item.
file - File to remove reaction from. (string, optional)
file_comment - File comment to remove reaction from. (string, optional)
channel - Channel where the message to remove reaction from was posted. (string, optional)
timestamp - Timestamp of the message to remove reaction from. (string, optional)
Creates a reminder.
text - The content of the reminder (string, required)
time - When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday") (string, required)
time
user - The user who will receive the reminder. If no user is specified, the reminder will go to user who created it. (string, optional)
Marks a reminder as complete.
reminder - The ID of the reminder to be marked as complete (string, optional)
reminder
Deletes a reminder.
reminder - The ID of the reminder (string, optional)
Gets information about a reminder.
Lists all reminders created by or for a given user.
Starts a Real Time Messaging session.
batch_presence_aware - Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See [batch presence](/docs/presence-and-status#batching). (boolean, optional)
batch_presence_aware
presence_sub - Only deliver presence events when requested by subscription. See [presence subscriptions](/docs/presence-and-status#subscriptions). (boolean, optional)
presence_sub
Searches for messages matching a query.
count - Pass the number of results you want per "page". Maximum of `100`. (integer, optional)
highlight - Pass a value of `true` to enable query highlight markers (see below). (boolean, optional)
highlight
query - Search query. (string, required)
sort - Return matches sorted by either `score` or `timestamp`. (string, optional)
sort_dir - Change sort direction to ascending (`asc`) or descending (`desc`). (string, optional)
Adds a star to an item.
channel - Channel to add star to, or channel where the message to add star to was posted (used with `timestamp`). (string, optional)
file - File to add star to. (string, optional)
file_comment - File comment to add star to. (string, optional)
timestamp - Timestamp of the message to add star to. (string, optional)
Lists stars for a user.
Removes a star from an item.
channel - Channel to remove star from, or channel where the message to remove star from was posted (used with `timestamp`). (string, optional)
file - File to remove star from. (string, optional)
file_comment - File comment to remove star from. (string, optional)
timestamp - Timestamp of the message to remove star from. (string, optional)
Gets the access logs for the current team.
before - End of time range of logs to include in results (inclusive). (string, optional)
before
Gets billable users information for the current team.
user - A user to retrieve the billable information for. Defaults to all users. (string, optional)
Gets information about the current team.
team - Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels (string, optional)
team
Gets the integration logs for the current team.
app_id - Filter logs to this Slack app. Defaults to all logs. (string, optional)
change_type - Filter logs with this change type. Defaults to all logs. (string, optional)
change_type
service_id - Filter logs to this service. Defaults to all logs. (string, optional)
service_id
user - Filter logs generated by this user’s actions. Defaults to all logs. (string, optional)
Retrieve a team's profile.
visibility - Filter by visibility. (string, optional)
visibility
Create a User Group
channels - A comma separated string of encoded channel IDs for which the User Group uses as a default. (string, optional)
description - A short description of the User Group. (string, optional)
handle - A mention handle. Must be unique among channels, users and User Groups. (string, optional)
handle
include_count - Include the number of users in each User Group. (boolean, optional)
include_count
name - A name for the User Group. Must be unique among User Groups. (string, required)
Disable an existing User Group
include_count - Include the number of users in the User Group. (boolean, optional)
usergroup - The encoded ID of the User Group to disable. (string, required)
usergroup
Enable a User Group
usergroup - The encoded ID of the User Group to enable. (string, required)
List all User Groups for a team
include_users - Include the list of users for each User Group. (boolean, optional)
include_users
include_disabled - Include disabled User Groups. (boolean, optional)
include_disabled
Update an existing User Group
usergroup - The encoded ID of the User Group to update. (string, required)
name - A name for the User Group. Must be unique among User Groups. (string, optional)
List all users in a User Group
include_disabled - Allow results that involve disabled User Groups. (boolean, optional)
Update the list of users for a User Group
users - A comma separated string of encoded user IDs that represent the entire list of users for the User Group. (string, required)
List conversations the calling user may access.
user - Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership. (string, optional)
Delete the user profile photo
Gets user presence information.
user - User to get presence info on. Defaults to the authed user. (string, optional)
Get a user's identity.
Gets information about a user.
include_locale - Set this to `true` to receive the locale for this user. Defaults to `false` (boolean, optional)
user - User to get info on (string, optional)
Lists all users in a Slack team.
limit - 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. Providing no `limit` value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience `limit_required` or HTTP 500 errors. (integer, optional)
include_locale - Set this to `true` to receive the locale for users. Defaults to `false` (boolean, optional)
Find a user with an email address.
email - An email address belonging to a user in the workspace (string, required)
Retrieves a user's profile information.
include_labels - Include labels for each ID in custom profile fields (boolean, optional)
include_labels
user - User to retrieve profile info for (string, optional)
Set the profile information for a user.
name - Name of a single key to set. Usable only if `profile` is not passed. (string, optional)
profile - Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters. (string, optional)
profile
user - ID of user to change. This argument may only be specified by team admins on paid teams. (string, optional)
value - Value to set a single key to. Usable only if `profile` is not passed. (string, optional)
value
Marked a user as active. Deprecated and non-functional.
Set the user profile photo
crop_w - Width/height of crop box (always square) (string, optional)
crop_w
crop_x - X coordinate of top-left corner of crop box (string, optional)
crop_x
crop_y - Y coordinate of top-left corner of crop box (string, optional)
crop_y
image - File contents via `multipart/form-data`. (string, optional)
image
Manually sets user presence.
presence - Either `auto` or `away` (string, required)
presence
Open a view for a user.
view - A [view payload](/reference/surfaces/views). This must be a JSON-encoded string. (string, required)
view
Publish a static view for a User.
user_id - `id` of the user you want publish a view to. (string, required)
hash - A string that represents view state to protect against possible race conditions. (string, optional)
hash
Push a view onto the stack of a root view.
Update an existing view.
view_id - A unique identifier of the view to be updated. Either `view_id` or `external_id` is required. (string, optional)
view_id
external_id - A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either `view_id` or `external_id` is required. (string, optional)
view - A [view object](/reference/surfaces/views). This must be a JSON-encoded string. (string, optional)
Indicate that an app's step in a workflow completed execution.
workflow_step_execute_id - Context identifier that maps to the correct workflow step execution. (string, required)
workflow_step_execute_id
outputs - Key-value object of outputs from your step. Keys of this object reflect the configured `key` properties of your [`outputs`](/reference/workflows/workflow_step#output) array from your `workflow_step` object. (string, optional)
outputs
Indicate that an app's step in a workflow failed to execute.
error - A JSON-based object with a `message` property that should contain a human readable error message. (string, required)
Update the configuration for a workflow extension step.
workflow_step_edit_id - A context identifier provided with `view_submission` payloads used to call back to `workflows.updateStep`. (string, required)
workflow_step_edit_id
inputs - A JSON key-value map of inputs required from a user during configuration. This is the data your app expects to receive when the workflow step starts. **Please note**: the embedded variable format is set and replaced by the workflow system. You cannot create custom variables that will be replaced at runtime. [Read more about variables in workflow steps here](/workflows/steps#variables). (string, optional)
inputs
outputs - An JSON array of output objects used during step execution. This is the data your app agrees to provide when your workflow step was executed. (string, optional)
step_name - An optional field that can be used to override the step name that is shown in the Workflow Builder. (string, optional)
step_name
step_image_url - An optional field that can be used to override app image that is shown in the Workflow Builder. (string, optional)
step_image_url
To install Net::Async::Slack, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::Async::Slack
CPAN shell
perl -MCPAN -e shell install Net::Async::Slack
For more information on module installation, please visit the detailed CPAN module installation guide.