Skip to content

Commit 88b8740

Browse files
authored
feat(docs): chat-summary: add summary object in thread getters and update changelogs (ME-883 part 3/3) (#1601)
1 parent 48ee40c commit 88b8740

File tree

6 files changed

+65
-0
lines changed

6 files changed

+65
-0
lines changed

src/pages/management/changelog/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ Use [**Update an account**](/authorization/global-accounts-api#tag/Accounts/path
6666
- 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`.
6767
- There are new webhooks:
6868
- [**event_deleted**](/management/webhooks/#event_deleted)
69+
- [**thread_summary_set**](/management/webhooks/#thread_summary_set)
6970
- The **incoming_customer** webhook was removed.
7071

7172
### Other

src/pages/messaging/agent-chat-api/changelog/index.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,10 @@ The developer preview version provides a preview of the upcoming changes to the
7878

7979
- 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)).
8080
- There's a new push, [**incoming_thinking_indicator**](/messaging/agent-chat-api/rtm-pushes/#incoming_thinking_indicator).
81+
- 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).)
82+
- 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)).
83+
- There's a new push, [**thread_summary_set**](/messaging/agent-chat-api/rtm-pushes/#thread_summary_set).
84+
- A new object, `summary`, is returned for **Get Chat**, **List Archives**, and **List Threads** responses for threads that have been summarized.
8185

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

src/pages/messaging/agent-chat-api/index.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,11 @@ curl -X POST \
312312
"text": "Hello",
313313
"author_id": "[email protected]"
314314
}],
315+
"summary": { //optional
316+
"status": "ok",
317+
"text": "• Agent greets with a short message.",
318+
"updated_at": "2025-10-21T07:08:16.125000Z"
319+
},
315320
"properties": {
316321
// "Property" object
317322
},
@@ -410,6 +415,11 @@ curl -X POST \
410415
"text": "Hello",
411416
"author_id": "[email protected]"
412417
}],
418+
"summary": { //optional
419+
"status": "ok",
420+
"text": "• Agent greets with a short message.",
421+
"updated_at": "2025-10-21T07:08:16.125000Z"
422+
},
413423
"properties": {
414424
"0805e283233042b37f460ed8fbf22160": {
415425
"string_property": "string_value"
@@ -646,6 +656,11 @@ curl -X POST \
646656
"author_id": "[email protected]"
647657
}
648658
],
659+
"summary": { //optional
660+
"status": "ok",
661+
"text": "• Agent greets with a short message.",
662+
"updated_at": "2025-10-21T07:08:16.125000Z"
663+
},
649664
"properties": {
650665
"0805e283233042b37f460ed8fbf22160": {
651666
"thread_property": "property_value"

src/pages/messaging/agent-chat-api/rtm-reference/index.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -364,6 +364,11 @@ You cannot use either `limit` and `min_events_count` or `filters` and `min_event
364364
"text": "Hello",
365365
"author_id": "[email protected]"
366366
}],
367+
"summary": { //optional
368+
"status": "ok",
369+
"text": "• Agent greets with a short message.",
370+
"updated_at": "2025-10-21T07:08:16.125000Z"
371+
},
367372
"properties": {
368373
// "Property" object
369374
},
@@ -467,6 +472,11 @@ It returns a thread that the current Agent has access to in a given chat.
467472
"text": "Hello",
468473
"author_id": "[email protected]"
469474
}],
475+
"summary": { //optional
476+
"status": "ok",
477+
"text": "• Agent greets with a short message.",
478+
"updated_at": "2025-10-21T07:08:16.125000Z"
479+
},
470480
"properties": {
471481
"0805e283233042b37f460ed8fbf22160": {
472482
"string_property": "string_value"
@@ -704,6 +714,11 @@ You can pass only one of the following values at a time: `values` or `exclude_va
704714
"author_id": "[email protected]"
705715
}
706716
],
717+
"summary": { //optional
718+
"status": "ok",
719+
"text": "• Agent greets with a short message.",
720+
"updated_at": "2025-10-21T07:08:16.125000Z"
721+
},
707722
"properties": {
708723
"0805e283233042b37f460ed8fbf22160": {
709724
"thread_property": "property_value"

src/pages/messaging/agent-chat-api/v3.7/index.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,11 @@ curl -X POST \
312312
"text": "Hello",
313313
"author_id": "[email protected]"
314314
}],
315+
"summary": { //optional
316+
"status": "ok",
317+
"text": "• Agent greets with a short message.",
318+
"updated_at": "2025-10-21T07:08:16.125000Z"
319+
},
315320
"properties": {
316321
// "Property" object
317322
},
@@ -410,6 +415,11 @@ curl -X POST \
410415
"text": "Hello",
411416
"author_id": "[email protected]"
412417
}],
418+
"summary": { //optional
419+
"status": "ok",
420+
"text": "• Agent greets with a short message.",
421+
"updated_at": "2025-10-21T07:08:16.125000Z"
422+
},
413423
"properties": {
414424
"0805e283233042b37f460ed8fbf22160": {
415425
"string_property": "string_value"
@@ -646,6 +656,11 @@ curl -X POST \
646656
"author_id": "[email protected]"
647657
}
648658
],
659+
"summary": { //optional
660+
"status": "ok",
661+
"text": "• Agent greets with a short message.",
662+
"updated_at": "2025-10-21T07:08:16.125000Z"
663+
},
649664
"properties": {
650665
"0805e283233042b37f460ed8fbf22160": {
651666
"thread_property": "property_value"

src/pages/messaging/agent-chat-api/v3.7/rtm-reference/index.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -364,6 +364,11 @@ You cannot use either `limit` and `min_events_count` or `filters` and `min_event
364364
"text": "Hello",
365365
"author_id": "[email protected]"
366366
}],
367+
"summary": { //optional
368+
"status": "ok",
369+
"text": "• Agent greets with a short message.",
370+
"updated_at": "2025-10-21T07:08:16.125000Z"
371+
},
367372
"properties": {
368373
// "Property" object
369374
},
@@ -467,6 +472,11 @@ It returns a thread that the current Agent has access to in a given chat.
467472
"text": "Hello",
468473
"author_id": "[email protected]"
469474
}],
475+
"summary": { //optional
476+
"status": "ok",
477+
"text": "• Agent greets with a short message.",
478+
"updated_at": "2025-10-21T07:08:16.125000Z"
479+
},
470480
"properties": {
471481
"0805e283233042b37f460ed8fbf22160": {
472482
"string_property": "string_value"
@@ -704,6 +714,11 @@ You can pass only one of the following values at a time: `values` or `exclude_va
704714
"author_id": "[email protected]"
705715
}
706716
],
717+
"summary": { //optional
718+
"status": "ok",
719+
"text": "• Agent greets with a short message.",
720+
"updated_at": "2025-10-21T07:08:16.125000Z"
721+
},
707722
"properties": {
708723
"0805e283233042b37f460ed8fbf22160": {
709724
"thread_property": "property_value"

0 commit comments

Comments
 (0)