Slack integration setup

This Integration supports multiple instances

Check out the instructions to set up multiple instances here.

The Slack integration allows Rewst users to set up real-time notifications and updates from Rewst directly within Slack. Additionally, Rewst can help with Slack user management, app management, group management, and auth management. The integration also enables users to search and access Rewst content from Slack, saving time and effort. Rewst users can set up triggers and actions that keep the team informed about their task progress or important events.

Setup

  1. Navigate to the integrations page in Rewst.

  2. Click on the Slack integration.

  3. Fill out the configuration form.

  4. Click on the OAuth Configuration Authorize/Re-Authorize button.

  5. Select Allow in the Slack "requesting permissions" popup window.

Actions

Apps

apps.uninstall​

Uninstalls your app from a workspace.

Parameter
Description
Type

client_id

Issued when you created your application.

String

client_secret

Issued when you created your application.

String

token

Authentication token. Requires scope: none

String

Auth

auth.revoke​

Revokes a token.

Parameter
Description
Type

test

Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.

Boolean

token

Authentication token. Requires scope: none

String

auth.test​

Checks authentication & identity.

Parameter
Description
Type

token

Authentication token. Requires scope: none

String

Chat

chat.delete​

Deletes a message.

Parameter
Description
Type

as_user

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.

Boolean

channel

Channel containing the message to be deleted.

String

token

Authentication token. Requires scope: chat:write

String

ts

Timestamp of the message to be deleted.

Number (float)

chat.deleteScheduledMessage​

Deletes a pending scheduled message from the queue.

Parameter
Description
Type

as_user

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.

Boolean

channel*

The channel the scheduled_message is posting to

String

scheduled_message_id*

scheduled_message_id returned from call to chat.scheduleMessage

String

token

Authentication token. Requires scope: chat:write

String

Retrieve a permalink URL for a specific extant message

Parameter
Description
Type

channel*

The ID of the conversation or channel containing the message

String

message_ts*

A message's ts value, uniquely identifying it within a channel

String

token

Authentication token. Requires scope: none

String

chat.meMessage​

Share a me message into a channel.

Parameter
Description
Type

channel

Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.

String

text

Text of the message to send.

String

token

Authentication token. Requires scope: chat:write:user

String

chat.postEphemeral​

Sends an ephemeral message to a user in a channel.

Parameter
Description
Type

as_user

Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.

Boolean

attachments

A JSON-based array of structured attachments, presented as a URL-encoded string.

String

blocks

A JSON-based array of structured blocks, presented as a URL-encoded string.

String

channel*

Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.

String

icon_emoji

Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

String

icon_url

URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

String

link_names

Find and link channel names and usernames.

Boolean

parse

Change how messages are treated. Defaults to none. See below.

String

text

How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.

String

thread_ts

Provide another message's ts value to post this message in a thread. Avoid using a reply's ts value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread.

String

token

Authentication token. Requires scope: chat:write

String

user*

id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.

String

username

Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

String

chat.postMessage​

Sends a message to a channel.

Parameter
Description
Type

attachments

A JSON-based array of structured attachments, presented as a URL-encoded string.

String

blocks

A JSON-based array of structured blocks, presented as a URL-encoded string.

String

channel*

Channel, private group, or IM channel to send message to. Note: the App must first be invited to private channels first

String

icon_emoji

Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

String

icon_url

URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

String

link_names

Find and link channel names and usernames.

Boolean

mrkdwn

Disable Slack markup parsing by setting to false. Enabled by default.

Boolean

parse

Change how messages are treated. Defaults to none. See below.

String

reply_broadcast

Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.

Boolean

text

How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.

String

thread_ts

Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.

String

unfurl_links

Pass true to enable unfurling of primarily text-based content.

Boolean

unfurl_media

Pass false to disable unfurling of media content.

Boolean

username

Set your bot's user name. See authorship below.

String

chat.scheduledMessages.list​

Returns a list of scheduled messages.

Parameter
Description
Type

channel

The channel of the scheduled messages

String

cursor

For pagination purposes, this is the cursor value returned from a previous call to chat.scheduledmessages.list indicating where you want to start this call from.

String

latest

A UNIX timestamp of the latest value in the time range

Number (float)

limit

Maximum number of original entries to return.

Integer

oldest

A UNIX timestamp of the oldest value in the time range

Number (float)

token

Authentication token. Requires scope: none

String

chat.scheduleMessage​

Schedules a message to be sent to a channel.

Parameter
Description
Type

as_user

Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See chat.postMessage.

Boolean

attachments

A JSON-based array of structured attachments, presented as a URL-encoded string.

String

blocks

A JSON-based array of structured blocks, presented as a URL-encoded string.

String

channel

Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See below for more details.

String

link_names

Find and link channel names and usernames.

Boolean

parse

Change how messages are treated. Defaults to none. See chat.postMessage.

String

post_at

Unix EPOCH timestamp of time in future to send the message.

String

reply_broadcast

Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.

Boolean

text

How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.

String

thread_ts

Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.

Number (float)

token

Authentication token. Requires scope: chat:write

String

unfurl_links

Pass true to enable unfurling of primarily text-based content.

Boolean

unfurl_media

Pass false to disable unfurling of media content.

