Skip to content

Commit 48ee40c

Browse files
kacperf531kacperf531
authored
feat(docs): chat-summary: document thread_summary_set push/webhook (ME-883 part 2/3) (#1600)
* ME-883: chat-summary: document push/webhook * fix the summary in response sample --------- Co-authored-by: kacperf531 <[email protected]>
1 parent dd30751 commit 48ee40c

File tree

6 files changed

+138
-6
lines changed

6 files changed

+138
-6
lines changed

‎src/pages/management/configuration-api/index.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3765,6 +3765,7 @@ For `bot` webhooks, you need to [create a bot](#create-bot), [register webhooks]
37653765
| [`tag_created`](/management/webhooks/v3.6#tag_created) | `source_type` |
37663766
| [`tag_deleted`](/management/webhooks/v3.6#tag_deleted) | `source_type` |
37673767
| [`tag_updated`](/management/webhooks/v3.6#tag_updated) | `source_type` |
3768+
| [`thread_summary_set`](/management/webhooks/v3.6#thread_summary_set) | `chat_presence`, `only_my_chats`, `source_type` |
37683769

37693770
</Text>
37703771

‎src/pages/management/configuration-api/v3.7/index.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3766,6 +3766,7 @@ For `bot` webhooks, you need to [create a bot](#create-bot), [register webhooks]
37663766
| [`tag_created`](/management/webhooks/v3.7#tag_created) | `source_type` |
37673767
| [`tag_deleted`](/management/webhooks/v3.7#tag_deleted) | `source_type` |
37683768
| [`tag_updated`](/management/webhooks/v3.7#tag_updated) | `source_type` |
3769+
| [`thread_summary_set`](/management/webhooks/v3.7#thread_summary_set) | `chat_presence`, `only_my_chats`, `source_type` |
37693770

37703771
</Text>
37713772

‎src/pages/management/webhooks/index.mdx‎

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ In order to receive webhooks, you need to [register](/management/configuration-a
3131
| **Status** | [`routing_status_set`](#routing_status_set) |
3232
| **Customers** | [`customer_session_fields_updated`](#customer_session_fields_updated) |
3333
| **Configuration** | [`agent_created`](#agent_created) [`agent_approved`](#agent_approved) [`agent_updated`](#agent_updated) [`agent_suspended`](#agent_suspended) [`agent_unsuspended`](#agent_unsuspended) [`agent_deleted`](#agent_deleted) [`auto_accesses_updated`](#auto_accesses_updated) [`bot_created`](#bot_created) [`bot_updated`](#bot_updated) [`bot_deleted`](#bot_deleted) [`group_created`](#group_created) [`group_updated`](#group_updated) [`group_deleted`](#group_deleted) [`tag_created`](#tag_created) [`tag_deleted`](#tag_deleted) [`tag_updated`](#tag_updated) |
34-
| **Other** | [`events_marked_as_seen`](#events_marked_as_seen) |
34+
| **Other** | [`events_marked_as_seen`](#events_marked_as_seen) [`thread_summary_set`](#thread_summary_set) |
3535

3636
## Chats
3737

@@ -2200,3 +2200,48 @@ Informs that a user has seen events up to a specific time.
22002200
</Code>
22012201

22022202
</Section>
2203+
2204+
<Section>
2205+
2206+
<Text>
2207+
2208+
### `thread_summary_set`
2209+
2210+
Informs that a thread summary was generated and set.
2211+
2212+
#### Specifics
2213+
2214+
| | |
2215+
| ---------------------- | ---------------------------------------------------------------------------------- |
2216+
| **Action** | `thread_summary_set` |
2217+
| **Push equivalent in** | [`Agent Chat API`](/messaging/agent-chat-api/v3.6/rtm-pushes/#thread_summary_set) |
2218+
2219+
</Text>
2220+
2221+
<Code>
2222+
2223+
<CodeResponse title={'Sample webhook'}>
2224+
2225+
```json
2226+
{
2227+
"webhook_id": "<webhook_id>",
2228+
"secret_key": "<secret_key>",
2229+
"action": "thread_summary_set",
2230+
"organization_id": "390e44e6-f1e6-0368c-z6ddb-74g14508c2ex",
2231+
"payload": {
2232+
"chat_id": "PJ0MRSHTDG",
2233+
"thread_id": "K600PKZON8",
2234+
"summary": {
2235+
"status": "ok",
2236+
"text": "• Customer asks about currently available discount codes. \n• Agent suggests subscribing to the newsletter. \n• Customer thanks the agent and says goodbye.",
2237+
"updated_at": "2025-12-09T12:01:18.909000Z"
2238+
}
2239+
}
2240+
}
2241+
```
2242+
2243+
</CodeResponse>
2244+
2245+
</Code>
2246+
2247+
</Section>

‎src/pages/management/webhooks/v3.7/index.mdx‎

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ In order to receive webhooks, you need to [register](/management/configuration-a
3131
| **Status** | [`routing_status_set`](#routing_status_set) |
3232
| **Customers** | [`customer_session_fields_updated`](#customer_session_fields_updated) |
3333
| **Configuration** | [`agent_created`](#agent_created) [`agent_approved`](#agent_approved) [`agent_updated`](#agent_updated) [`agent_suspended`](#agent_suspended) [`agent_unsuspended`](#agent_unsuspended) [`agent_deleted`](#agent_deleted) [`auto_accesses_updated`](#auto_accesses_updated) [`bot_created`](#bot_created) [`bot_updated`](#bot_updated) [`bot_deleted`](#bot_deleted) [`group_created`](#group_created) [`group_updated`](#group_updated) [`group_deleted`](#group_deleted) [`tag_created`](#tag_created) [`tag_deleted`](#tag_deleted) [`tag_updated`](#tag_updated) |
34-
| **Other** | [`events_marked_as_seen`](#events_marked_as_seen) |
34+
| **Other** | [`events_marked_as_seen`](#events_marked_as_seen) [`thread_summary_set`](#thread_summary_set) |
3535

3636
## Chats
3737

@@ -2200,3 +2200,48 @@ Informs that a user has seen events up to a specific time.
22002200
</Code>
22012201

22022202
</Section>
2203+
2204+
<Section>
2205+
2206+
<Text>
2207+
2208+
### `thread_summary_set`
2209+
2210+
Informs that a thread summary was generated and set.
2211+
2212+
#### Specifics
2213+
2214+
| | |
2215+
| ---------------------- | ---------------------------------------------------------------------------------- |
2216+
| **Action** | `thread_summary_set` |
2217+
| **Push equivalent in** | [`Agent Chat API`](/messaging/agent-chat-api/v3.6/rtm-pushes/#thread_summary_set) |
2218+
2219+
</Text>
2220+
2221+
<Code>
2222+
2223+
<CodeResponse title={'Sample webhook'}>
2224+
2225+
```json
2226+
{
2227+
"webhook_id": "<webhook_id>",
2228+
"secret_key": "<secret_key>",
2229+
"action": "thread_summary_set",
2230+
"organization_id": "390e44e6-f1e6-0368c-z6ddb-74g14508c2ex",
2231+
"payload": {
2232+
"chat_id": "PJ0MRSHTDG",
2233+
"thread_id": "K600PKZON8",
2234+
"summary": {
2235+
"status": "ok",
2236+
"text": "• Customer asks about currently available discount codes. \n• Agent suggests subscribing to the newsletter. \n• Customer thanks the agent and says goodbye.",
2237+
"updated_at": "2025-12-09T12:01:18.909000Z"
2238+
}
2239+
}
2240+
}
2241+
```
2242+
2243+
</CodeResponse>
2244+
2245+
</Code>
2246+
2247+
</Section>

0 commit comments

Comments
 (0)