@datafire/slack

@datafire/slack

Client library for Slack

Installation and Usage

npm install --save datafire @datafire/slack

let datafire = require('datafire');
let slack = require('@datafire/slack').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: "",
});

slack.users_setPresence({}).then(data => {
  console.log(data);
})

Description

One way to interact with the Slack platform is its HTTP RPC-based Web API, a collection of methods requiring OAuth 2.0-based user, bot, or workspace tokens blessed with related OAuth scopes.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

slack.oauthCallback({
  "code": ""
}, context)

Parameters

• code (string) required

oauthRefresh

Exchange a refresh_token for an access_token

slack.oauthRefresh(null, context)

Parameters

This action has no parameters

api_test

Checks API calling code.

slack.api_test({}, context)

Parameters

• foo (string) - example property to return
• error (string) - Error response to return

apps_permissions_info

Returns list of permissions this app has on a team.

slack.apps_permissions_info({}, context)

Parameters

• token (string) - Authentication token. Requires scope: none

apps_permissions_request

Allows an app to request additional scopes

slack.apps_permissions_request({}, context)

Parameters

• scopes (string) - A comma separated list of scopes to request for
• token (string) - Authentication token. Requires scope: none
• trigger_id (string) - Token used to trigger the permissions API

auth_revoke

Revokes a token.

slack.auth_revoke({}, context)

Parameters

• test (boolean) - Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.
• token (string) - Authentication token. Requires scope: none

auth_test

Checks authentication & identity.

slack.auth_test({}, context)

Parameters

• token (string) - Authentication token. Requires scope: none

bots_info

Gets information about a bot user.

slack.bots_info({}, context)

Parameters

• token (string) - Authentication token. Requires scope: users:read
• bot (string) - Bot user to get info on

channels_archive

Archives a channel.

slack.channels_archive({}, context)

Parameters

• token (string) - Authentication token. Requires scope: channels:write
• channel (string) - Channel to archive

channels_create

Creates a channel.

slack.channels_create({}, context)

Parameters

• validate (boolean) - Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.
• token (string) - Authentication token. Requires scope: channels:write
• name (string) - Name of channel to create

channels_history

Fetches history of messages and events from a channel.

slack.channels_history({}, context)

Parameters

• count (integer) - Number of messages to return, between 1 and 1000.
• unreads (boolean) - Include unread_count_display in the output?
• inclusive (boolean) - Include messages with latest or oldest timestamp in results.
• token (string) - Authentication token. Requires scope: channels:history
• oldest (number) - Start of time range of messages to include in results.
• channel (string) - Channel to fetch history for.
• latest (number) - End of time range of messages to include in results.

channels_info

Gets information about a channel.

slack.channels_info({}, context)

Parameters

• token (string) - Authentication token. Requires scope: channels:read
• include_locale (boolean) - Set this to true to receive the locale for this channel. Defaults to false
• channel (string) - Channel to get info on

channels_invite

Invites a user to a channel.

slack.channels_invite({}, context)

Parameters

• token (string) - Authentication token. Requires scope: channels:write
• user (string) - User to invite to channel.
• channel (string) - Channel to invite user to.

channels_join

Joins a channel, creating it if needed.

slack.channels_join({}, context)

Parameters

• validate (boolean) - Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.
• token (string) - Authentication token. Requires scope: channels:write
• name (string) - Name of channel to join

channels_kick

Removes a user from a channel.

slack.channels_kick({}, context)

Parameters

• token (string) - Authentication token. Requires scope: channels:write
• user (string) - User to remove from channel.
• channel (string) - Channel to remove user from.

channels_leave

Leaves a channel.

slack.channels_leave({}, context)

Parameters

• token (string) - Authentication token. Requires scope: channels:write
• channel (string) - Channel to leave

channels_list

Lists all channels in a Slack team.

slack.channels_list({}, context)

Parameters

• exclude_members (boolean) - Exclude the members collection from each channel
• cursor (string) - 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 for more detail.
• token (string) - Authentication token. Requires scope: channels:read
• limit (integer) - 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.
• exclude_archived (boolean) - Exclude archived channels from the list

channels_mark

Sets the read cursor in a channel.

slack.channels_mark({}, context)

Parameters

• token (string) - Authentication token. Requires scope: channels:write
• ts (number) - Timestamp of the most recently seen message.
• channel (string) - Channel to set reading cursor in.

channels_rename

Renames a channel.

slack.channels_rename({}, context)

Parameters

• validate (boolean) - Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.
• token (string) - Authentication token. Requires scope: channels:write
• name (string) - New name for channel.
• channel (string) - Channel to rename

channels_replies

Retrieve a thread of messages posted to a channel

slack.channels_replies({}, context)

Parameters

• thread_ts (number) - Unique identifier of a thread's parent message
• token (string) - Authentication token. Requires scope: channels:history
• channel (string) - Channel to fetch thread from

channels_setPurpose

Sets the purpose for a channel.

slack.channels_setPurpose({}, context)

Parameters

• token (string) - Authentication token. Requires scope: channels:write
• purpose (string) - The new purpose
• channel (string) - Channel to set the purpose of

channels_setTopic

Sets the topic for a channel.

slack.channels_setTopic({}, context)

Parameters

• topic (string) - The new topic
• token (string) - Authentication token. Requires scope: channels:write
• channel (string) - Channel to set the topic of

channels_unarchive

Unarchives a channel.

slack.channels_unarchive({}, context)

Parameters

• token (string) - Authentication token. Requires scope: channels:write
• channel (string) - Channel to unarchive

chat_delete

Deletes a message.

slack.chat_delete({}, context)

Parameters

• as_user (boolean) - Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.
• token (string) - Authentication token. Requires scope: chat:write
• ts (number) - Timestamp of the message to be deleted.
• channel (string) - Channel containing the message to be deleted.

chat_meMessage

Share a me message into a channel.

slack.chat_meMessage({}, context)

Parameters

• text (string) - Text of the message to send.
• token (string) - Authentication token. Requires scope: chat:write:user
• channel (string) - Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.

chat_postEphemeral

Sends an ephemeral message to a user in a channel.

slack.chat_postEphemeral({}, context)

Parameters

• attachments (string) - A JSON-based array of structured attachments, presented as a URL-encoded string.
• text (string) - Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments instead.
• link_names (boolean) - Find and link channel names and usernames.
• parse (string) - Change how messages are treated. Defaults to none. See below.
• token (string) - Authentication token. Requires scope: chat:write
• user (string) - id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.
• as_user (boolean) - Pass true to post the message as the authed bot. Defaults to false.
• channel (string) - Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.

chat_postMessage

Sends a message to a channel.

slack.chat_postMessage({}, context)

Parameters

• username (string) - Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
• thread_ts (number) - Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
• attachments (string) - A JSON-based array of structured attachments, presented as a URL-encoded string.
• unfurl_links (boolean) - Pass true to enable unfurling of primarily text-based content.
• text (string) - Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments instead.
• unfurl_media (boolean) - Pass false to disable unfurling of media content.
• parse (string) - Change how messages are treated. Defaults to none. See below.
• as_user (boolean) - Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.
• token (string) - Authentication token. Requires scope: chat:write
• icon_emoji (string) - 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 below.
• link_names (boolean) - Find and link channel names and usernames.
• icon_url (string) - 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 below.
• channel (string) - Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.
• reply_broadcast (boolean) - Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.

chat_unfurl

Provide custom unfurl behavior for user-posted URLs

slack.chat_unfurl({}, context)

Parameters

• user_auth_message (string) - Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior
• user_auth_required (boolean) - Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain
• unfurls (string) - URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl message attachments.
• ts (string) - Timestamp of the message to add unfurl behavior to.
• user_auth_url (string) - Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.
• token (string) - Authentication token. Requires scope: links:write
• channel (string) - Channel ID of the message

chat_update

Updates a message.

slack.chat_update({}, context)

Parameters

• attachments (string) - A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text.
• text (string) - New text for the message, using the default formatting rules. It's not required when presenting attachments.
• ts (number) - Timestamp of the message to be updated.
• parse (string) - Change how messages are treated. Defaults to client, unlike chat.postMessage. See below.
• as_user (boolean) - Pass true to update the message as the authed user. Bot users in this context are considered authed users.
• token (string) - Authentication token. Requires scope: chat:write
• link_names (boolean) - Find and link channel names and usernames. Defaults to none. This parameter should be used in conjunction with parse. To set link_names to 1, specify a parse mode of full.
• channel (string) - Channel containing the message to be updated.

conversations_archive

Archives a conversation.

slack.conversations_archive({}, context)

Parameters

• token (string) - Authentication token. Requires scope: conversations:write
• channel (string) - ID of conversation to archive

conversations_close

Closes a direct message or multi-person direct message.

slack.conversations_close({}, context)

Parameters

• token (string) - Authentication token. Requires scope: conversations:write
• channel (string) - Conversation to close.

conversations_create

Initiates a public or private channel-based conversation

slack.conversations_create({}, context)

Parameters

• token (string) - Authentication token. Requires scope: conversations:write
• name (string) - Name of the public or private channel to create
• is_private (boolean) - Create a private channel instead of a public one

conversations_history

Fetches a conversation's history of messages and events.

slack.conversations_history({}, context)

Parameters

• cursor (string) - 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 for more detail.
• token (string) - Authentication token. Requires scope: conversations:history
• limit (integer) - 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.
• oldest (number) - Start of time range of messages to include in results.
• channel (string) - Conversation ID to fetch history for.
• latest (number) - End of time range of messages to include in results.

