Slack. Web. Reactions
(SlackKit v1.0.0-alpha.0)
View Source
Summary
Functions
Adds a reaction to an item.
Gets reactions for an item.
Lists reactions made by a user.
Removes a reaction from an item.
Functions
Adds a reaction to an item.
API reference
Rate limit: Tier 3: 50+ per minute
Scopes:
- Bot token:
reactions:write - User token:
reactions:write
Required Params
channel- Channel where the message to add reaction to was posted. Specify onlychannelandtimestampinstead.name- Reaction (emoji) name ex:thumbsuptimestamp- Timestamp of the message to add reaction to. Specify onlychannelandtimestampinstead.
Errors the API can return:
already_reacted- The specified item already has the user/reaction combination.bad_timestamp- Value passed fortimestampwas invalid.channel_not_found- Value passed forchannelis invalid.external_channel_migrating- The channel is in the process of being migrated.invalid_name- Value passed fornamewas invalid.is_archived- Channel specified has been archived.message_not_found- Message specified bychannelandtimestampdoes not exist.no_access- User does not have access to react to this canvas.no_item_specified- combination ofchannelandtimestampwas not specified.not_reactable- Whatever you passed in, like afileorfile_comment, can't be reacted to anymore. Your app can react to messages though.thread_locked- Reactions are disabled as the specified message is part of a locked thread.too_many_emoji- The limit for distinct reactions (i.e emoji) on the item has been reached.too_many_reactions- The limit for reactions a person may add to the item has been reached.
See the Common Errors guide for errors returned by every Web API method.
Gets reactions for an item.
API reference
Rate limit: Tier 3: 50+ per minute
Scopes:
- Bot token:
reactions:read - User token:
reactions:read
Optional Params
channel- Channel where the message to get reactions for was posted. ex:C0NF841BKfile- File to get reactions for. ex:F1234567890file_comment- File comment to get reactions for.full- If true always return the complete reaction list.timestamp- Timestamp of the message to get reactions for. ex:1524523204.000192
Errors the API can return:
bad_timestamp- Value passed fortimestampwas invalid.channel_not_found- Value passed forchannelwas invalid.file_comment_not_found- File comment specified byfile_commentdoes not exist.file_not_found- File specified byfiledoes not exist.message_not_found- Message specified bychannelandtimestampdoes not exist.no_item_specified-file,file_comment, or combination ofchannelandtimestampwas not specified.
See the Common Errors guide for errors returned by every Web API method.
Lists reactions made by a user.
API reference
Rate limit: Tier 2: 20+ per minute
Scopes:
- Bot token:
reactions:read - User token:
reactions:read
Optional Params
count-cursor- Parameter for pagination. Setcursorequal to thenext_cursorattribute returned by the previous request'sresponse_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details. ex:dXNlcjpVMDYxTkZUVDI=full- If true always return the complete reaction list.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. 0 ex:20page-team_id- encoded team id to list reactions in, required if org token is useduser- Show reactions made by this user. Defaults to the authed user.
Errors the API can return:
user_not_found- Value passed foruserwas invalid.
See the Common Errors guide for errors returned by every Web API method.
Removes a reaction from an item.
API reference
Rate limit: Tier 2: 20+ per minute
Scopes:
- Bot token:
reactions:write - User token:
reactions:write
Required Params
name- Reaction (emoji) name. ex:thumbsup
Optional Params
channel- Channel where the message to remove reaction from was posted. One offile,file_comment, or the combination ofchannelandtimestampmust be specified.file- File to remove reaction from. One offile,file_comment, or the combination ofchannelandtimestampmust be specified.file_comment- File comment to remove reaction from. One offile,file_comment, or the combination ofchannelandtimestampmust be specified.timestamp- Timestamp of the message to remove reaction from. One offile,file_comment, or the combination ofchannelandtimestampmust be specified.
Errors the API can return:
bad_timestamp- Value passed fortimestampwas invalid.channel_not_found- The specified channel was not found.external_channel_migrating- The reaction is in a channel that is being migratedfile_comment_not_found- File comment specified byfile_commentdoes not exist.file_not_found- File specified byfiledoes not exist.invalid_name- Value passed fornamewas invalid.message_not_found- Message specified bychannelandtimestampdoes not exist.no_access- The requestor does not have permission to perform this action on the specified item.no_item_specified-file,file_comment, or combination ofchannelandtimestampwas not specified.no_reaction- The specified reaction does not exist, or the requestor is not the original reaction author.thread_locked- Reactions are disabled as the specified message is part of a locked thread.
See the Common Errors guide for errors returned by every Web API method.