Boolean

chat.unfurl​

Provide custom unfurl behavior for user-posted URLs

Parameter
Description
Type

channel*

Channel ID of the message

String

token

Authentication token. Requires scope: links:write

String

ts*

Timestamp of the message to add unfurl behavior to.

String

unfurls

URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.

String

user_auth_message

Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior

String

user_auth_required

Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain

Boolean

user_auth_url

Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.

String

chat.update​

Updates a message.

Parameter
Description
Type

as_user

Pass true to update the message as the authed user. Bot users in this context are considered authed users.

String

attachments

A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text.

String

blocks

A JSON-based array of structured blocks, presented as a URL-encoded string.

String

channel*

Channel containing the message to be updated.

String

link_names

Find and link channel names and usernames. Defaults to none. See below.

String

parse

Change how messages are treated. Defaults to client, unlike chat.postMessage. Accepts either none or full. See below.

String

text

New text for the message, using the default formatting rules. It's not required when presenting attachments.

String

token

Authentication token. Requires scope: chat:write

String

ts*

Timestamp of the message to be updated.

String

Conversations

conversations.archive​

Archives a conversation.

Parameter
Description
Type

channel

ID of conversation to archive

String

token

Authentication token. Requires scope: conversations:write

String

conversations.close​

Closes a direct message or multi-person direct message.

Parameter
Description
Type

channel

Conversation to close.

String

token

Authentication token. Requires scope: conversations:write

String

conversations.create​

Initiates a public or private channel-based conversation

Parameter
Description
Type

is_private

Create a private channel instead of a public one

Boolean

name

Name of the public or private channel to create

String

token

Authentication token. Requires scope: conversations:write

String

user_ids

Required for workspace apps. A list of between 1 and 30 human users that will be added to the newly-created conversation. This argument has no effect when used by classic Slack apps.

String

conversations.history​

Fetches a conversation's history of messages and events.

Parameter
Description
Type

channel

Conversation ID to fetch history for.

String

cursor

Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection.

String

inclusive

Include messages with latest or oldest timestamp in results only when either timestamp is specified.

Boolean

latest

End of time range of messages to include in results.

Number (float)

limit

The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.

Integer

oldest

Start of time range of messages to include in results.

Number (float)

token

Authentication token. Requires scope: conversations:history

String

conversations.info​

Retrieve information about a conversation.

Parameter
Description
Type

channel

Conversation ID to learn more about

String

include_locale

Set this to true to receive the locale for this conversation. Defaults to false

Boolean

include_num_members

Set to true to include the member count for the specified conversation. Defaults to false

Boolean

token

Authentication token. Requires scope: conversations:read

String

conversations.invite​

Invites users to a channel.

Parameter
Description
Type

channel

The ID of the public or private channel to invite user(s) to.

String

token

Authentication token. Requires scope: conversations:write

String

users

A comma separated list of user IDs. Up to 1000 users may be listed.

String

conversations.join​

Joins an existing conversation.

Parameter
Description
Type

channel

ID of conversation to join

String

token

Authentication token. Requires scope: channels:write

String

conversations.kick​

Removes a user from a conversation.

Parameter
Description
Type

channel

ID of conversation to remove user from.

String

token

Authentication token. Requires scope: conversations:write

String

user

User ID to be removed.

String

conversations.leave​

Leaves a conversation.

Parameter
Description
Type

channel

Conversation to leave

String

token

Authentication token. Requires scope: conversations:write

String

conversations.list​

Lists all channels in a Slack team.

Parameter
Description
Type

cursor

Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection.

String

exclude_archived

Set to true to exclude archived channels from the list

Boolean

limit

The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.

Integer

token

Authentication token. Requires scope: conversations:read

String

types

Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im

String

conversations.members​

Retrieve members of a conversation.

Parameter
Description
Type

channel

ID of the conversation to retrieve members for

String

cursor

Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection.

String

limit

The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.

Integer

token

Authentication token. Requires scope: conversations:read

String

conversations.open​

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

Parameter
Description
Type

channel

Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead.

String

return_im

Boolean, indicates you want the full IM channel definition in the response.

Boolean

token

Authentication token. Requires scope: conversations:write

String

users

Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a channel when not supplying users.

String

conversations.rename​

Renames a conversation.

Parameter
Description
Type

channel

ID of conversation to rename

String

name

New name for conversation.

String

token

Authentication token. Requires scope: conversations:write

String

conversations.replies​

Retrieve a thread of messages posted to a conversation

Parameter
Description
Type

channel

Conversation ID to fetch thread from.

String

cursor

Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection.

String

inclusive

Include messages with latest or oldest timestamp in results only when either timestamp is specified.

Boolean

latest

End of time range of messages to include in results.

Number (float)

limit

The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.

Integer

oldest

Start of time range of messages to include in results.

Number (float)

token

Authentication token. Requires scope: conversations:history

String

ts

Unique identifier of a thread's parent message.

Number (float)

conversations.setPurpose​

Sets the purpose for a conversation.

Parameter
Description
Type

channel

Conversation to set the purpose of

String

purpose

A new, specialer purpose

String

token

Authentication token. Requires scope: conversations:write

String