conversations_info

Retrieve information about a conversation.

slack.conversations_info({}, context)

Parameters

• token (string) - Authentication token. Requires scope: conversations:read
• channel (string) - Conversation ID to learn more about
• include_locale (boolean) - Set this to true to receive the locale for this conversation. Defaults to false

conversations_invite

Invites users to a channel.

slack.conversations_invite({}, context)

Parameters

• token (string) - Authentication token. Requires scope: conversations:write
• users (string) - A comma separated list of user IDs. Up to 30 users may be listed.
• channel (string) - The ID of the public or private channel to invite user(s) to.

conversations_join

Joins an existing conversation.

slack.conversations_join({}, context)

Parameters

• token (string) - Authentication token. Requires scope: channels:write
• channel (string) - ID of conversation to join

conversations_kick

Removes a user from a conversation.

slack.conversations_kick({}, context)

Parameters

• token (string) - Authentication token. Requires scope: conversations:write
• user (string) - User ID to be removed.
• channel (string) - ID of conversation to remove user from.

conversations_leave

Leaves a conversation.

slack.conversations_leave({}, context)

Parameters

• token (string) - Authentication token. Requires scope: conversations:write
• channel (string) - Conversation to leave

conversations_list

Lists all channels in a Slack team.

slack.conversations_list({}, context)

Parameters

• cursor (string) - 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 for more detail.
• token (string) - Authentication token. Requires scope: conversations:read
• exclude_archived (boolean) - Set to true to exclude archived channels from the list
• limit (integer) - 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.
• types (string) - Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im

conversations_members

Retrieve members of a conversation.

slack.conversations_members({}, context)

Parameters

• cursor (string) - 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 for more detail.
• token (string) - Authentication token. Requires scope: conversations:read
• limit (integer) - 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.
• channel (string) - ID of the conversation to retrieve members for

conversations_open

Opens or resumes a direct message or multi-person direct message.

slack.conversations_open({}, context)

Parameters

• token (string) - Authentication token. Requires scope: conversations:write
• return_im (boolean) - Boolean, indicates you want the full IM channel definition in the response.
• users (string) - 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.
• channel (string) - Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead.

conversations_rename

Renames a conversation.

slack.conversations_rename({}, context)

Parameters

• token (string) - Authentication token. Requires scope: conversations:write
• name (string) - New name for conversation.
• channel (string) - ID of conversation to rename

conversations_replies

Retrieve a thread of messages posted to a conversation

slack.conversations_replies({}, context)

Parameters

• ts (number) - Unique identifier of a thread's parent message
• cursor (string) - 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 for more detail.
• token (string) - Authentication token. Requires scope: conversations:history
• limit (integer) - 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.
• channel (string) - Conversation ID to fetch thread from

conversations_setPurpose

Sets the purpose for a conversation.

slack.conversations_setPurpose({}, context)

Parameters

• token (string) - Authentication token. Requires scope: conversations:write
• purpose (string) - A new, specialer purpose
• channel (string) - Conversation to set the purpose of

conversations_setTopic

Sets the topic for a conversation.

slack.conversations_setTopic({}, context)

Parameters

• topic (string) - The new topic string. Does not support formatting or linkification.
• token (string) - Authentication token. Requires scope: conversations:write
• channel (string) - Conversation to set the topic of

conversations_unarchive

Reverses conversation archival.

slack.conversations_unarchive({}, context)

Parameters

• token (string) - Authentication token. Requires scope: conversations:write
• channel (string) - ID of conversation to unarchive

dialog_open

Open a dialog with a user

slack.dialog_open({}, context)

Parameters

• token (string) - Authentication token. Requires scope: none
• dialog (string) - The dialog definition. This must be a JSON-encoded string.
• trigger_id (string) - Exchange a trigger to post to the user.

dnd_endDnd

Ends the current user's Do Not Disturb session immediately.

slack.dnd_endDnd({}, context)

Parameters

• token (string) - Authentication token. Requires scope: dnd:write

dnd_endSnooze

Ends the current user's snooze mode immediately.

slack.dnd_endSnooze({}, context)

Parameters

• token (string) - Authentication token. Requires scope: dnd:write

dnd_info

Retrieves a user's current Do Not Disturb status.

slack.dnd_info({}, context)

Parameters

• token (string) - Authentication token. Requires scope: dnd:read
• user (string) - User to fetch status for (defaults to current user)

dnd_setSnooze

Turns on Do Not Disturb mode for the current user, or changes its duration.

slack.dnd_setSnooze({}, context)

Parameters

• num_minutes (integer) - Number of minutes, from now, to snooze until.
• token (string) - Authentication token. Requires scope: dnd:write

dnd_teamInfo

Retrieves the Do Not Disturb status for users on a team.

slack.dnd_teamInfo({}, context)

Parameters

