ZendeskChatModule
The ZendeskChatModule type is used to configure the integration of Zendesk Chat into the client.
| Field | Type | Required? | Since | Description |
|---|---|---|---|---|
| enabled | Boolean | yes | 2.0 | True if this module is enabled, false otherwise. |
| departments | Map<String, Department> | yes | 2.0 | Chat department configurations indexed by locale. |
Example
{
"enabled": true,
"departments: {
"default": {
"enabled": true,
"allowUploads": true,
"usesOfflineForm": true,
"brand": "bernard",
"department": "Bernard_Dept",
"key": "abcdefghijklmnopqrstuvwxyz",
"fileExtensions": [".gif", ".pdf", ".txt", ".jpg", ".png"]
},
"fr-CA": {
"enabled": true,
"allowUploads": false,
"usesOfflineForm": true,
"brand": "bernard",
"department": "Bernard_Dept_FR-CA",
"key": "123456789012345678901234567890",
"tags": [ "en francais" ]
}
}
}
Department
The Department type is used to configure Zendesk chat departments in the chat client.
| Field | Type | Required? | Since | Description |
|---|---|---|---|---|
| enabled | Boolean | yes | 2.0 | True if the department is enabled, false otherwise. |
| allowUploads | Boolean | yes | 2.0 | True if file uploads are allowed, false otherwise. |
| usesOfflineForm | Boolean | yes | 2.0 | True if the offline form is presented to the user when Live Chat is offline, false otherwise. |
| brand | String | yes | 2.0 | The Zendesk brand (eg: for Zendesk multi-brand help sites). |
| department | String | yes | 2.0 | The Zendesk department identifier. |
| key | String | yes | 2.0 | The Zendesk account key. Note - this is not considered a secret as it is required to connect to live chat. |
| fileExtensions | String[] | no | 2.0 | Permitted file extensions, with leading dots, permitted for upload (only if allowUploads is set to true). |
| tags | String[] | no | 2.0 | Tags that are applied to live chat. |
Example
{
"enabled": true,
"allowUploads": true,
"usesOfflineForm": true,
"brand": "bernard",
"department": "Bernard_Dept",
"key": "abcdefghijklmnopqrstuvwxyz",
"fileExtensions": [".gif", ".pdf", ".txt", ".jpg", ".png"]
}