Skip to content

Commit dabef0d

Browse files
FigaasFigaas
authored
[ME-117] Describe message removal (#1563)
1 parent c2d8f0a commit dabef0d

File tree

12 files changed

+314
-69
lines changed

12 files changed

+314
-69
lines changed

‎payloads/messaging/v3.6/agent-chat-api/events/deletedEvent.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"id": "0affb00a-82d6-4e07-ae61-56ba5c36f743",
3+
"custom_id": "31-0C-1C-07-DB-16",
4+
"type": "message",
5+
"deleted": true,
6+
"author_id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
7+
"created_at": "2017-10-12T15:19:21.010200Z"
8+
}

‎payloads/messaging/v3.6/agent-chat-api/index.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ export { default as message } from "./events/message.json";
66
export { default as richMessage } from "./events/richMessage.json";
77
export { default as systemMessage } from "./events/systemMessage.json";
88
export { default as system } from "./events/system.json";
9+
export { default as deletedEvent } from "./events/deletedEvent.json"
910

1011
export { default as agent } from "./users/agent.json";
1112
export { default as myProfile } from "./users/myProfile.json";

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ tagline: "Changelog of the Configuration API"
77
desc: "Changelog of the Configuration API"
88
---
99

10-
import { openChatWindow } from "utils/index";
10+
11+
import {openChatWindow} from "utils/index";
1112

1213
This document is the record of all the changes in [the Configuration API](/management/configuration-api/) starting from **version 3.0**.
1314

@@ -38,6 +39,8 @@ Use [**Update an account**](/authorization/global-accounts-api#tag/Accounts/path
3839
### Webhooks
3940

4041
- 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`.
42+
- There are new webhooks:
43+
- [**event_deleted**](/management/webhooks/v3.6/#event_deleted)
4144

4245
### Other
4346

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3213,6 +3213,7 @@ For `bot` webhooks, you need to [create a bot](#create-bot), [register webhooks]
32133213
| [`user_added_to_chat`](/management/webhooks/v3.6#user_added_to_chat) | `chat_presence`, `only_my_chats`, `source_type` |
32143214
| [`user_removed_from_chat`](/management/webhooks/v3.6#user_removed_from_chat) | `chat_presence`, `only_my_chats`, `source_type` |
32153215
| [`incoming_event`](/management/webhooks/v3.6#incoming_event) | `chat_presence`, `author_type`, `only_my_chats`, `source_type` |
3216+
| [`event_deleted`](/management/webhooks/v3.6#event_deleted) | `chat_presence`, `only_my_chats`, `source_type` |
32163217
| [`event_updated`](/management/webhooks/v3.6#event_updated) | `chat_presence`, `author_type`, `only_my_chats`, `source_type` |
32173218
| [`incoming_rich_message_postback`](/management/webhooks/v3.6#incoming_rich_message_postback) | `chat_presence`, `only_my_chats`, `source_type` |
32183219
| [`chat_properties_updated`](/management/webhooks/v3.6#chat_properties_updated) | `chat_presence`, `only_my_chats`, `source_type` |

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

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ In order to receive webhooks, you need to [register](/management/configuration-a
2525
| **Chats** | [`incoming_chat`](#incoming_chat) [`chat_deactivated`](#chat_deactivated) |
2626
| **Chat access** | [`chat_access_updated`](#chat_access_updated) [`chat_transferred`](#chat_transferred) |
2727
| **Chat users** | [`user_added_to_chat`](#user_added_to_chat) [`user_removed_from_chat`](#user_removed_from_chat) |
28-
| **Events** | [`incoming_event`](#incoming_event) [`event_updated`](#event_updated) [`incoming_rich_message_postback`](#incoming_rich_message_postback) |
28+
| **Events** | [`incoming_event`](#incoming_event) [`event_deleted`](#event_deleted) [`event_updated`](#event_updated) [`incoming_rich_message_postback`](#incoming_rich_message_postback) |
2929
| **Properties** | [`chat_properties_updated`](#chat_properties_updated) [`chat_properties_deleted`](#chat_properties_deleted) [`thread_properties_deleted`](#thread_properties_deleted) [`thread_properties_updated`](#thread_properties_updated) [`event_properties_updated`](#event_properties_updated) [`event_properties_deleted`](#event_properties_deleted) |
3030
| **Thread tags** | [`thread_tagged`](#thread_tagged) [`thread_untagged`](#thread_untagged) |
3131
| **Status** | [`routing_status_set`](#routing_status_set) |
@@ -447,6 +447,56 @@ Informs about an incoming [event](/messaging/agent-chat-api/v3.6/data-structures
447447

448448
</Section>
449449

450+
<Section>
451+
452+
<Text>
453+
454+
### `event_deleted`
455+
456+
Informs that an [event](/messaging/agent-chat-api/v3.6/data-structures/#events) was deleted.
457+
458+
#### Specifics
459+
460+
| | |
461+
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
462+
| **Action** | `event_deleted` |
463+
| **Push equivalent in** | [`Agent Chat API`](/messaging/agent-chat-api/v3.6/rtm-pushes/#event_deleted) [`Customer Chat API`](/messaging/customer-chat-api/v3.6/rtm-pushes/#event_deleted) |
464+
465+
</Text>
466+
467+
<Code>
468+
469+
<CodeResponse title={'Sample webhook'}>
470+
471+
```json
472+
{
473+
"webhook_id": "<webhook_id>",
474+
"secret_key": "<secret_key>",
475+
"action": "event_deleted",
476+
"organization_id": "390e44e6-f1e6-0368c-z6ddb-74g14508c2ex",
477+
"payload": {
478+
"chat_id": "PJ0MRSHTDG",
479+
"thread_id": "K600PKZON8",
480+
"event_id": "K600PKZON8_4"
481+
},
482+
"additional_data": {
483+
"chat_properties": { //optional
484+
// chat properties
485+
},
486+
"chat_presence_user_ids": [ //optional
487+
// User IDs
488+
]
489+
}
490+
}
491+
```
492+
493+
</CodeResponse>
494+
495+
</Code>
496+
497+
</Section>
498+
499+
450500
<Section>
451501

452502
<Text>

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ The developer preview version provides a preview of the upcoming changes to the
3131
### Events
3232

3333
- A new structure for the [**System**](/messaging/agent-chat-api/v3.6/data-structures/#system) event was added.
34+
- A new structure for the [**Deleted Event**](/messaging/agent-chat-api/v3.6/data-structures/#deleted-event) was added.
35+
- There are new pushes:
36+
- [**event_deleted**](/messaging/agent-chat-api/v3.6/rtm-pushes/#event_deleted)
3437

3538
### Customers
3639

0 commit comments

Comments
 (0)