• token (string) - Authentication token. Requires scope: dnd:read
• users (string) - Comma-separated list of users to fetch Do Not Disturb status for

emoji_list

Lists custom emoji for a team.

slack.emoji_list({}, context)

Parameters

• token (string) - Authentication token. Requires scope: emoji:read

files_comments_add

Add a comment to an existing file.

slack.files_comments_add({}, context)

Parameters

• comment (string) - Text of the comment to add.
• token (string) - Authentication token. Requires scope: files:write:user
• file (string) - File to add a comment to.

files_comments_delete

Deletes an existing comment on a file.

slack.files_comments_delete({}, context)

Parameters

• token (string) - Authentication token. Requires scope: files:write:user
• id (string) - The comment to delete.
• file (string) - File to delete a comment from.

files_comments_edit

Edit an existing file comment.

slack.files_comments_edit({}, context)

Parameters

• comment (string) - Text of the comment to edit.
• token (string) - Authentication token. Requires scope: files:write:user
• id (string) - The comment to edit.
• file (string) - File containing the comment to edit.

files_delete

Deletes a file.

slack.files_delete({}, context)

Parameters

• token (string) - Authentication token. Requires scope: files:write:user
• file (string) - ID of file to delete.

files_info

Gets information about a team file.

slack.files_info({}, context)

Parameters

• count (string)
• token (string) - Authentication token. Requires scope: files:read
• file (string) - Specify a file by providing its ID.
• page (string)

files_list

Lists & filters team files.

slack.files_list({}, context)

Parameters

• count (string)
• channel (string) - Filter files appearing in a specific channel, indicated by its ID.
• ts_to (number) - Filter files created before this timestamp (inclusive).
• ts_from (number) - Filter files created after this timestamp (inclusive).
• token (string) - Authentication token. Requires scope: files:read
• user (string) - Filter files created by a single user.
• page (string)
• types (string) - Filter files by type:

files_revokePublicURL

Revokes public/external sharing access for a file

slack.files_revokePublicURL({}, context)

Parameters

• token (string) - Authentication token. Requires scope: files:write:user
• file (string) - File to revoke

files_sharedPublicURL

Enables a file for public/external sharing.

slack.files_sharedPublicURL({}, context)

Parameters

• token (string) - Authentication token. Requires scope: files:write:user
• file (string) - File to share

files_upload

Uploads or creates a file.

slack.files_upload({}, context)

Parameters

• channels (string) - Comma-separated list of channel names or IDs where the file will be shared.
• title (string) - Title of file.
• initial_comment (string) - Initial comment to add to file.
• filetype (string) - A file type identifier.
• filename (string) - Filename of file.
• content (string) - File contents via a POST variable. If omitting this parameter, you must provide a file.
• token (string) - Authentication token. Requires scope: files:write:user
• file (string) - File contents via multipart/form-data. If omitting this parameter, you must submit content.

groups_archive

Archives a private channel.

slack.groups_archive({}, context)

Parameters

• token (string) - Authentication token. Requires scope: groups:write
• channel (string) - Private channel to archive

groups_create

Creates a private channel.

slack.groups_create({}, context)

Parameters

• validate (boolean) - Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.
• token (string) - Authentication token. Requires scope: groups:write
• name (string) - Name of private channel to create

groups_createChild

Clones and archives a private channel.

slack.groups_createChild({}, context)

Parameters

• token (string) - Authentication token. Requires scope: groups:write
• channel (string) - Private channel to clone and archive.

groups_history

Fetches history of messages and events from a private channel.

slack.groups_history({}, context)

Parameters

• count (integer) - Number of messages to return, between 1 and 1000.
• unreads (boolean) - Include unread_count_display in the output?
• inclusive (boolean) - Include messages with latest or oldest timestamp in results.
• token (string) - Authentication token. Requires scope: groups:history
• oldest (number) - Start of time range of messages to include in results.
• channel (string) - Private channel to fetch history for.
• latest (number) - End of time range of messages to include in results.

groups_info

Gets information about a private channel.

slack.groups_info({}, context)

Parameters

• token (string) - Authentication token. Requires scope: groups:read
• include_locale (boolean) - Set this to true to receive the locale for this group. Defaults to false
• channel (string) - Private channel to get info on

groups_invite

Invites a user to a private channel.

slack.groups_invite({}, context)

Parameters

• token (string) - Authentication token. Requires scope: groups:write
• user (string) - User to invite.
• channel (string) - Private channel to invite user to.

groups_kick

Removes a user from a private channel.

slack.groups_kick({}, context)

Parameters

• token (string) - Authentication token. Requires scope: groups:write
• user (string) - User to remove from private channel.
• channel (string) - Private channel to remove user from.

groups_leave

Leaves a private channel.

slack.groups_leave({}, context)

Parameters

• token (string) - Authentication token. Requires scope: groups:write
• channel (string) - Private channel to leave

