Skip to content

Commit 1dd1812

Browse files
wfabjanczukwfabjanczuk
authored
feat(docs): config-api: remove incoming_customer webhook (3.6, 3.7)
1 parent 022ab42 commit 1dd1812

File tree

7 files changed

+6
-111
lines changed

7 files changed

+6
-111
lines changed

‎payloads/management/v3.6/configuration-api/responses/webhooks/listWebhookNames.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,5 @@
1515
"chat_properties",
1616
"chat_presence_user_ids"
1717
]
18-
},
19-
{
20-
"action": "incoming_customer"
2118
}
2219
]

‎payloads/management/v3.7/configuration-api/responses/webhooks/listWebhookNames.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,5 @@
1515
"chat_properties",
1616
"chat_presence_user_ids"
1717
]
18-
},
19-
{
20-
"action": "incoming_customer"
2118
}
2219
]

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

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

5152
### Other
5253

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3294,7 +3294,7 @@ For `bot` webhooks, you need to [create a bot](#create-bot), [register webhooks]
32943294
| `action`<sup>**2**</sup> | yes | `string` | The [action](#triggering-actions) that triggers sending a webhook. |
32953295
| `secret_key` | yes | `string` | The secret key sent in webhooks to verify the source of a webhook. |
32963296
| `url` | yes | `string` | Destination URL for the webhook |
3297-
| `additional_data` | no | `[]string` | Additional data arriving with the webhook. Value: `chat_properties`, `chat_presence_user_ids` (all actions except for `agent_status_changed`, `agent_deleted`, `incoming_customer`) |
3297+
| `additional_data` | no | `[]string` | Additional data arriving with the webhook. Value: `chat_properties`, `chat_presence_user_ids` (all actions except for `agent_status_changed`, `agent_deleted`) |
32983298
| `description` | no | `string` | Webhook description |
32993299
| `filters` | no | `object` | Filters to check if a webhook should be triggered. |
33003300
| `filters.author_type` | no | `string` | Possible values: `customer`, `agent`; allowed only for the `incoming_event` and `event_updated` actions. |
@@ -3333,7 +3333,6 @@ For `bot` webhooks, you need to [create a bot](#create-bot), [register webhooks]
33333333
| [`thread_tagged`](/management/webhooks/v3.6#thread_tagged) | `chat_presence`, `only_my_chats`, `source_type` |
33343334
| [`thread_untagged`](/management/webhooks/v3.6#thread_untagged) | `chat_presence`, `only_my_chats`, `source_type` |
33353335
| [`routing_status_set`](/management/webhooks/v3.6#routing_status_set) | `agent_ids`, `source_type` |
3336-
| [`incoming_customer`](/management/webhooks/v3.6#incoming_customer) | `source_type` |
33373336
| [`customer_session_fields_updated`](/management/webhooks/v3.6#customer_session_fields_updated) | `chat_presence`, `source_type` |
33383337
| [`events_marked_as_seen`](/management/webhooks/v3.6#events_marked_as_seen) | `chat_presence`, `only_my_chats`, `source_type` |
33393338
| [`group_created`](/management/webhooks/v3.6#group_created) | `source_type` |

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3294,7 +3294,7 @@ For `bot` webhooks, you need to [create a bot](#create-bot), [register webhooks]
32943294
| `action`<sup>**2**</sup> | yes | `string` | The [action](#triggering-actions) that triggers sending a webhook. |
32953295
| `secret_key` | yes | `string` | The secret key sent in webhooks to verify the source of a webhook. |
32963296
| `url` | yes | `string` | Destination URL for the webhook |
3297-
| `additional_data` | no | `[]string` | Additional data arriving with the webhook. Value: `chat_properties`, `chat_presence_user_ids` (all actions except for `agent_status_changed`, `agent_deleted`, `incoming_customer`) |
3297+
| `additional_data` | no | `[]string` | Additional data arriving with the webhook. Value: `chat_properties`, `chat_presence_user_ids` (all actions except for `agent_status_changed`, `agent_deleted`) |
32983298
| `description` | no | `string` | Webhook description |
32993299
| `filters` | no | `object` | Filters to check if a webhook should be triggered. |
33003300
| `filters.author_type` | no | `string` | Possible values: `customer`, `agent`; allowed only for the `incoming_event` and `event_updated` actions. |
@@ -3333,7 +3333,6 @@ For `bot` webhooks, you need to [create a bot](#create-bot), [register webhooks]
33333333
| [`thread_tagged`](/management/webhooks/v3.7#thread_tagged) | `chat_presence`, `only_my_chats`, `source_type` |
33343334
| [`thread_untagged`](/management/webhooks/v3.7#thread_untagged) | `chat_presence`, `only_my_chats`, `source_type` |
33353335
| [`routing_status_set`](/management/webhooks/v3.7#routing_status_set) | `agent_ids`, `source_type` |
3336-
| [`incoming_customer`](/management/webhooks/v3.7#incoming_customer) | `source_type` |
33373336
| [`customer_session_fields_updated`](/management/webhooks/v3.7#customer_session_fields_updated) | `chat_presence`, `source_type` |
33383337
| [`events_marked_as_seen`](/management/webhooks/v3.7#events_marked_as_seen) | `chat_presence`, `only_my_chats`, `source_type` |
33393338
| [`group_created`](/management/webhooks/v3.7#group_created) | `source_type` |

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

Lines changed: 2 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ 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_deleted`](#event_deleted) [`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) |
32-
| **Customers** | [`incoming_customer`](#incoming_customer) [`customer_session_fields_updated`](#customer_session_fields_updated) |
32+
| **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) |
3434
| **Other** | [`events_marked_as_seen`](#events_marked_as_seen) |
3535

@@ -1120,55 +1120,6 @@ Informs that an Agent's or Bot's status has changed.
11201120

11211121
<Text>
11221122

1123-
### `incoming_customer`
1124-
1125-
Informs that a new Customer registered.
1126-
1127-
#### Specifics
1128-
1129-
| | |
1130-
| ---------------------- | -------------------------------------------------------------------------------- |
1131-
| **Action** | `incoming_customer` |
1132-
| **Push equivalent in** | [`Agent Chat API`](/messaging/agent-chat-api/v3.6/rtm-pushes/#incoming_customer) |
1133-
1134-
</Text>
1135-
1136-
<Code>
1137-
1138-
<CodeResponse title={'Sample webhook'}>
1139-
1140-
```json
1141-
{
1142-
"webhook_id": "<webhook_id>",
1143-
"secret_key": "<secret_key>",
1144-
"action": "incoming_customer",
1145-
"organization_id": "390e44e6-f1e6-0368c-z6ddb-74g14508c2ex",
1146-
"payload": {
1147-
"customer": {
1148-
// "User > Customer" object
1149-
}
1150-
},
1151-
"additional_data": {
1152-
"chat_properties": { //optional
1153-
// chat properties
1154-
},
1155-
"chat_presence_user_ids": [ //optional
1156-
// User IDs
1157-
]
1158-
}
1159-
}
1160-
```
1161-
1162-
</CodeResponse>
1163-
1164-
</Code>
1165-
1166-
</Section>
1167-
1168-
<Section>
1169-
1170-
<Text>
1171-
11721123
### `customer_session_fields_updated`
11731124

11741125
Informs that a chatting Customer's session fields were updated. The webhook will be sent for each active chat the Customer has.

0 commit comments

Comments
 (0)