Skip to content

feat: configuration-api: remove incoming_customer webhook from v3.6 and v3.7 #1586

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: configuration-api: remove incoming_customer webhook from v3.6 and v3.7 #1586

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 0 additions & 3 deletions payloads/management/v3.6/configuration-api/responses/webhooks/listWebhookNames.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,5 @@
"chat_properties",
"chat_presence_user_ids"
]
},
{
"action": "incoming_customer"
}
]
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 @@ -47,6 +47,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)
- The **incoming_customer** webhook was removed.

### Other

Expand Down
3 changes: 1 addition & 2 deletions src/pages/management/configuration-api/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3294,7 +3294,7 @@ For `bot` webhooks, you need to [create a bot](#create-bot), [register webhooks]
| `action`<sup>**2**</sup> | yes | `string` | The [action](#triggering-actions) that triggers sending a webhook. |
| `secret_key` | yes | `string` | The secret key sent in webhooks to verify the source of a webhook. |
| `url` | yes | `string` | Destination URL for the webhook |
| `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`) |
| `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`) |
| `description` | no | `string` | Webhook description |
| `filters` | no | `object` | Filters to check if a webhook should be triggered. |
| `filters.author_type` | no | `string` | Possible values: `customer`, `agent`; allowed only for the `incoming_event` and `event_updated` actions. |
Expand Down Expand Up @@ -3333,7 +3333,6 @@ For `bot` webhooks, you need to [create a bot](#create-bot), [register webhooks]
| [`thread_tagged`](/management/webhooks/v3.6#thread_tagged) | `chat_presence`, `only_my_chats`, `source_type` |
| [`thread_untagged`](/management/webhooks/v3.6#thread_untagged) | `chat_presence`, `only_my_chats`, `source_type` |
| [`routing_status_set`](/management/webhooks/v3.6#routing_status_set) | `agent_ids`, `source_type` |
| [`incoming_customer`](/management/webhooks/v3.6#incoming_customer) | `source_type` |
| [`customer_session_fields_updated`](/management/webhooks/v3.6#customer_session_fields_updated) | `chat_presence`, `source_type` |
| [`events_marked_as_seen`](/management/webhooks/v3.6#events_marked_as_seen) | `chat_presence`, `only_my_chats`, `source_type` |
| [`group_created`](/management/webhooks/v3.6#group_created) | `source_type` |
Expand Down
3 changes: 1 addition & 2 deletions src/pages/management/configuration-api/v3.7/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3294,7 +3294,7 @@ For `bot` webhooks, you need to [create a bot](#create-bot), [register webhooks]
| `action`<sup>**2**</sup> | yes | `string` | The [action](#triggering-actions) that triggers sending a webhook. |
| `secret_key` | yes | `string` | The secret key sent in webhooks to verify the source of a webhook. |
| `url` | yes | `string` | Destination URL for the webhook |
| `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`) |
| `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`) |
| `description` | no | `string` | Webhook description |
| `filters` | no | `object` | Filters to check if a webhook should be triggered. |
| `filters.author_type` | no | `string` | Possible values: `customer`, `agent`; allowed only for the `incoming_event` and `event_updated` actions. |
Expand Down Expand Up @@ -3333,7 +3333,6 @@ For `bot` webhooks, you need to [create a bot](#create-bot), [register webhooks]
| [`thread_tagged`](/management/webhooks/v3.6#thread_tagged) | `chat_presence`, `only_my_chats`, `source_type` |
| [`thread_untagged`](/management/webhooks/v3.6#thread_untagged) | `chat_presence`, `only_my_chats`, `source_type` |
| [`routing_status_set`](/management/webhooks/v3.6#routing_status_set) | `agent_ids`, `source_type` |
| [`incoming_customer`](/management/webhooks/v3.6#incoming_customer) | `source_type` |
| [`customer_session_fields_updated`](/management/webhooks/v3.6#customer_session_fields_updated) | `chat_presence`, `source_type` |
| [`events_marked_as_seen`](/management/webhooks/v3.6#events_marked_as_seen) | `chat_presence`, `only_my_chats`, `source_type` |
| [`group_created`](/management/webhooks/v3.6#group_created) | `source_type` |
Expand Down
53 changes: 2 additions & 51 deletions src/pages/management/webhooks/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ In order to receive webhooks, you need to [register](/management/configuration-a
| **Chats** | [`incoming_chat`](#incoming_chat) [`chat_deactivated`](#chat_deactivated) |
| **Chat access** | [`chat_access_updated`](#chat_access_updated) [`chat_transferred`](#chat_transferred) |
| **Chat users** | [`user_added_to_chat`](#user_added_to_chat) [`user_removed_from_chat`](#user_removed_from_chat) |
| **Events** | [`incoming_event`](#incoming_event) [`event_deleted`](#event_deleted) [`event_updated`](#event_updated) [`incoming_rich_message_postback`](#incoming_rich_message_postback) |
| **Events** | [`incoming_event`](#incoming_event) [`event_deleted`](#event_deleted) [`event_updated`](#event_updated) [`incoming_rich_message_postback`](#incoming_rich_message_postback) |
| **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) |
| **Thread tags** | [`thread_tagged`](#thread_tagged) [`thread_untagged`](#thread_untagged) |
| **Status** | [`routing_status_set`](#routing_status_set) |
| **Customers** | [`incoming_customer`](#incoming_customer) [`customer_session_fields_updated`](#customer_session_fields_updated) |
| **Customers** | [`customer_session_fields_updated`](#customer_session_fields_updated) |
| **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) |
| **Other** | [`events_marked_as_seen`](#events_marked_as_seen) |

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

<Text>

### `incoming_customer`

Informs that a new Customer registered.

#### Specifics

| | |
| ---------------------- | -------------------------------------------------------------------------------- |
| **Action** | `incoming_customer` |
| **Push equivalent in** | [`Agent Chat API`](/messaging/agent-chat-api/v3.6/rtm-pushes/#incoming_customer) |

</Text>

<Code>

<CodeResponse title={'Sample webhook'}>

```json
{
"webhook_id": "<webhook_id>",
"secret_key": "<secret_key>",
"action": "incoming_customer",
"organization_id": "390e44e6-f1e6-0368c-z6ddb-74g14508c2ex",
"payload": {
"customer": {
// "User > Customer" object
}
},
"additional_data": {
"chat_properties": { //optional
// chat properties
},
"chat_presence_user_ids": [ //optional
// User IDs
]
}
}
```

</CodeResponse>

</Code>

</Section>

<Section>

<Text>

### `customer_session_fields_updated`

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