groups_list

Lists private channels that the calling user has access to.

slack.groups_list({}, context)

Parameters

• exclude_members (boolean) - Exlude the members from each group
• token (string) - Authentication token. Requires scope: groups:read
• exclude_archived (boolean) - Don't return archived private channels.

groups_mark

Sets the read cursor in a private channel.

slack.groups_mark({}, context)

Parameters

• token (string) - Authentication token. Requires scope: groups:write
• ts (number) - Timestamp of the most recently seen message.
• channel (string) - Private channel to set reading cursor in.

groups_open

Opens a private channel.

slack.groups_open({}, context)

Parameters

• token (string) - Authentication token. Requires scope: groups:write
• channel (string) - Private channel to open.

groups_rename

Renames a private channel.

slack.groups_rename({}, context)

Parameters

• validate (boolean) - Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.
• token (string) - Authentication token. Requires scope: groups:write
• name (string) - New name for private channel.
• channel (string) - Private channel to rename

groups_replies

Retrieve a thread of messages posted to a private channel

slack.groups_replies({}, context)

Parameters

• thread_ts (number) - Unique identifier of a thread's parent message
• token (string) - Authentication token. Requires scope: groups:history
• channel (string) - Private channel to fetch thread from

groups_setPurpose

Sets the purpose for a private channel.

slack.groups_setPurpose({}, context)

Parameters

• token (string) - Authentication token. Requires scope: groups:write
• purpose (string) - The new purpose
• channel (string) - Private channel to set the purpose of

groups_setTopic

Sets the topic for a private channel.

slack.groups_setTopic({}, context)

Parameters

• topic (string) - The new topic
• token (string) - Authentication token. Requires scope: groups:write
• channel (string) - Private channel to set the topic of

groups_unarchive

Unarchives a private channel.

slack.groups_unarchive({}, context)

Parameters

• token (string) - Authentication token. Requires scope: groups:write
• channel (string) - Private channel to unarchive

im_close

Close a direct message channel.

slack.im_close({}, context)

Parameters

• token (string) - Authentication token. Requires scope: im:write
• channel (string) - Direct message channel to close.

im_history

Fetches history of messages and events from direct message channel.

slack.im_history({}, context)

Parameters

• count (integer) - Number of messages to return, between 1 and 1000.
• unreads (boolean) - Include unread_count_display in the output?
• inclusive (boolean) - Include messages with latest or oldest timestamp in results.
• token (string) - Authentication token. Requires scope: im:history
• oldest (number) - Start of time range of messages to include in results.
• channel (string) - Direct message channel to fetch history for.
• latest (number) - End of time range of messages to include in results.

im_list

Lists direct message channels for the calling user.

slack.im_list({}, context)

Parameters

• cursor (string) - 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 for more detail.
• token (string) - Authentication token. Requires scope: im:read
• limit (integer) - 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.

im_mark

Sets the read cursor in a direct message channel.

slack.im_mark({}, context)

Parameters

• token (string) - Authentication token. Requires scope: im:write
• ts (number) - Timestamp of the most recently seen message.
• channel (string) - Direct message channel to set reading cursor in.

im_open

Opens a direct message channel.

slack.im_open({}, context)

Parameters

• token (string) - Authentication token. Requires scope: im:write
• return_im (boolean) - Boolean, indicates you want the full IM channel definition in the response.
• user (string) - User to open a direct message channel with.
• include_locale (boolean) - Set this to true to receive the locale for this im. Defaults to false

im_replies

Retrieve a thread of messages posted to a direct message conversation

slack.im_replies({}, context)

Parameters

• thread_ts (number) - Unique identifier of a thread's parent message
• token (string) - Authentication token. Requires scope: im:history
• channel (string) - Direct message channel to fetch thread from

mpim_close

Closes a multiparty direct message channel.

slack.mpim_close({}, context)

Parameters

• token (string) - Authentication token. Requires scope: mpim:write
• channel (string) - MPIM to close.

mpim_history

Fetches history of messages and events from a multiparty direct message.

slack.mpim_history({}, context)

Parameters

• count (integer) - Number of messages to return, between 1 and 1000.
• unreads (boolean) - Include unread_count_display in the output?
• inclusive (boolean) - Include messages with latest or oldest timestamp in results.
• token (string) - Authentication token. Requires scope: mpim:history
• oldest (number) - Start of time range of messages to include in results.
• channel (string) - Multiparty direct message to fetch history for.
• latest (number) - End of time range of messages to include in results.

mpim_list

Lists multiparty direct message channels for the calling user.

slack.mpim_list({}, context)

Parameters

• token (string) - Authentication token. Requires scope: mpim:read

mpim_mark

Sets the read cursor in a multiparty direct message channel.

slack.mpim_mark({}, context)

Parameters

