Select your Platform:
Reactions
Confused about "Reactions"?
Let us know how we can improve our documentation:
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.
| name | type | description | default | optional |
|---|---|---|---|---|
| message_id | string | ID of the message to react to | ||
| reaction | object | Reaction object | ||
| reaction.type | string | Type of the reaction. User could have only 1 reaction of each type per message | ||
| reaction.score | integer | Score of the reaction for cumulative reactions (see example below) | 1 | ✓ |
| user_id | string | User ID for server side calls | ✓ | |
| enforce_unique | boolean | If set to true, new reaction will replace all reactions the user has (if any) on this message | false | ✓ |
Removing a Reaction
Copied!Confused about "Removing a Reaction"?
Let us know how we can improve our documentation:
Retrieve Reactions
Copied!Confused about "Retrieve Reactions"?
Let us know how we can improve our documentation:
Reactions are being returned as a part of the Message object. Please refer to the Message format section for more details.
Paginating Reactions
Copied!Confused about "Paginating Reactions"?
Let us know how we can improve our documentation:
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
Copied!Confused about "Cumulative (Clap) Reactions"?
Let us know how we can improve our documentation:
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).
