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
Navigate to the integrations page in Rewst.
Click on the Slack integration.
Fill out the configuration form.
Click on the OAuth Configuration Authorize/Re-Authorize button.
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: | String |
Auth
auth.revokeβ
Revokes a token.
Parameter | Description | Type |
---|---|---|
test | Setting this parameter to | Boolean |
token | Authentication token. Requires scope: | String |
auth.testβ
Checks authentication & identity.
Parameter | Description | Type |
---|---|---|
token | Authentication token. Requires scope: | String |
Chat
chat.deleteβ
Deletes a message.
Parameter | Description | Type |
---|---|---|
as_user | Pass true to delete the message as the authed user with | Boolean |
channel | Channel containing the message to be deleted. | String |
token | Authentication token. Requires scope: | 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 | Boolean |
channel* | The channel the scheduled_message is posting to | String |
scheduled_message_id* |
| String |
token | Authentication token. Requires scope: | String |
chat.getPermalinkβ
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 | String |
token | Authentication token. Requires scope: | 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: | 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 | String |
icon_url | URL to an image to use as the icon for this message. Must be used in conjunction with | String |
link_names | Find and link channel names and usernames. | Boolean |
parse | Change how messages are treated. Defaults to | 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 | String |
token | Authentication token. Requires scope: | String |
user* |
| String |
username | Set your bot's user name. Must be used in conjunction with | 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 | String |
icon_url | URL to an image to use as the icon for this message. Must be used in conjunction with | String |
link_names | Find and link channel names and usernames. | Boolean |
mrkdwn | Disable Slack markup parsing by setting to | Boolean |
parse | Change how messages are treated. Defaults to | String |
reply_broadcast | Used in conjunction with | 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 | 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 | 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: | 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 | String |
post_at | Unix EPOCH timestamp of time in future to send the message. | String |
reply_broadcast | Used in conjunction with | 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 | Number (float) |
token | Authentication token. Requires scope: | 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: | 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 | 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 | 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 | String |
parse | Change how messages are treated. Defaults to | String |
text | New text for the message, using the default formatting rules. It's not required when presenting | String |
token | Authentication token. Requires scope: | 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: | 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: | 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: | 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 | 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: | String |
conversations.infoβ
Retrieve information about a conversation.
Parameter | Description | Type |
---|---|---|
channel | Conversation ID to learn more about | String |
include_locale | Set this to | Boolean |
include_num_members | Set to | Boolean |
token | Authentication token. Requires scope: | 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: | 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: | 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: | 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: | String |
conversations.listβ
Lists all channels in a Slack team.
Parameter | Description | Type |
---|---|---|
cursor | Paginate through collections of data by setting the | String |
exclude_archived | Set to | 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: | String |
types | Mix and match channel types by providing a comma-separated list of any combination of | 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 | 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: | String |
conversations.openβ
Opens or resumes a direct message or multi-person direct message.
Parameter | Description | Type |
---|---|---|
channel | Resume a conversation by supplying an | String |
return_im | Boolean, indicates you want the full IM channel definition in the response. | Boolean |
token | Authentication token. Requires scope: | 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 | 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: | 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 | 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: | 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: | String |
conversations.setTopicβ
Sets the topic for a conversation.
Parameter | Description | Type |
---|---|---|
channel | Conversation to set the topic of | String |
token | Authentication token. Requires scope: | String |
topic | The new topic string. Does not support formatting or linkification. | String |
conversations.unarchiveβ
Reverses conversation archival.
Parameter | Description | Type |
---|---|---|
channel | ID of conversation to unarchive | String |
token | Authentication token. Requires scope: | String |
Dialog
dialog.openβ
Open a dialog with a user
Parameter | Description | Type |
---|---|---|
dialog* | The dialog definition. This must be a JSON-encoded string. | String |
token | Authentication token. Requires scope: | String |
trigger_id* | Exchange a trigger to post to the user. | String |
Files
files.comments.addβ
Add a comment to an existing file.
Parameter | Description | Type |
---|---|---|
token | String | |
comment* | String | |
file* | String |
files.comments.deleteβ
Deletes an existing comment on a file.
Parameter | Description | Type |
---|---|---|
file | File to delete a comment from. | String |
id | The comment to delete. | String |
token | Authentication token. Requires scope: | String |
files.comments.editβ
Edit an existing file comment.
Parameter | Description | Type |
---|---|---|
token | String | |
comment* | String | |
file* | String | |
id* | String |
files.deleteβ
Deletes a file.
Parameter | Description | Type |
---|---|---|
file | ID of file to delete. | String |
token | Authentication token. Requires scope: | String |
files.infoβ
Gets information about a team file.
Parameter | Description | Type |
---|---|---|
count | String | |
cursor | Parameter for pagination. File comments are paginated for a single file. Set | String |
file | Specify a file by providing its ID. | 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 list hasn't been reached. | Integer |
page | String | |
token | Authentication token. Requires scope: | String |
files.listβ
Lists & filters team files.
Parameter | Description | Type |
---|---|---|
channel | Filter files appearing in a specific channel, indicated by its ID. | String |
count | String | |
page | String | |
show_files_hidden_by_limit | Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit. | Boolean |
token | Authentication token. Requires scope: | String |
ts_from | Filter files created after this timestamp (inclusive). | Number (float) |
ts_to | Filter files created before this timestamp (inclusive). | Number (float) |
types | Filter files by type. You can pass multiple values in the types argument, like | String |
user | Filter files created by a single user. | String |
files.remote.addβ
Adds a file from a remote service
Parameter | Description | Type |
---|---|---|
external_id | Creator defined GUID for the file. | String |
external_url | URL of the remote file. | String |
filetype | type of file | String |
indexable_file_contents | A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file. | String |
preview_image | Preview of the document via | String |
title | Title of the file being shared. | String |
token | Authentication token. Requires scope: | String |
files.remote.infoβ
Retrieve information about a remote file added to Slack
Parameter | Description | Type |
---|---|---|
external_id | Creator defined GUID for the file. | String |
file | Specify a file by providing its ID. | String |
token | Authentication token. Requires scope: | String |
files.remote.listβ
Retrieve information about a remote file added to Slack
Parameter | Description | Type |
---|---|---|
channel | Filter files appearing in a specific channel, indicated by its ID. | String |
cursor | Paginate through collections of data by setting the | String |
limit | The maximum number of items to return. | Integer |
token | Authentication token. Requires scope: | String |
ts_from | Filter files created after this timestamp (inclusive). | Number (float) |
ts_to | Filter files created before this timestamp (inclusive). | Number (float) |
files.remote.removeβ
Remove a remote file.
Parameter | Description | Type |
---|---|---|
external_id | Creator defined GUID for the file. | String |
file | Specify a file by providing its ID. | String |
token | Authentication token. Requires scope: | String |
files.remote.shareβ
Share a remote file into a channel.
Parameter | Description | Type |
---|---|---|
channels | Comma-separated list of channel IDs where the file will be shared. | String |
external_id | Creator defined GUID for the file. | String |
file | Specify a file by providing its ID. | String |
token | Authentication token. Requires scope: | String |
files.remote.updateβ
Updates an existing remote file.
Parameter | Description | Type |
---|---|---|
external_id | Creator defined GUID for the file. | String |
external_url | URL of the remote file. | String |
file | Specify a file by providing its ID. | String |
filetype | type of file | String |
indexable_file_contents | File containing contents that can be used to improve searchability for the remote file. | String |
preview_image | Preview of the document via | String |
title | Title of the file being shared. | String |
token | Authentication token. Requires scope: | String |
files.revokePublicURLβ
Revokes public/external sharing access for a file
Parameter | Description | Type |
---|---|---|
file | File to revoke | String |
token | Authentication token. Requires scope: | String |
files.sharedPublicURLβ
Enables a file for public/external sharing.
Parameter | Description | Type |
---|---|---|
file | File to share | String |
token | Authentication token. Requires scope: | String |
Post Confirmation Message
Post Confirmationβ
Sends a Slack message with approve and deny options and pauses the workflow until a response is received
Parameter | Description | Type |
---|---|---|
Channel* | String | |
message* | String | |
Buttons | A list of buttons that can be used to resume the workflow | Array Buttons |
Buttonsβ
Parameter | Description | Type |
---|---|---|
Label | String | |
Value | String | |
Style | String |
Reminders
reminders.addβ
Creates a reminder.
Parameter | Description | Type |
---|---|---|
text | The content of the reminder | String |
time | When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday") | String |
token | Authentication token. Requires scope: | String |
user | The user who will receive the reminder. If no user is specified, the reminder will go to user who created it. | String |
reminders.completeβ
Marks a reminder as complete.
Parameter | Description | Type |
---|---|---|
reminder | The ID of the reminder to be marked as complete | String |
token | Authentication token. Requires scope: | String |
reminders.deleteβ
Deletes a reminder.
Parameter | Description | Type |
---|---|---|
reminder | The ID of the reminder | String |
token | Authentication token. Requires scope: | String |
reminders.infoβ
Gets information about a reminder.
Parameter | Description | Type |
---|---|---|
reminder | The ID of the reminder | String |
token | Authentication token. Requires scope: | String |
reminders.listβ
Lists all reminders created by or for a given user.
Parameter | Description | Type |
---|---|---|
token | Authentication token. Requires scope: | String |
Usergroups
usergroups.createβ
Create a User Group
Parameter | Description | Type |
---|---|---|
channels | A comma separated string of encoded channel IDs for which the User Group uses as a default. | String |
description | A short description of the User Group. | String |
handle | A mention handle. Must be unique among channels, users and User Groups. | String |
include_count | Include the number of users in each User Group. | Boolean |
name* | A name for the User Group. Must be unique among User Groups. | String |
token | Authentication token. Requires scope: | String |
usergroups.disableβ
Disable an existing User Group
Parameter | Description | Type |
---|---|---|
include_count | Include the number of users in the User Group. | Boolean |
token | Authentication token. Requires scope: | String |
usergroup* | The encoded ID of the User Group to disable. | String |
usergroups.enableβ
Enable a User Group
Parameter | Description | Type |
---|---|---|
include_count | Include the number of users in the User Group. | Boolean |
token | Authentication token. Requires scope: | String |
usergroup* | The encoded ID of the User Group to enable. | String |
usergroups.listβ
List all User Groups for a team
Parameter | Description | Type |
---|---|---|
include_count | Include the number of users in each User Group. | Boolean |
include_disabled | Include disabled User Groups. | Boolean |
include_users | Include the list of users for each User Group. | Boolean |
token | Authentication token. Requires scope: | String |
usergroups.updateβ
Update an existing User Group
Parameter | Description | Type |
---|---|---|
channels | A comma separated string of encoded channel IDs for which the User Group uses as a default. | String |
description | A short description of the User Group. | String |
handle | A mention handle. Must be unique among channels, users and User Groups. | String |
include_count | Include the number of users in the User Group. | Boolean |
name | A name for the User Group. Must be unique among User Groups. | String |
token | Authentication token. Requires scope: | String |
usergroup* | The encoded ID of the User Group to update. | String |
usergroups.users.listβ
List all users in a User Group
Parameter | Description | Type |
---|---|---|
include_disabled | Allow results that involve disabled User Groups. | Boolean |
token | Authentication token. Requires scope: | String |
usergroup* | The encoded ID of the User Group to update. | String |
usergroups.users.updateβ
Update the list of users for a User Group
Parameter | Description | Type |
---|---|---|
include_count | Include the number of users in the User Group. | Boolean |
token | Authentication token. Requires scope: | String |
usergroup* | The encoded ID of the User Group to update. | String |
users* | A comma separated string of encoded user IDs that represent the entire list of users for the User Group. | String |
Users
users.conversationsβ
List conversations the calling user may access.
Parameter | Description | Type |
---|---|---|
cursor | Paginate through collections of data by setting the | String |
exclude_archived | Set to | 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: | String |
types | Mix and match channel types by providing a comma-separated list of any combination of | String |
user | Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership. | String |
users.identityβ
Get a user's identity.
Parameter | Description | Type |
---|---|---|
token | Authentication token. Requires scope: | String |
users.infoβ
Gets information about a user.
Parameter | Description | Type |
---|---|---|
include_locale | Set this to | Boolean |
token | Authentication token. Requires scope: | String |
user | User to get info on | String |
users.listβ
Lists all users in a Slack team.
Parameter | Description | Type |
---|---|---|
cursor | Paginate through collections of data by setting the | String |
include_locale | Set this to | 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 users list hasn't been reached. | Integer |
token | Authentication token. Requires scope: | String |
users.lookupByEmailβ
Find a user with an email address.
Parameter | Description | Type |
---|---|---|
An email address belonging to a user in the workspace | String | |
token | Authentication token. Requires scope: | String |
Views
views.openβ
Open a view for a user.
Parameter | Description | Type |
---|---|---|
token | Authentication token. Requires scope: | String |
trigger_id* | Exchange a trigger to post to the user. | String |
view* | A view payload. This must be a JSON-encoded string. | String |
views.publishβ
Publish a static view for a User.
Parameter | Description | Type |
---|---|---|
hash | A string that represents view state to protect against possible race conditions. | String |
token | Authentication token. Requires scope: | String |
user_id* |
| String |
view* | A view payload. This must be a JSON-encoded string. | String |
views.pushβ
Push a view onto the stack of a root view.
Parameter | Description | Type |
---|---|---|
token | Authentication token. Requires scope: | String |
trigger_id* | Exchange a trigger to post to the user. | String |
view* | A view payload. This must be a JSON-encoded string. | String |
views.updateβ
Update an existing view.
Parameter | Description | Type |
---|---|---|
external_id | A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either | String |
hash | A string that represents view state to protect against possible race conditions. | String |
token | Authentication token. Requires scope: | String |
view | A view payloadThis must be a JSON-encoded string. | String |
view_id | A unique identifier of the view to be updated. Either | String |
Last updated