• token (string) - Authentication token. Requires scope: mpim:write
• ts (number) - Timestamp of the most recently seen message.
• channel (string) - multiparty direct message channel to set reading cursor in.

mpim_open

This method opens a multiparty direct message.

slack.mpim_open({}, context)

Parameters

• token (string) - Authentication token. Requires scope: mpim:write
• users (string) - Comma separated lists of users. The ordering of the users is preserved whenever a MPIM group is returned.

mpim_replies

Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message.

slack.mpim_replies({}, context)

Parameters

• thread_ts (number) - Unique identifier of a thread's parent message.
• token (string) - Authentication token. Requires scope: mpim:history
• channel (string) - Multiparty direct message channel to fetch thread from.

oauth_access

Exchanges a temporary OAuth code for an API token.

slack.oauth_access({}, context)

Parameters

• client_secret (string) - Issued when you created your application.
• code (string) - The code param returned via the OAuth callback.
• client_id (string) - Issued when you created your application.
• redirect_uri (string) - This must match the originally submitted URI (if one was sent).

oauth_token

Exchanges a temporary OAuth verifier code for a workspace token.

slack.oauth_token({}, context)

Parameters

• client_secret (string) - Issued when you created your application.
• code (string) - The code param returned via the OAuth callback.
• single_channel (boolean) - Request the user to add your app only to a single channel.
• client_id (string) - Issued when you created your application.
• redirect_uri (string) - This must match the originally submitted URI (if one was sent).

pins_add

Pins an item to a channel.

slack.pins_add({}, context)

Parameters

• file_comment (string) - File comment to pin.
• timestamp (number) - Timestamp of the message to pin.
• token (string) - Authentication token. Requires scope: pins:write
• file (string) - File to pin.
• channel (string) - Channel to pin the item in.

pins_list

Lists items pinned to a channel.

slack.pins_list({}, context)

Parameters

• token (string) - Authentication token. Requires scope: pins:read
• channel (string) - Channel to get pinned items for.

pins_remove

Un-pins an item from a channel.

slack.pins_remove({}, context)

Parameters

• file_comment (string) - File comment to un-pin.
• timestamp (number) - Timestamp of the message to un-pin.
• token (string) - Authentication token. Requires scope: pins:write
• file (string) - File to un-pin.
• channel (string) - Channel where the item is pinned to.

reactions_add

Adds a reaction to an item.

slack.reactions_add({}, context)

Parameters

• name (string) - Reaction (emoji) name.
• file_comment (string) - File comment to add reaction to.
• timestamp (number) - Timestamp of the message to add reaction to.
• token (string) - Authentication token. Requires scope: reactions:write
• file (string) - File to add reaction to.
• channel (string) - Channel where the message to add reaction to was posted.

reactions_get

Gets reactions for an item.

slack.reactions_get({}, context)

Parameters

• full (boolean) - If true always return the complete reaction list.
• file_comment (string) - File comment to get reactions for.
• timestamp (number) - Timestamp of the message to get reactions for.
• token (string) - Authentication token. Requires scope: reactions:read
• file (string) - File to get reactions for.
• channel (string) - Channel where the message to get reactions for was posted.

reactions_list

Lists reactions made by a user.

slack.reactions_list({}, context)

Parameters

• count (string)
• token (string) - Authentication token. Requires scope: reactions:read
• full (boolean) - If true always return the complete reaction list.
• user (string) - Show reactions made by this user. Defaults to the authed user.
• page (string)

reactions_remove

Removes a reaction from an item.

slack.reactions_remove({}, context)

Parameters

• name (string) - Reaction (emoji) name.
• file_comment (string) - File comment to remove reaction from.
• timestamp (number) - Timestamp of the message to remove reaction from.
• token (string) - Authentication token. Requires scope: reactions:write
• file (string) - File to remove reaction from.
• channel (string) - Channel where the message to remove reaction from was posted.

reminders_add

Creates a reminder.

slack.reminders_add({}, context)

Parameters

• text (string) - The content of the reminder
• token (string) - Authentication token. Requires scope: reminders:write
• user (string) - The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.
• time (string) - 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")

reminders_complete

Marks a reminder as complete.

slack.reminders_complete({}, context)

Parameters

• token (string) - Authentication token. Requires scope: reminders:write
• reminder (string) - The ID of the reminder to be marked as complete

reminders_delete

Deletes a reminder.

slack.reminders_delete({}, context)

Parameters

• token (string) - Authentication token. Requires scope: reminders:write
• reminder (string) - The ID of the reminder

reminders_info

Gets information about a reminder.

slack.reminders_info({}, context)

Parameters

• token (string) - Authentication token. Requires scope: reminders:read
• reminder (string) - The ID of the reminder

reminders_list

Lists all reminders created by or for a given user.

slack.reminders_list({}, context)

Parameters

