Select your Platform:
Threads & Replies
Confused about "Threads & Replies"?
Let us know how we can improve our documentation:
Threads and replies provide your users with a way to go into more detail about a specific topic.
This can be very helpful to keep the conversation organized and reduce noise. To create a thread you simply send a message with a parent_id. Have a look at the example below:
show_in_channel, the message will be visible both in a thread of replies as well as the main channel.Messages inside a thread can also have reactions, attachments and mention as any other message.
Thread Pagination
Copied!Confused about "Thread Pagination"?
Let us know how we can improve our documentation:
When you read a channel you do not receive messages inside threads. The parent message includes the count of replies which it is usually what apps show as the link to the thread screen. Reading a thread and paginating its messages works in a very similar way as paginating a channel.
Quote Message
Copied!Confused about "Quote Message"?
Let us know how we can improve our documentation:
Instead of replying in a thread, it's also possible to quote a message. Quoting a message doesn't result in the creation of a thread; the message is quoted inline.
To quote a message, simply provide the quoted_message_id field when sending a message:
Based on the provided quoted_message_id, the quoted_message field is automatically enriched when querying channels with messages. Example response:
channel.query() or querying message by its ID. Example: Message A quotes Message B and Message B quotes Message C. In this case it's not possible to access Message C through Message A directly. You have to fetch Message B from API in order to access itThread List
Copied!Confused about "Thread List"?
Let us know how we can improve our documentation:
Query Threads
Copied!Confused about "Query Threads"?
Let us know how we can improve our documentation:
It is possible to query the list of threads that current user is participant of. This is useful to create thread list similar to what slack or discord has. Response will include threads with unread replies first, sorted by the latest reply timestamp in descending order. Threads with no unread replies will follow, also sorted by the latest reply timestamp in descending order.
You can also paginate over the thread list or request specific number of latest replies per thread.
Following is the list of supported options for querying threads:
| name | type | description | default | optional |
|---|---|---|---|---|
| reply_limit | number | Number of latest replies to fetch per thread | 2 | ✓ |
| participant_limit | number | Number of thread participants to request per thread | 100 | ✓ |
| limit | number | Maximum number of threads to return in response | 10 | ✓ |
| watch | boolean | If true, all the channels corresponding to threads returned in response will be watched | true | ✓ |
| member_limit | number | Number of members to request per thread channel | 100 | ✓ |
Event Handling Of Thread List
Copied!Confused about "Event Handling Of Thread List"?
Let us know how we can improve our documentation:
Only participants of the thread receive an event whenever there is a new reply on the thread - notification.thread_message_new. The content of this event is similar to message.new event.
Updates to the thread messages should be handled as usual via message.updated and message.deleted event
Minimalistic React JS example of how to use threads and update the UI when a new message is added to a thread can be found in the linked gist
Get Thread By ID
Copied!Confused about "Get Thread By ID"?
Let us know how we can improve our documentation:
This endpoint returns a thread by the given threadId.
Update Thread Title and Custom Data
Copied!Confused about "Update Thread Title and Custom Data"?
Let us know how we can improve our documentation:
You can assign a title and any additional custom data to each thread.
Similarly to remove any custom property from thread:
Threads Unread Count
Copied!Confused about "Threads Unread Count"?
Let us know how we can improve our documentation:
Total number of unread threads is available in response of connectUser endpoint
If you would like to mark specific thread as read or unread, you can do that as following
To get unread count per thread for a current user, you can use the getUnreadCount endpoint as following