LAST EDIT Jul 10 2024

Stream Chat has built-in support for user Reactions. Common examples are likes, comments, loves, etc. Reactions can be customized so that you are able to use any type of reaction your application requires.

Similar to other objects in Stream Chat, reactions allow you to add custom data to the reaction of your choice. This is helpful if you want to customize the reaction logic.

message_idstringID of the message to react to
reactionobjectReaction object
reaction.typestringType of the reaction. User could have only 1 reaction of each type per message
reaction.scoreintegerScore of the reaction for cumulative reactions (see example below)1
user_idstringUser ID for server side calls
enforce_uniquebooleanIf set to true, new reaction will replace all reactions the user has (if any) on this messagefalse
Custom data for reactions is limited to 1KB.

Removing a Reaction


Retrieve Reactions


Reactions are being returned as a part of the Message object. Please refer to the Message format section for more details.

Paginating Reactions


Messages returned by the APIs automatically include the 10 most recent reactions. You can also retrieve more reactions and paginate using the following logic, consider that the maximum value for the Limit parameter is 300 and for the Offset parameter is 1000:

Cumulative (Clap) Reactions


You can use the Reactions API to build something similar to Medium's clap reactions. If you are not familiar with this, Medium allows you to clap articles more than once and shows the sum of all claps from all users.

To do this, you only need to include a score for the reaction (ie. user X clapped 25 times) and the API will return the sum of all reaction scores as well as each user's individual scores (ie. clapped 475 times, user Y clapped 14 times).

Query Reactions


This endpoint allow you to query reactions by filtering over type and user on a specific message id.

In case of this endpoint is used client side, the user need to have permission to read channel.

Clearly it is possible to have different call for pagination:

  • first call will fetch 25 reactions

  • the second returns other 5 reactions starting from the latest of the first call