• token (string) - Authentication token. Requires scope: reminders:read

rtm_connect

Starts a Real Time Messaging session.

slack.rtm_connect({}, context)

Parameters

• token (string) - Authentication token. Requires scope: rtm:stream
• batch_presence_aware (boolean) - Only deliver presence events when requested by subscription. See presence subscriptions.

rtm_start

Starts a Real Time Messaging session.

slack.rtm_start({}, context)

Parameters

• no_latest (boolean) - Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets no_unreads to 1
• simple_latest (boolean) - Return timestamp only for latest message object of each channel (improves performance).
• include_locale (boolean) - Set this to true to receive the locale for users and channels. Defaults to false
• no_unreads (boolean) - Skip unread counts for each channel (improves performance).
• batch_presence_aware (boolean) - Only deliver presence events when requested by subscription. See presence subscriptions.
• mpim_aware (boolean) - Returns MPIMs to the client in the API response.
• token (string) - Authentication token. Requires scope: rtm:stream

search_all

Searches for messages and files matching a query.

slack.search_all({}, context)

Parameters

• sort_dir (string) - Change sort direction to ascending (asc) or descending (desc).
• query (string) - Search query. May contains booleans, etc.
• sort (string) - Return matches sorted by either score or timestamp.
• count (string)
• token (string) - Authentication token. Requires scope: search:read
• highlight (boolean) - Pass a value of true to enable query highlight markers (see below).
• page (string)

search_files

Searches for files matching a query.

slack.search_files({}, context)

Parameters

• sort_dir (string) - Change sort direction to ascending (asc) or descending (desc).
• query (string) - Search query. May contain booleans, etc.
• sort (string) - Return matches sorted by either score or timestamp.
• highlight (boolean) - Pass a value of true to enable query highlight markers (see below).
• count (string)
• token (string) - Authentication token. Requires scope: search:read
• page (string)

search_messages

Searches for messages matching a query.

slack.search_messages({}, context)

Parameters

• sort_dir (string) - Change sort direction to ascending (asc) or descending (desc).
• query (string) - Search query. May contains booleans, etc.
• sort (string) - Return matches sorted by either score or timestamp.
• count (string)
• token (string) - Authentication token. Requires scope: search:read
• highlight (boolean) - Pass a value of true to enable query highlight markers (see below).
• page (string)

stars_add

Adds a star to an item.

slack.stars_add({}, context)

Parameters

• file_comment (string) - File comment to add star to.
• timestamp (number) - Timestamp of the message to add star to.
• token (string) - Authentication token. Requires scope: stars:write
• channel (string) - Channel to add star to, or channel where the message to add star to was posted (used with timestamp).
• file (string) - File to add star to.

stars_list

Lists stars for a user.

slack.stars_list({}, context)

Parameters

• count (string)
• token (string) - Authentication token. Requires scope: stars:read
• page (string)

stars_remove

Removes a star from an item.

slack.stars_remove({}, context)

Parameters

• file_comment (string) - File comment to remove star from.
• timestamp (number) - Timestamp of the message to remove star from.
• token (string) - Authentication token. Requires scope: stars:write
• channel (string) - Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).
• file (string) - File to remove star from.

team_accessLogs

Gets the access logs for the current team.

slack.team_accessLogs({}, context)

Parameters

• count (string)
• token (string) - Authentication token. Requires scope: admin
• page (string)
• before (integer) - End of time range of logs to include in results (inclusive).

team_billableInfo

Gets billable users information for the current team.

slack.team_billableInfo({}, context)

Parameters

• token (string) - Authentication token. Requires scope: admin
• user (string) - A user to retrieve the billable information for. Defaults to all users.

team_info

Gets information about the current team.

slack.team_info({}, context)

Parameters

• token (string) - Authentication token. Requires scope: team:read

team_integrationLogs

Gets the integration logs for the current team.

slack.team_integrationLogs({}, context)

Parameters

• count (string)
• change_type (string) - Filter logs with this change type. Defaults to all logs.
• app_id (integer) - Filter logs to this Slack app. Defaults to all logs.
• token (string) - Authentication token. Requires scope: admin
• user (string) - Filter logs generated by this user’s actions. Defaults to all logs.
• service_id (integer) - Filter logs to this service. Defaults to all logs.
• page (string)

team_profile_get

Retrieve a team's profile.

slack.team_profile_get({}, context)

Parameters

• token (string) - Authentication token. Requires scope: users.profile:read
• visibility (string) - Filter by visibility.

usergroups_create

Create a User Group

slack.usergroups_create({}, context)

Parameters

• handle (string) - A mention handle. Must be unique among channels, users and User Groups.
• name (string) - A name for the User Group. Must be unique among User Groups.
• channels (string) - A comma separated string of encoded channel IDs for which the User Group uses as a default.
• token (string) - Authentication token. Requires scope: usergroups:write
• include_count (boolean) - Include the number of users in each User Group.
• description (string) - A short description of the User Group.

