New Research: Supply Chain Attack on Axios Pulls Malicious Dependency from npm.Details →
Socket
Book a DemoSign in
Socket

@datafire/slack

Package Overview
Dependencies
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@datafire/slack

DataFire integration for Slack

Source
npmnpm
Version
5.0.1
Version published
Weekly downloads
15
-25%
Maintainers
1
Weekly downloads
 
Created
Source

@datafire/slack

Client library for Slack

Installation and Usage

npm install --save @datafire/slack
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)

Input

  • input object
    • code required string

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

slack.oauthRefresh(null, context)

Input

This action has no parameters

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

api_test

Checks API calling code.

slack.api_test({}, context)

Input

  • input object
    • foo string: example property to return
    • error string: Error response to return

Output

  • output object: Schema for successful response api.test method
    • ok required defs_ok_true

apps_permissions_info

Returns list of permissions this app has on a team.

slack.apps_permissions_info({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: none

Output

  • output object: Verbose schema not yet ready for this method.

apps_permissions_request

Allows an app to request additional scopes

slack.apps_permissions_request({}, context)

Input

  • input object
    • 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

Output

  • output object: Schema for successful response from apps.permissions.request method

apps_permissions_resources_list

Returns list of resource grants this app has on a team.

slack.apps_permissions_resources_list({}, context)

Input

  • input object
    • 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: none
    • limit integer: The maximum number of items to return.

Output

  • output object: Schema for successful response apps.permissions.resources.list method
    • ok required defs_ok_true
    • resources required array
      • items object
        • id string
        • type string
    • response_metadata object
      • next_cursor required string

apps_permissions_scopes_list

Returns list of scopes this app has on a team.

slack.apps_permissions_scopes_list({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: none

Output

auth_revoke

Revokes a token.

slack.auth_revoke({}, context)

Input

  • input object
    • 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

Output

  • output object: Schema for successful response from auth.revoke method

auth_test

Checks authentication & identity.

slack.auth_test({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: none

Output

  • output object: Schema for successful response auth.test method

bots_info

Gets information about a bot user.

slack.bots_info({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: users:read
    • bot string: Bot user to get info on

Output

  • output object: Schema for successful response from bots.info method
    • bot required object
      • app_id required defs_app_id
      • deleted required boolean
      • icons required object
        • image_36 required string
        • image_48 required string
        • image_72 required string
      • id required defs_bot_id
      • name required string
      • updated required integer
      • user_id defs_user_id
    • ok required defs_ok_true

channels_archive

Archives a channel.

slack.channels_archive({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: channels:write
    • channel string: Channel to archive

Output

  • output object: Schema for successful response from channels.archive method

channels_create

Creates a channel.

slack.channels_create({}, context)

Input

  • input object
    • 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

Output

  • output object: Schema for successful response channels.create method

channels_history

Fetches history of messages and events from a channel.

slack.channels_history({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response channels.history method

channels_info

Gets information about a channel.

slack.channels_info({}, context)

Input

  • input object
    • 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

Output

  • output object: Schema for successful response channels.info method

channels_invite

Invites a user to a channel.

slack.channels_invite({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: channels:write
    • user string: User to invite to channel.
    • channel string: Channel to invite user to.

Output

  • output object: Schema for successful response channels.invite method

channels_join

Joins a channel, creating it if needed.

slack.channels_join({}, context)

Input

  • input object
    • 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

Output

  • output object: Schema for successful response from channels.join method

channels_kick

Removes a user from a channel.

slack.channels_kick({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: channels:write
    • user string: User to remove from channel.
    • channel string: Channel to remove user from.

Output

  • output object: Schema for successful response from channels.kick method

channels_leave

Leaves a channel.

slack.channels_leave({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: channels:write
    • channel string: Channel to leave

Output

  • output object: Verbose schema not yet ready for this method.

channels_list

Lists all channels in a Slack team.

slack.channels_list({}, context)

Input

  • input object
    • 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

Output

  • output object: Schema for successful response channels.list method

channels_mark

Sets the read cursor in a channel.

slack.channels_mark({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response channels.mark method

channels_rename

Renames a channel.

slack.channels_rename({}, context)

Input

  • input object
    • 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

Output

  • output object: Schema for successful response from channels.rename method

channels_replies

Retrieve a thread of messages posted to a channel

slack.channels_replies({}, context)

Input

  • input object
    • 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

Output

  • output object: Verbose schema not yet ready for this method.

channels_setPurpose

Sets the purpose for a channel.

slack.channels_setPurpose({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: channels:write
    • purpose string: The new purpose
    • channel string: Channel to set the purpose of

Output

  • output object: Schema for successful response from channels.setPurpose method

channels_setTopic

Sets the topic for a channel.

slack.channels_setTopic({}, context)

Input

  • input object
    • topic string: The new topic
    • token string: Authentication token. Requires scope: channels:write
    • channel string: Channel to set the topic of

Output

  • output object: Verbose schema not yet ready for this method.

channels_unarchive

Unarchives a channel.

slack.channels_unarchive({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: channels:write
    • channel string: Channel to unarchive

Output

  • output object: Verbose schema not yet ready for this method.

chat_delete

Deletes a message.

slack.chat_delete({}, context)

Input

  • input object
    • 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.

Output

Retrieve a permalink URL for a specific extant message

slack.chat_getPermalink({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: none
    • message_ts number: A message's ts value, uniquely identifying it within a channel
    • channel string: The ID of the conversation or channel containing the message

Output

  • output object: Schema for successful response chat.getPermalink

chat_meMessage

Share a me message into a channel.

slack.chat_meMessage({}, context)

Input

  • input object
    • 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.

Output

  • output object: Verbose schema not yet ready for this method.

chat_postEphemeral

Sends an ephemeral message to a user in a channel.

slack.chat_postEphemeral({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response from chat.postEphemeral method

chat_postMessage

Sends a message to a channel.

slack.chat_postMessage({}, context)

Input

  • input object
    • 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. Provide no more than 40,000 characters or risk truncation.
    • 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
    • mrkdwn boolean: Disable Slack markup parsing by setting to false. Enabled by default.
    • 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.

Output

chat_unfurl

Provide custom unfurl behavior for user-posted URLs

slack.chat_unfurl({}, context)

Input

  • input object
    • 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

Output

  • output object: Schema for successful response from chat.unfurl method

chat_update

Updates a message.

slack.chat_update({}, context)

Input

  • input object
    • 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. See below.
    • channel string: Channel containing the message to be updated.

Output

  • output object: Schema for successful response of chat.update method

conversations_archive

Archives a conversation.

slack.conversations_archive({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: conversations:write
    • channel string: ID of conversation to archive

Output

  • output object: Schema for successful response conversations.archive method

conversations_close

Closes a direct message or multi-person direct message.

slack.conversations_close({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: conversations:write
    • channel string: Conversation to close.

Output

  • output object: Schema for successful response conversations.close method
    • already_closed boolean
    • no_op boolean
    • ok required defs_ok_true

conversations_create

Initiates a public or private channel-based conversation

slack.conversations_create({}, context)

Input

  • input object
    • 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

Output

conversations_history

Fetches a conversation's history of messages and events.

slack.conversations_history({}, context)

Input

  • input object
    • inclusive boolean: Include messages with latest or oldest timestamp in results only when either timestamp is specified.
    • 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.

Output

  • output object: Schema for successful response from conversations.history method
    • has_more required boolean
    • messages required array
    • ok required defs_ok_true
    • pin_count required integer

conversations_info

Retrieve information about a conversation.

slack.conversations_info({}, context)

Input

  • input object
    • 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

Output

conversations_invite

Invites users to a channel.

slack.conversations_invite({}, context)

Input

  • input object
    • 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.

Output

conversations_join

Joins an existing conversation.

slack.conversations_join({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: channels:write
    • channel string: ID of conversation to join

Output

  • output object: Schema for successful response from conversations.join method

conversations_kick

Removes a user from a conversation.

slack.conversations_kick({}, context)

Input

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

Output

  • output object: Schema for successful response conversations.kick method

conversations_leave

Leaves a conversation.

slack.conversations_leave({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: conversations:write
    • channel string: Conversation to leave

Output

  • output object: Schema for successful response from conversations.leave method
    • not_in_channel boolean (values: true)
    • ok required defs_ok_true

conversations_list

Lists all channels in a Slack team.

slack.conversations_list({}, context)

Input

  • input object
    • 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 list hasn't been reached. Must be an integer no larger than 1000.
    • exclude_archived boolean: Set to true to exclude archived channels from the list
    • types string: Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im

Output

  • output object: Schema for successful response from conversations.list method

conversations_members

Retrieve members of a conversation.

slack.conversations_members({}, context)

Input

  • input object
    • 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

Output

  • output object: Schema for successful response conversations.members method
    • members required array
    • ok required defs_ok_true
    • response_metadata required object
      • next_cursor required string

conversations_open

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

slack.conversations_open({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response from conversations.open method when opening channels, ims, mpims

conversations_rename

Renames a conversation.

slack.conversations_rename({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: conversations:write
    • name string: New name for conversation.
    • channel string: ID of conversation to rename

Output

conversations_replies

Retrieve a thread of messages posted to a conversation

slack.conversations_replies({}, context)

Input

  • input object
    • inclusive boolean: Include messages with latest or oldest timestamp in results only when either timestamp is specified.
    • 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.
    • oldest number: Start of time range of messages to include in results.
    • channel string: Conversation ID to fetch thread from.
    • latest number: End of time range of messages to include in results.

Output

  • output object: Schema for successful response from conversations.replies method
    • has_more boolean

    • messages required array

      • items
    • ok required defs_ok_true

conversations_setPurpose

Sets the purpose for a conversation.

slack.conversations_setPurpose({}, context)

Input

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

Output

conversations_setTopic

Sets the topic for a conversation.

slack.conversations_setTopic({}, context)

Input

  • input object
    • 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

Output

conversations_unarchive

Reverses conversation archival.

slack.conversations_unarchive({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: conversations:write
    • channel string: ID of conversation to unarchive

Output

  • output object: Schema for successful response from conversations.unarchive method

dialog_open

Open a dialog with a user

slack.dialog_open({}, context)

Input

  • input object
    • 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.

Output

  • output object: Verbose schema not yet ready for this method.

dnd_endDnd

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

slack.dnd_endDnd({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: dnd:write

Output

  • output object: Verbose schema not yet ready for this method.

dnd_endSnooze

Ends the current user's snooze mode immediately.

slack.dnd_endSnooze({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: dnd:write

Output

  • output object: Verbose schema not yet ready for this method.

dnd_info

Retrieves a user's current Do Not Disturb status.

slack.dnd_info({}, context)

Input

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

Output

  • output object: Verbose schema not yet ready for this method.

dnd_setSnooze

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

slack.dnd_setSnooze({}, context)

Input

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

Output

  • output object: Verbose schema not yet ready for this method.

dnd_teamInfo

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

slack.dnd_teamInfo({}, context)

Input

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

Output

  • output object: Schema for successful response from dnd.teamInfo method
    • cached boolean
    • ok required defs_ok_true
    • users required object

emoji_list

Lists custom emoji for a team.

slack.emoji_list({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: emoji:read

Output

  • output object: Verbose schema not yet ready for this method.

files_comments_add

Add a comment to an existing file.

slack.files_comments_add({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response files.comments.add method

files_comments_delete

Deletes an existing comment on a file.

slack.files_comments_delete({}, context)

Input

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

Output

  • output object: Schema for successful response files.comments.delete method

files_comments_edit

Edit an existing file comment.

slack.files_comments_edit({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response files.comments.edit method

files_delete

Deletes a file.

slack.files_delete({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: files:write:user
    • file string: ID of file to delete.

Output

  • output object: Schema for successful response files.delete method

files_info

Gets information about a team file.

slack.files_info({}, context)

Input

  • input object
    • count string
    • token string: Authentication token. Requires scope: files:read
    • file string: Specify a file by providing its ID.
    • page string

Output

files_list

Lists & filters team files.

slack.files_list({}, context)

Input

  • input object
    • 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:

Output

  • output object: Schema for successful response from files.list method

files_revokePublicURL

Revokes public/external sharing access for a file

slack.files_revokePublicURL({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: files:write:user
    • file string: File to revoke

Output

  • output object: Verbose schema not yet ready for this method.

files_sharedPublicURL

Enables a file for public/external sharing.

slack.files_sharedPublicURL({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: files:write:user
    • file string: File to share

Output

  • output object: Verbose schema not yet ready for this method.

files_upload

Uploads or creates a file.

slack.files_upload({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response files.upload method

groups_archive

Archives a private channel.

slack.groups_archive({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: groups:write
    • channel string: Private channel to archive

Output

  • output object: Schema for successful response from groups.archive method

groups_create

Creates a private channel.

slack.groups_create({}, context)

Input

  • input object
    • 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

Output

  • output object: Schema for successful response groups.create method

groups_createChild

Clones and archives a private channel.

slack.groups_createChild({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: groups:write
    • channel string: Private channel to clone and archive.

Output

  • output object: Verbose schema not yet ready for this method.

groups_history

Fetches history of messages and events from a private channel.

slack.groups_history({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response groups.history method

groups_info

Gets information about a private channel.

slack.groups_info({}, context)

Input

  • input object
    • 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

Output

  • output object: Schema for successful response groups.info method

groups_invite

Invites a user to a private channel.

slack.groups_invite({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: groups:write
    • user string: User to invite.
    • channel string: Private channel to invite user to.

Output

  • output object: Schema for successful response groups.invite method

groups_kick

Removes a user from a private channel.

slack.groups_kick({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: groups:write
    • user string: User to remove from private channel.
    • channel string: Private channel to remove user from.

Output

  • output object: Schema for successful response from groups.kick method

groups_leave

Leaves a private channel.

slack.groups_leave({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: groups:write
    • channel string: Private channel to leave

Output

  • output object: Verbose schema not yet ready for this method.

groups_list

Lists private channels that the calling user has access to.

slack.groups_list({}, context)

Input

  • input object
    • exclude_members boolean: Exclude the members from each group
    • token string: Authentication token. Requires scope: groups:read
    • exclude_archived boolean: Don't return archived private channels.

Output

  • output object: Schema for successful response groups.list method

groups_mark

Sets the read cursor in a private channel.

slack.groups_mark({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response from groups.mark method

groups_open

Opens a private channel.

slack.groups_open({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: groups:write
    • channel string: Private channel to open.

Output

  • output object: Verbose schema not yet ready for this method.

groups_rename

Renames a private channel.

slack.groups_rename({}, context)

Input

  • input object
    • 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

Output

  • output object: Verbose schema not yet ready for this method.

groups_replies

Retrieve a thread of messages posted to a private channel

slack.groups_replies({}, context)

Input

  • input object
    • 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

Output

  • output object: Verbose schema not yet ready for this method.

groups_setPurpose

Sets the purpose for a private channel.

slack.groups_setPurpose({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: groups:write
    • purpose string: The new purpose
    • channel string: Private channel to set the purpose of

Output

  • output object: Schema for successful response from groups.setPurpose method

groups_setTopic

Sets the topic for a private channel.

slack.groups_setTopic({}, context)

Input

  • input object
    • topic string: The new topic
    • token string: Authentication token. Requires scope: groups:write
    • channel string: Private channel to set the topic of

Output

  • output object: Schema for successful response from groups.setTopic method

groups_unarchive

Unarchives a private channel.

slack.groups_unarchive({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: groups:write
    • channel string: Private channel to unarchive

Output

  • output object: Verbose schema not yet ready for this method.

im_close

Close a direct message channel.

slack.im_close({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: im:write
    • channel string: Direct message channel to close.

Output

  • output object: Verbose schema not yet ready for this method.

im_history

Fetches history of messages and events from direct message channel.

slack.im_history({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response from im.history method

im_list

Lists direct message channels for the calling user.

slack.im_list({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response im.list method

im_mark

Sets the read cursor in a direct message channel.

slack.im_mark({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response im.mark method

im_open

Opens a direct message channel.

slack.im_open({}, context)

Input

  • input object
    • 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

Output

  • output object: Schema for successful response from im.open method

im_replies

Retrieve a thread of messages posted to a direct message conversation

slack.im_replies({}, context)

Input

  • input object
    • 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

Output

  • output object: Verbose schema not yet ready for this method.

migration_exchange

For Enterprise Grid workspaces, map local user IDs to global user IDs

slack.migration_exchange({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: tokens.basic
    • to_old boolean: Specify true to convert W global user IDs to workspace-specific U IDs. Defaults to false.
    • users string: A comma-separated list of user ids, up to 400 per request

Output

  • output object: Schema for successful response from migration.exchange method
    • enterprise_id required string
    • invalid_user_ids array
      • items string
    • ok required defs_ok_true
    • team_id required defs_team
    • user_id_map object

mpim_close

Closes a multiparty direct message channel.

slack.mpim_close({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: mpim:write
    • channel string: MPIM to close.

Output

  • output object: Verbose schema not yet ready for this method.

mpim_history

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

slack.mpim_history({}, context)

Input

  • input object
    • 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.

Output

  • output object: Verbose schema not yet ready for this method.

mpim_list

Lists multiparty direct message channels for the calling user.

slack.mpim_list({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: mpim:read

Output

  • output object: Verbose schema not yet ready for this method.

mpim_mark

Sets the read cursor in a multiparty direct message channel.

slack.mpim_mark({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response from mpim.mark method

mpim_open

This method opens a multiparty direct message.

slack.mpim_open({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response from mpim.open method

mpim_replies

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

slack.mpim_replies({}, context)

Input

  • input object
    • 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.

Output

  • output object: Verbose schema not yet ready for this method.

oauth_access

Exchanges a temporary OAuth verifier code for an access token.

slack.oauth_access({}, context)

Input

  • input object
    • 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).

Output

  • output object: Verbose schema not yet ready for this method.

oauth_token

Exchanges a temporary OAuth verifier code for a workspace token.

slack.oauth_token({}, context)

Input

  • input object
    • 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).

Output

  • output object: Verbose schema not yet ready for this method.

pins_add

Pins an item to a channel.

slack.pins_add({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response from pins.add method

pins_list

Lists items pinned to a channel.

slack.pins_list({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: pins:read
    • channel string: Channel to get pinned items for.

Output

  • output: Schema for successful response from pins.list method

pins_remove

Un-pins an item from a channel.

slack.pins_remove({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response from pins.remove method

reactions_add

Adds a reaction to an item.

slack.reactions_add({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response from reactions.add method

reactions_get

Gets reactions for an item.

slack.reactions_get({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response from reactions.get method

reactions_list

Lists reactions made by a user.

slack.reactions_list({}, context)

Input

  • input object
    • 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

Output

  • output object: Schema for successful response from reactions.list method

reactions_remove

Removes a reaction from an item.

slack.reactions_remove({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response from reactions.remove method

reminders_add

Creates a reminder.

slack.reminders_add({}, context)

Input

  • input object
    • 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")

Output

  • output object: Verbose schema not yet ready for this method.

reminders_complete

Marks a reminder as complete.

slack.reminders_complete({}, context)

Input

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

Output

  • output object: Verbose schema not yet ready for this method.

reminders_delete

Deletes a reminder.

slack.reminders_delete({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: reminders:write
    • reminder string: The ID of the reminder

Output

  • output object: Verbose schema not yet ready for this method.

reminders_info

Gets information about a reminder.

slack.reminders_info({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: reminders:read
    • reminder string: The ID of the reminder

Output

  • output object: Verbose schema not yet ready for this method.

reminders_list

Lists all reminders created by or for a given user.

slack.reminders_list({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: reminders:read

Output

  • output object: Verbose schema not yet ready for this method.

rtm_connect

Starts a Real Time Messaging session.

slack.rtm_connect({}, context)

Input

  • input object
    • presence_sub boolean: Only deliver presence events when requested by subscription. See presence subscriptions.
    • token string: Authentication token. Requires scope: rtm:stream
    • batch_presence_aware boolean: Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.

Output

  • output object: Schema for successful response from rtm.connect method
    • ok required defs_ok_true
    • self required object
    • team required object
      • domain required string
      • id required defs_team
      • name required string
    • url required string

rtm_start

Starts a Real Time Messaging session.

slack.rtm_start({}, context)

Input

  • input object
    • 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
    • presence_sub boolean: Only deliver presence events when requested by subscription. See presence subscriptions.
    • no_unreads boolean: Skip unread counts for each channel (improves performance).
    • batch_presence_aware boolean: Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.
    • mpim_aware boolean: Returns MPIMs to the client in the API response.
    • token string: Authentication token. Requires scope: rtm:stream

Output

  • output object: Schema for successful response from rtm.start method
    • bots required array

    • cache_ts required integer

    • cache_ts_version required string

    • cache_version string

    • can_manage_shared_channels required boolean

    • channels required array

    • dead_pig boolean

    • dnd required objs_dnd

    • groups required array: Group objects present for rtm.start. Can be null when there are no groups

      • items
    • ims required array

    • latest_event_ts required string

    • mpims array: Mpim objects present for rtm.start. Can be null when there are no mpims

      • items
    • non_threadable_channels required array

    • ok required defs_ok_true

    • read_only_channels required array

    • self required object

      • created required integer
      • id required string
      • manual_presence required string
      • name string
      • prefs required prefs_prefs
    • subteams required object

      • all required array

      • self required array

    • team required objs_team

    • thread_only_channels required array

    • url required string

    • users required array

search_all

Searches for messages and files matching a query.

slack.search_all({}, context)

Input

  • input object
    • 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

Output

  • output object: Verbose schema not yet ready for this method.

search_files

Searches for files matching a query.

slack.search_files({}, context)

Input

  • input object
    • sort_dir string: Change sort direction to ascending (asc) or descending (desc).
    • query string: Search query.
    • 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

Output

  • output object: Verbose schema not yet ready for this method.

search_messages

Searches for messages matching a query.

slack.search_messages({}, context)

Input

  • input object
    • sort_dir string: Change sort direction to ascending (asc) or descending (desc).
    • query string: Search query.
    • sort string: Return matches sorted by either score or timestamp.
    • count string: Pass the number of results you want per "page". Maximum of 100.
    • token string: Authentication token. Requires scope: search:read
    • highlight boolean: Pass a value of true to enable query highlight markers (see below).
    • page string

Output

  • output object: Verbose schema not yet ready for this method.

stars_add

Adds a star to an item.

slack.stars_add({}, context)

Input

  • input object
    • 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.

Output

  • output object: Verbose schema not yet ready for this method.

stars_list

Lists stars for a user.

slack.stars_list({}, context)

Input

  • input object
    • count string
    • token string: Authentication token. Requires scope: stars:read
    • page string

Output

  • output object: Verbose schema not yet ready for this method.

stars_remove

Removes a star from an item.

slack.stars_remove({}, context)

Input

  • input object
    • 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.

Output

  • output object: Verbose schema not yet ready for this method.

team_accessLogs

Gets the access logs for the current team.

slack.team_accessLogs({}, context)

Input

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

Output

  • output object: Verbose schema not yet ready for this method.

team_billableInfo

Gets billable users information for the current team.

slack.team_billableInfo({}, context)

Input

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

Output

  • output object: Verbose schema not yet ready for this method.

team_info

Gets information about the current team.

slack.team_info({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: team:read

Output

  • output object: Schema for successful response from team.info method

team_integrationLogs

Gets the integration logs for the current team.

slack.team_integrationLogs({}, context)

Input

  • input object
    • 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

Output

  • output object: Verbose schema not yet ready for this method.

team_profile_get

Retrieve a team's profile.

slack.team_profile_get({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: users.profile:read
    • visibility string: Filter by visibility.

Output

  • output object: Schema for successful response from team.profile.get method

usergroups_create

Create a User Group

slack.usergroups_create({}, context)

Input

  • input object
    • 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.

Output

  • output object: Verbose schema not yet ready for this method.

usergroups_disable

Disable an existing User Group

slack.usergroups_disable({}, context)

Input

  • input object
    • 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.

Output

  • output object: Verbose schema not yet ready for this method.

usergroups_enable

Enable a User Group

slack.usergroups_enable({}, context)

Input

  • input object
    • 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.

Output

  • output object: Verbose schema not yet ready for this method.

usergroups_list

List all User Groups for a team

slack.usergroups_list({}, context)

Input

  • input object
    • 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.

Output

  • output object: Verbose schema not yet ready for this method.

usergroups_update

Update an existing User Group

slack.usergroups_update({}, context)

Input

  • input object
    • 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.

Output

  • output object: Verbose schema not yet ready for this method.

usergroups_users_list

List all users in a User Group

slack.usergroups_users_list({}, context)

Input

  • input object
    • 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.

Output

  • output object: Verbose schema not yet ready for this method.

usergroups_users_update

Update the list of users for a User Group

slack.usergroups_users_update({}, context)

Input

  • input object
    • 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.

Output

  • output object: Verbose schema not yet ready for this method.

users_conversations

List conversations the calling user may access.

slack.users_conversations({}, context)

Input

  • input object
    • 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 list hasn't been reached. Must be an integer no larger than 1000.
    • user string: Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.
    • exclude_archived boolean: Set to true to exclude archived channels from the list
    • types string: Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im

Output

  • output object: Schema for successful response from users.conversations method. Returned conversation objects do not include num_members or is_member

users_deletePhoto

Delete the user profile photo

slack.users_deletePhoto({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: users.profile:write

Output

  • output object: Verbose schema not yet ready for this method.

users_getPresence

Gets user presence information.

slack.users_getPresence({}, context)

Input

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

Output

  • output object: Generated from users.getPresence with shasum e7251aec575d8863f9e0eb38663ae9dc26655f65
    • auto_away boolean
    • connection_count integer
    • last_activity integer
    • manual_away boolean
    • ok required defs_ok_true
    • online boolean
    • presence required string

users_identity

Get a user's identity.

slack.users_identity({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: identity.basic

Output

  • output: Schema for successful response from users.identity method

users_info

Gets information about a user.

slack.users_info({}, context)

Input

  • input object
    • 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

Output

  • output object: Schema for successful response from users.info method

users_list

Lists all users in a Slack team.

slack.users_list({}, context)

Input

  • input object
    • presence boolean: Deprecated. Whether to include presence data in the output. Defaults to false. Setting this to true reduces 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

Output

  • output object: Schema for successful response from users.list method

users_lookupByEmail

Find a user with an email address.

slack.users_lookupByEmail({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: users:read.email
    • email string: An email address belonging to a user in the workspace

Output

  • output object: Schema for successful response from users.lookupByEmail method

users_profile_get

Retrieves a user's profile information.

slack.users_profile_get({}, context)

Input

  • input object
    • 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

Output

users_profile_set

Set the profile information for a user.

slack.users_profile_set({}, context)

Input

  • input object
    • 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.

Output

  • output object: Schema for successful response from users.profile.set method

users_setActive

Marked a user as active. Deprecated and non-functional.

slack.users_setActive({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: users:write

Output

  • output object: Verbose schema not yet ready for this method.

users_setPhoto

Set the user profile photo

slack.users_setPhoto({}, context)

Input

  • input object
    • 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

Output

  • output object: Verbose schema not yet ready for this method.

users_setPresence

Manually sets user presence.

slack.users_setPresence({}, context)

Input

  • input object
    • token string: Authentication token. Requires scope: users:write
    • presence string: Either auto or away

Output

  • output object: Verbose schema not yet ready for this method.

Definitions

defs_app_id

  • App ID string

defs_bot_id

  • Bot User ID string

defs_channel

  • Channel-like conversation ID string

defs_channel_id

  • Channel ID string

defs_channel_name

  • Name of a channel string

defs_comment_id

  • File Comment ID string

defs_dm_id

  • Direct Message Channel ID string

defs_file_id

  • File ID string

defs_group_id

  • Private Channel ID string

defs_invite_id

  • Invite ID for an external shared channel integer

defs_ok_false

  • default failure response boolean (values: false)

defs_ok_true

  • default success response boolean (values: true)

defs_pinned_info

  • Info for a pinned item object

defs_room_id

  • Room ID for a slack call string

defs_team

  • Team ID string

defs_topic_purpose_creator

  • User ID or empty string, used for topic and purpose creation string

defs_ts

  • Timestamp in format 0123456789.012345 string

defs_user_id

  • User ID string

objs_channel

  • Channel Object object
    • accepted_user defs_user_id

    • created required integer

    • creator required defs_user_id

    • id required defs_channel_id

    • is_archived boolean

    • is_channel required boolean

    • is_general boolean

    • is_member boolean

    • is_moved integer

    • is_mpim required boolean

    • is_org_shared required boolean

    • is_pending_ext_shared boolean

    • is_private required boolean

    • is_read_only boolean

    • is_shared required boolean

    • last_read defs_ts

    • latest

    • members required array

    • name required string

    • name_normalized required string

    • num_members integer

    • pending_shared array

    • previous_names array

    • priority integer

    • purpose required object

    • topic required object

    • unlinked integer

    • unread_count integer

    • unread_count_display integer

objs_comment

objs_comments

  • file comments object array

objs_conversation

  • objs_conversation

objs_dnd

  • objs_dnd object
    • dnd_enabled required boolean
    • next_dnd_end_ts required integer
    • next_dnd_start_ts required integer
    • snooze_enabled required boolean

objs_file

  • file object object
    • channels array
    • comments_count integer
    • created integer
    • display_as_bot boolean
    • editable boolean
    • external_type string
    • filetype string
    • groups array
    • id defs_file_id
    • image_exif_rotation integer
    • ims array
    • is_external boolean
    • is_public boolean
    • mimetype string
    • mode string
    • name string
    • original_h integer
    • original_w integer
    • permalink string
    • permalink_public string
    • pinned_info defs_pinned_info
    • pinned_to array
    • pretty_type string
    • public_url_shared boolean
    • reactions array
    • size integer
    • thumb_1024 string
    • thumb_1024_h integer
    • thumb_1024_w integer
    • thumb_160 string
    • thumb_360 string
    • thumb_360_h integer
    • thumb_360_w integer
    • thumb_480 string
    • thumb_480_h integer
    • thumb_480_w integer
    • thumb_64 string
    • thumb_720 string
    • thumb_720_h integer
    • thumb_720_w integer
    • thumb_80 string
    • thumb_800 string
    • thumb_800_h integer
    • thumb_800_w integer
    • thumb_960 string
    • thumb_960_h integer
    • thumb_960_w integer
    • timestamp integer
    • title string
    • url_private string
    • url_private_download string
    • user string
    • username string

objs_file_object_with_id_only

objs_group

  • Group object object
    • created required integer

    • creator required defs_user_id

    • id required defs_group_id

    • is_archived boolean

    • is_group required boolean

    • is_moved integer

    • is_mpim boolean

    • is_open boolean

    • is_pending_ext_shared boolean

    • last_read defs_ts

    • latest

    • members required array

    • name required string

    • name_normalized required string

    • priority integer

    • purpose required object

    • topic required object

    • unread_count integer

    • unread_count_display integer

objs_im

  • IM Object object
    • created required integer
    • id required defs_dm_id
    • is_im required boolean
    • is_org_shared required boolean
    • is_user_deleted required boolean
    • priority integer
    • user required defs_user_id

objs_inviting_user

  • objs_inviting_user object
    • id required defs_user_id
    • is_app_user required boolean
    • is_restricted required boolean
    • is_ultra_restricted required boolean
    • name required string
    • profile required objs_user_profile_shortest
    • real_name string
    • team_id required defs_team
    • updated required number

objs_message

  • Message object object
    • attachments array

      • items object
        • fallback string
        • id required integer
        • image_bytes integer
        • image_height integer
        • image_url string
        • image_width integer
    • bot_id

    • comment objs_comment

    • display_as_bot boolean

    • file objs_file

    • icons object

      • emoji string
    • inviter defs_user_id

    • is_intro boolean

    • last_read defs_ts

    • name string

    • old_name string

    • permalink string

    • pinned_to array

    • purpose string

    • reactions array

    • replies array

    • reply_count integer

    • source_team defs_team

    • subscribed boolean

    • subtype string

    • team defs_team

    • text required string

    • thread_ts defs_ts

    • topic string

    • ts required defs_ts

    • type required string

    • unread_count integer

    • upload boolean

    • user defs_user_id

    • user_profile objs_user_profile_short

    • user_team defs_team

    • username string

objs_paging

  • paging object for files object
    • count required integer
    • page required integer
    • pages integer
    • total required integer

objs_reaction

  • Reaction object object
    • count required integer
    • name required string
    • users required array

objs_scopes

  • objs_scopes array
    • items string

objs_team

  • Team Object object
    • avatar_base_url string
    • domain required string
    • email_domain required string
    • enterprise_id string
    • enterprise_name string
    • has_compliance_export boolean
    • icon required object
      • image_102 string
      • image_132 string
      • image_230 string
      • image_34 string
      • image_44 string
      • image_68 string
      • image_88 string
      • image_default boolean
    • id required defs_team
    • messages_count integer
    • msg_edit_window_mins integer
    • name required string
    • over_integrations_limit boolean
    • over_storage_limit boolean
    • plan string
    • prefs team_prefs_prefs

objs_team_profile_field

  • objs_team_profile_field object
    • field_name string
    • hint required string
    • id required string
    • is_hidden boolean
    • label required string
    • options required array
      • items string
    • ordering required number
    • possible_values array
      • items string
    • type required string (values: text, date, link, mailto, options_list, user)

objs_user

  • objs_user object
    • color required string
    • deleted required boolean
    • has_2fa boolean
    • id required defs_user_id
    • is_admin required boolean
    • is_app_user required boolean
    • is_bot required boolean
    • is_owner required boolean
    • is_primary_owner required boolean
    • is_restricted required boolean
    • is_ultra_restricted required boolean
    • locale string
    • name required string
    • presence string
    • profile required objs_user_profile
    • real_name required string
    • team_id required defs_team
    • tz required string
    • tz_label required string
    • tz_offset required number
    • updated required number

objs_user_profile

  • User profile object object
    • always_active boolean
    • avatar_hash required string
    • display_name required string
    • display_name_normalized required string
    • email string
    • fields object
    • first_name string
    • guest_channels string
    • image_192 required string
    • image_24 required string
    • image_32 required string
    • image_48 required string
    • image_512 string
    • image_72 required string
    • image_original string
    • last_name string
    • phone string
    • real_name required string
    • real_name_normalized required string
    • skype string
    • status_emoji string
    • status_expiration integer
    • status_text string
    • status_text_canonical string
    • team defs_team
    • title string

objs_user_profile_short

  • objs_user_profile_short object
    • avatar_hash required string
    • display_name required string
    • first_name required string
    • image_72 required string
    • is_restricted required boolean
    • is_ultra_restricted required boolean
    • name required string
    • real_name required string
    • team required defs_team

objs_user_profile_shortest

  • objs_user_profile_shortest object
    • avatar_hash required string
    • display_name required string
    • first_name required string
    • image_72 required string
    • real_name required string
    • team required defs_team

prefs_prefs

  • User Prefs object object
    • a11y_animations boolean
    • a11y_font_size string
    • all_channels_loud boolean
    • all_notifications_prefs string
    • all_unreads_sort_order string
    • allow_calls_to_set_current_status boolean
    • allow_cmd_tab_iss boolean
    • analytics_upsell_coachmark_seen boolean
    • arrow_history boolean
    • at_channel_suppressed_channels string
    • box_enabled boolean
    • channel_sort string
    • client_logs_pri string
    • color_names_in_list boolean
    • confirm_clear_all_unreads boolean
    • confirm_sh_call_start boolean
    • confirm_user_marked_away boolean
    • convert_emoticons boolean
    • display_display_names boolean
    • display_real_names_override integer
    • dnd_enabled boolean
    • dnd_end_hour string
    • dnd_start_hour string
    • dropbox_enabled boolean
    • email_alerts string
    • email_alerts_sleep_until integer
    • email_developer boolean
    • email_misc boolean
    • email_offers boolean
    • email_research boolean
    • email_tips boolean
    • email_weekly boolean
    • emoji_autocomplete_big boolean
    • emoji_mode string
    • emoji_use string
    • enable_react_emoji_picker boolean
    • enable_unread_view boolean
    • enhanced_debugging boolean
    • ent_org_wide_channels_sidebar boolean
    • enter_is_special_in_tbt boolean
    • enterprise_excluded_app_teams null
    • enterprise_mdm_custom_msg string
    • enterprise_migration_seen boolean
    • expand_inline_imgs boolean
    • expand_internal_inline_imgs boolean
    • expand_non_media_attachments boolean
    • expand_snippets boolean
    • f_key_search boolean
    • flannel_server_pool string
    • folder_data string
    • folders_enabled boolean
    • frecency_ent_jumper string
    • frecency_ent_jumper_backup string
    • frecency_jumper string
    • full_text_extracts boolean
    • fuller_timestamps boolean
    • gdrive_authed boolean
    • gdrive_enabled boolean
    • graphic_emoticons boolean
    • growls_enabled boolean
    • growth_all_banners_prefs string
    • growth_msg_limit_approaching_cta_count integer
    • growth_msg_limit_approaching_cta_ts integer
    • growth_msg_limit_long_reached_cta_count integer
    • growth_msg_limit_long_reached_cta_last_ts integer
    • growth_msg_limit_reached_cta_count integer
    • growth_msg_limit_reached_cta_last_ts integer
    • growth_msg_limit_sixty_day_banner_cta_count integer
    • growth_msg_limit_sixty_day_banner_cta_last_ts integer
    • has_created_channel boolean
    • has_invited boolean
    • has_recently_shared_a_channel boolean
    • has_searched boolean
    • has_uploaded boolean
    • hide_hex_swatch boolean
    • hide_user_group_info_pane boolean
    • highlight_words string
    • in_interactive_mas_migration_flow boolean
    • intro_to_apps_message_seen boolean
    • jumbomoji boolean
    • k_key_omnibox boolean
    • k_key_omnibox_auto_hide_count integer
    • keyboard null
    • last_seen_at_channel_warning integer
    • last_snippet_type string
    • last_tos_acknowledged string
    • lessons_enabled boolean
    • load_lato_2 boolean
    • locale string
    • locales_enabled object
      • de-DE string
      • en-US string
      • es-ES string
      • fr-FR string
      • ja-JP string
      • pseudo string
    • loud_channels string
    • loud_channels_set string
    • ls_disabled boolean
    • mac_ssb_bounce string
    • mac_ssb_bullet boolean
    • mark_msgs_read_immediately boolean
    • measure_css_usage boolean
    • mentions_exclude_at_channels boolean
    • mentions_exclude_at_user_groups boolean
    • messages_theme string
    • msg_input_send_btn boolean
    • msg_input_send_btn_auto_set boolean
    • msg_preview boolean
    • msg_preview_persistent boolean
    • mute_sounds boolean
    • muted_channels string
    • never_channels string
    • new_msg_snd string
    • newxp_seen_last_message integer
    • no_created_overlays boolean
    • no_invites_widget_in_sidebar boolean
    • no_joined_overlays boolean
    • no_macelectron_banner boolean
    • no_macssb1_banner boolean
    • no_macssb2_banner boolean
    • no_omnibox_in_channels boolean
    • no_text_in_notifications boolean
    • no_winssb1_banner boolean
    • obey_inline_img_limit boolean
    • onboarding_cancelled boolean
    • onboarding_slackbot_conversation_step integer
    • overloaded_message_enabled boolean
    • pagekeys_handled boolean
    • posts_formatting_guide boolean
    • preferred_skin_tone string
    • privacy_policy_seen boolean
    • prompted_for_email_disabling boolean
    • purchaser boolean
    • push_at_channel_suppressed_channels string
    • push_dm_alert boolean
    • push_everything boolean
    • push_idle_wait integer
    • push_loud_channels string
    • push_loud_channels_set string
    • push_mention_alert boolean
    • push_mention_channels string
    • push_show_preview boolean
    • push_sound string
    • require_at boolean
    • search_exclude_bots boolean
    • search_exclude_channels string
    • search_only_current_team boolean
    • search_only_my_channels boolean
    • search_sort string
    • seen_administration_menu boolean
    • seen_app_space_coachmark boolean
    • seen_app_space_tutorial boolean
    • seen_calls_interactive_coachmark boolean
    • seen_channel_browser_admin_coachmark boolean
    • seen_custom_status_badge boolean
    • seen_custom_status_callout boolean
    • seen_domain_invite_reminder boolean
    • seen_emoji_update_overlay_coachmark boolean
    • seen_gdrive_coachmark boolean
    • seen_guest_admin_slackbot_announcement boolean
    • seen_highlights_arrows_coachmark boolean
    • seen_highlights_coachmark boolean
    • seen_highlights_warm_welcome boolean
    • seen_intl_channel_names_coachmark boolean
    • seen_japanese_locale_change_message boolean
    • seen_keyboard_shortcuts_coachmark boolean
    • seen_locale_change_message integer
    • seen_member_invite_reminder boolean
    • seen_name_tagging_coachmark boolean
    • seen_onboarding_banner boolean
    • seen_onboarding_channels boolean
    • seen_onboarding_direct_messages boolean
    • seen_onboarding_invites boolean
    • seen_onboarding_private_groups boolean
    • seen_onboarding_recent_mentions boolean
    • seen_onboarding_search boolean
    • seen_onboarding_slackbot_conversation boolean
    • seen_onboarding_starred_items boolean
    • seen_onboarding_start boolean
    • seen_shared_channels_coachmark boolean
    • seen_shared_channels_opt_in_change_message boolean
    • seen_shdep_slackbot_message boolean
    • seen_single_emoji_msg boolean
    • seen_ssb_prompt boolean
    • seen_threads_notification_banner boolean
    • seen_unread_view_coachmark boolean
    • seen_welcome_2 boolean
    • separate_private_channels boolean
    • separate_shared_channels boolean
    • shdep_promo_code_submitted boolean
    • show_all_skin_tones boolean
    • show_ent_onboarding boolean
    • show_jumper_scores boolean
    • show_memory_instrument boolean
    • show_sidebar_quickswitcher_button boolean
    • show_typing boolean
    • sidebar_behavior string
    • sidebar_theme string
    • sidebar_theme_custom_values string
    • snippet_editor_wrap_long_lines boolean
    • spaces_new_xp_banner_dismissed boolean
    • ss_emojis boolean
    • ssb_space_window string
    • start_scroll_at_oldest boolean
    • tab_ui_return_selects boolean
    • threads_everything boolean
    • time24 boolean
    • two_factor_auth_enabled boolean
    • two_factor_backup_type null
    • two_factor_type null
    • tz string
    • user_colors string
    • webapp_spellcheck boolean
    • welcome_message_hidden boolean
    • whats_new_read integer
    • winssb_run_from_tray boolean
    • winssb_window_flash_behavior string

team_prefs_prefs

  • Team Prefs Object object
    • all_users_can_purchase boolean

    • allow_calls boolean

    • allow_calls_interactive_screen_sharing boolean

    • allow_message_deletion boolean

    • allow_retention_override boolean

    • allow_shared_channel_perms_override boolean

    • app_whitelist_enabled boolean

    • auth_mode string

    • calling_app_name string

    • can_receive_shared_channels_invites boolean

    • compliance_export_start integer

    • custom_status_default_emoji string

    • custom_status_presets array

      • items array
        • items string
    • custom_tos boolean

    • default_channels required array

    • default_rxns array

      • items string
    • disable_email_ingestion boolean

    • disable_file_deleting boolean

    • disable_file_editing boolean

    • disable_file_uploads string

    • disallow_public_file_urls boolean

    • discoverable string

    • display_email_addresses boolean

    • display_real_names boolean

    • dm_retention_duration integer

    • dm_retention_type integer

    • dnd_enabled boolean

    • dnd_end_hour string

    • dnd_start_hour string

    • enable_shared_channels integer

    • enterprise_default_channels array

    • enterprise_mandatory_channels array

    • enterprise_mdm_date_enabled integer

    • enterprise_mdm_level integer

    • enterprise_team_creation_request object

      • is_enabled required boolean
    • file_limit_whitelisted boolean

    • file_retention_duration integer

    • file_retention_type integer

    • gdrive_enabled_team boolean

    • group_retention_duration integer

    • group_retention_type integer

    • hide_referers boolean

    • invites_limit boolean

    • invites_only_admins boolean

    • locale string

    • loud_channel_mentions_limit integer

    • msg_edit_window_mins integer

    • require_at_for_mention boolean

    • retention_duration integer

    • retention_type integer

    • show_join_leave boolean

    • uses_customized_custom_status_presets boolean

    • warn_before_at_channel string

    • who_can_archive_channels string

    • who_can_at_channel string

    • who_can_at_everyone string

    • who_can_change_team_profile string

    • who_can_create_channels string

    • who_can_create_delete_user_groups string

    • who_can_create_groups string

    • who_can_create_shared_channels string

    • who_can_edit_user_groups string

    • who_can_kick_channels string

    • who_can_kick_groups string

    • who_can_manage_guests object

      • type required array
        • items string
    • who_can_manage_integrations object

      • type required array
        • items string
    • who_can_manage_shared_channels object

      • type required array
        • items string
    • who_can_post_general string

    • who_can_post_in_shared_channels object

      • type required array
        • items string
    • who_has_team_visibility string

FAQs

Package last updated on 09 Oct 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts