Skip to content

feat(docs): chat-summary: add summary object in thread getters and update changelogs (ME-883 part 3/3) #1601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 22, 2025
Merged

feat(docs): chat-summary: add summary object in thread getters and update changelogs (ME-883 part 3/3) #1601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4878f8e
ME-883: add summary object in thread getters and update changelogs
kacperf531 Oct 21, 2025
2f17cc8
Apply suggestions from code review
kacperf531 Oct 22, 2025
abd4539
remove info about requried plan for the feature
kacperf531 Oct 22, 2025
9e833aa
Update src/pages/messaging/agent-chat-api/changelog/index.mdx
kacperf531 Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/pages/management/changelog/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ Use [**Update an account**](/authorization/global-accounts-api#tag/Accounts/path
- The [**Configuration**](/management/webhooks/v3.6#configuration) webhooks now contain a new `requester` property. The property contains details of who triggered the webhook: `user_id`, `client_id` and `account_id`.
- There are new webhooks:
- [**event_deleted**](/management/webhooks/#event_deleted)
- [**thread_summary_set**](/management/webhooks/#thread_summary_set)
- The **incoming_customer** webhook was removed.

### Other
Expand Down
4 changes: 4 additions & 0 deletions src/pages/messaging/agent-chat-api/changelog/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,10 @@ The developer preview version provides a preview of the upcoming changes to the

- There's a new method, **Send Thinking Indicator** ([Web](/messaging/agent-chat-api/#send-thinking-indicator) & [RTM](/messaging/agent-chat-api/rtm-reference/#send-thinking-indicator)).
- There's a new push, [**incoming_thinking_indicator**](/messaging/agent-chat-api/rtm-pushes/#incoming_thinking_indicator).
- Added a new thread summary feature that can be configured using the `chats.auto_summary_enabled` license property (see [**Update License Properties**](/management/configuration-api/#update-license-properties).)
- There's a new method, **Request Thread Summary** ([Web](/messaging/agent-chat-api/#request-thread-summary) & [RTM](/messaging/agent-chat-api/rtm-reference/#request-thread-summary)).
- There's a new push, [**thread_summary_set**](/messaging/agent-chat-api/rtm-pushes/#thread_summary_set).
- A new object, `summary`, is returned for **Get Chat**, **List Archives**, and **List Threads** responses for threads that have been summarized.

## [v3.5] - 2022-11-23

Expand Down
15 changes: 15 additions & 0 deletions src/pages/messaging/agent-chat-api/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,11 @@ curl -X POST \
"text": "Hello",
"author_id": "[email protected]"
}],
"summary": { //optional
"status": "ok",
"text": "• Agent greets with a short message.",
"updated_at": "2025-10-21T07:08:16.125000Z"
},
"properties": {
// "Property" object
},
Expand Down Expand Up @@ -410,6 +415,11 @@ curl -X POST \
"text": "Hello",
"author_id": "[email protected]"
}],
"summary": { //optional
"status": "ok",
"text": "• Agent greets with a short message.",
"updated_at": "2025-10-21T07:08:16.125000Z"
},
"properties": {
"0805e283233042b37f460ed8fbf22160": {
"string_property": "string_value"
Expand Down Expand Up @@ -646,6 +656,11 @@ curl -X POST \
"author_id": "[email protected]"
}
],
"summary": { //optional
"status": "ok",
"text": "• Agent greets with a short message.",
"updated_at": "2025-10-21T07:08:16.125000Z"
},
"properties": {
"0805e283233042b37f460ed8fbf22160": {
"thread_property": "property_value"
Expand Down
15 changes: 15 additions & 0 deletions src/pages/messaging/agent-chat-api/rtm-reference/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,11 @@ You cannot use either `limit` and `min_events_count` or `filters` and `min_event
"text": "Hello",
"author_id": "[email protected]"
}],
"summary": { //optional
"status": "ok",
"text": "• Agent greets with a short message.",
"updated_at": "2025-10-21T07:08:16.125000Z"
},
"properties": {
// "Property" object
},
Expand Down Expand Up @@ -467,6 +472,11 @@ It returns a thread that the current Agent has access to in a given chat.
"text": "Hello",
"author_id": "[email protected]"
}],
"summary": { //optional
"status": "ok",
"text": "• Agent greets with a short message.",
"updated_at": "2025-10-21T07:08:16.125000Z"
},
"properties": {
"0805e283233042b37f460ed8fbf22160": {
"string_property": "string_value"
Expand Down Expand Up @@ -704,6 +714,11 @@ You can pass only one of the following values at a time: `values` or `exclude_va
"author_id": "[email protected]"
}
],
"summary": { //optional
"status": "ok",
"text": "• Agent greets with a short message.",
"updated_at": "2025-10-21T07:08:16.125000Z"
},
"properties": {
"0805e283233042b37f460ed8fbf22160": {
"thread_property": "property_value"
Expand Down
15 changes: 15 additions & 0 deletions src/pages/messaging/agent-chat-api/v3.7/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,11 @@ curl -X POST \
"text": "Hello",
"author_id": "[email protected]"
}],
"summary": { //optional
"status": "ok",
"text": "• Agent greets with a short message.",
"updated_at": "2025-10-21T07:08:16.125000Z"
},
"properties": {
// "Property" object
},
Expand Down Expand Up @@ -410,6 +415,11 @@ curl -X POST \
"text": "Hello",
"author_id": "[email protected]"
}],
"summary": { //optional
"status": "ok",
"text": "• Agent greets with a short message.",
"updated_at": "2025-10-21T07:08:16.125000Z"
},
"properties": {
"0805e283233042b37f460ed8fbf22160": {
"string_property": "string_value"
Expand Down Expand Up @@ -646,6 +656,11 @@ curl -X POST \
"author_id": "[email protected]"
}
],
"summary": { //optional
"status": "ok",
"text": "• Agent greets with a short message.",
"updated_at": "2025-10-21T07:08:16.125000Z"
},
"properties": {
"0805e283233042b37f460ed8fbf22160": {
"thread_property": "property_value"
Expand Down
15 changes: 15 additions & 0 deletions src/pages/messaging/agent-chat-api/v3.7/rtm-reference/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,11 @@ You cannot use either `limit` and `min_events_count` or `filters` and `min_event
"text": "Hello",
"author_id": "[email protected]"
}],
"summary": { //optional
"status": "ok",
"text": "• Agent greets with a short message.",
"updated_at": "2025-10-21T07:08:16.125000Z"
},
"properties": {
// "Property" object
},
Expand Down Expand Up @@ -467,6 +472,11 @@ It returns a thread that the current Agent has access to in a given chat.
"text": "Hello",
"author_id": "[email protected]"
}],
"summary": { //optional
"status": "ok",
"text": "• Agent greets with a short message.",
"updated_at": "2025-10-21T07:08:16.125000Z"
},
"properties": {
"0805e283233042b37f460ed8fbf22160": {
"string_property": "string_value"
Expand Down Expand Up @@ -704,6 +714,11 @@ You can pass only one of the following values at a time: `values` or `exclude_va
"author_id": "[email protected]"
}
],
"summary": { //optional
"status": "ok",
"text": "• Agent greets with a short message.",
"updated_at": "2025-10-21T07:08:16.125000Z"
},
"properties": {
"0805e283233042b37f460ed8fbf22160": {
"thread_property": "property_value"
Expand Down