usergroups_disable

Disable an existing User Group

slack.usergroups_disable({}, context)

Parameters

• token (string) - Authentication token. Requires scope: usergroups:write
• include_count (boolean) - Include the number of users in the User Group.
• usergroup (string) - The encoded ID of the User Group to disable.

usergroups_enable

Enable a User Group

slack.usergroups_enable({}, context)

Parameters

• token (string) - Authentication token. Requires scope: usergroups:write
• include_count (boolean) - Include the number of users in the User Group.
• usergroup (string) - The encoded ID of the User Group to enable.

usergroups_list

List all User Groups for a team

slack.usergroups_list({}, context)

Parameters

• include_users (boolean) - Include the list of users for each User Group.
• token (string) - Authentication token. Requires scope: usergroups:read
• include_count (boolean) - Include the number of users in each User Group.
• include_disabled (boolean) - Include disabled User Groups.

usergroups_update

Update an existing User Group

slack.usergroups_update({}, context)

Parameters

• handle (string) - A mention handle. Must be unique among channels, users and User Groups.
• description (string) - A short description of the User Group.
• channels (string) - A comma separated string of encoded channel IDs for which the User Group uses as a default.
• token (string) - Authentication token. Requires scope: usergroups:write
• include_count (boolean) - Include the number of users in the User Group.
• usergroup (string) - The encoded ID of the User Group to update.
• name (string) - A name for the User Group. Must be unique among User Groups.

usergroups_users_list

List all users in a User Group

slack.usergroups_users_list({}, context)

Parameters

• token (string) - Authentication token. Requires scope: usergroups:read
• include_disabled (boolean) - Allow results that involve disabled User Groups.
• usergroup (string) - The encoded ID of the User Group to update.

usergroups_users_update

Update the list of users for a User Group

slack.usergroups_users_update({}, context)

Parameters

• include_count (boolean) - Include the number of users in the User Group.
• token (string) - Authentication token. Requires scope: usergroups:write
• users (string) - A comma separated string of encoded user IDs that represent the entire list of users for the User Group.
• usergroup (string) - The encoded ID of the User Group to update.

users_deletePhoto

Delete the user profile photo

slack.users_deletePhoto({}, context)

Parameters

• token (string) - Authentication token. Requires scope: users.profile:write

users_getPresence

Gets user presence information.

slack.users_getPresence({}, context)

Parameters

• token (string) - Authentication token. Requires scope: users:read
• user (string) - User to get presence info on. Defaults to the authed user.

users_identity

Get a user's identity.

slack.users_identity({}, context)

Parameters

• token (string) - Authentication token. Requires scope: identity.basic

users_info

Gets information about a user.

slack.users_info({}, context)

Parameters

• include_locale (boolean) - Set this to true to receive the locale for this user. Defaults to false
• token (string) - Authentication token. Requires scope: users:read
• user (string) - User to get info on

users_list

Lists all users in a Slack team.

slack.users_list({}, context)

Parameters

• presence (boolean) - Whether to include presence data in the output. Setting this to false improves performance, especially with large teams.
• cursor (string) - 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 for more detail.
• token (string) - Authentication token. Requires scope: users:read
• limit (integer) - 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.
• include_locale (boolean) - Set this to true to receive the locale for users. Defaults to false

users_profile_get

Retrieves a user's profile information.

slack.users_profile_get({}, context)

Parameters

• token (string) - Authentication token. Requires scope: users.profile:read
• include_labels (boolean) - Include labels for each ID in custom profile fields
• user (string) - User to retrieve profile info for

users_profile_set

Set the profile information for a user.

slack.users_profile_set({}, context)

Parameters

• profile (string) - Collection of key:value pairs presented as a URL-encoded JSON hash.
• token (string) - Authentication token. Requires scope: users.profile:write
• user (string) - ID of user to change. This argument may only be specified by team admins on paid teams.
• value (string) - Value to set a single key to. Usable only if profile is not passed.
• name (string) - Name of a single key to set. Usable only if profile is not passed.

users_setActive

Marks a user as active.

slack.users_setActive({}, context)

Parameters

• token (string) - Authentication token. Requires scope: users:write

users_setPhoto

Set the user profile photo

slack.users_setPhoto({}, context)

Parameters

• image (string) - File contents via multipart/form-data.
• crop_w (integer) - Width/height of crop box (always square)
• token (string) - Authentication token. Requires scope: users.profile:write
• crop_y (integer) - Y coordinate of top-left corner of crop box
• crop_x (integer) - X coordinate of top-left corner of crop box

users_setPresence

Manually sets user presence.

slack.users_setPresence({}, context)

Parameters

• token (string) - Authentication token. Requires scope: users:write
• presence (string) - Either auto or away