# Zendesk Chat

### Snapshot

| Features                        | Details                                                                     |
| ------------------------------- | --------------------------------------------------------------------------- |
| Release Status                  | Released                                                                    |
| Source API Version              |                                                                             |
| Table Selection                 | Yes                                                                         |
| Column Selection                | Yes                                                                         |
| Edit Integration                | Yes                                                                         |
| Replication Type Selection      | No                                                                          |
| Authentication Parameters       | <p>ZendeskChat Subdomain<br>ZendeskChat LoginId<br>ZendeskChat Password</p> |
| Replication Type                | <p>Key Based Replication<br>Full Replication</p>                            |
| Replication Key                 | Date                                                                        |
| Suggested Replication Frequency | 24 hrs                                                                      |

| Tables/APIs Supported |             |
| --------------------- | ----------- |
| Agents                | Departments |
| Goals                 | Shortcuts   |
| Triggers              | Bans        |
| Chats                 |             |

### Integrate ZendeskChat with Daton

1. Signin to Daton&#x20;
2. Select ZendeskChat from Integrations page
3. Provide Integration Name, Replication Frequency, and History. Integration name would be used in creating tables for the integration and cannot be changed later&#x20;
4. Provide ZendeskChat Subdomain, LoginId, and Password to authorize Daton to periodically extract data from ZendeskChat
5. Post successful authentication, you will be prompted to choose from the list of available tables
6. Then select all required fields for each table
7. Submit the integration

### Workflow

1. Integrations would be in Pending state initially and will be moved to Active state as soon as the first job loads data successfully on to the configured warehouse
2. Users would be able to edit/pause/re-activate/delete integration anytime
3. Users can view job status and process logs from the integration details page by clicking on the integration name from the active list

### ZendeskChat Data

**Agents**

Purpose: This lists all the agents for your account.

Source API Documentation  <https://developer.zendesk.com/rest_api/docs/chat/agents#get-all-agents>

Replication: Key-Based Replication

Replication Key: created\_date

**Fields**

| Name          | Target Datatype |
| ------------- | --------------- |
| id            | INTEGER         |
| last\_login   | DATETIME        |
| last\_name    | STRING          |
| display\_name | STRING          |
| create\_date  | DATETIME        |
| email         | STRING          |
| roles         | RECORD          |
| role\_id      | INTEGER         |
| login\_count  | INTEGER         |
| first\_name   | STRING          |
| enabled       | BOOLEAN         |
| departments   | STRING          |
| skills        | STRING          |

**Departments**

Purpose: Lists all the departments for your account.

Source API Documentation  <https://developer.zendesk.com/rest_api/docs/chat/departments>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name        | Target Datatype |
| ----------- | --------------- |
| id          | INTEGER         |
| name        | STRING          |
| description | STRING          |
| enabled     | INTEGER         |
| members     | STRING          |
| settings    | STRING          |

**Goals**

Purpose: This lists all the goals for your account.

Source API Documentation  <https://developer.zendesk.com/rest_api/docs/chat/goals>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                | Target Datatype |
| ------------------- | --------------- |
| id                  | INTEGER         |
| name                | STRING          |
| description         | STRING          |
| enabled             | INTEGER         |
| attribution\_model  | STRING          |
| attribution\_period | INTEGER         |
| settings            | RECORD          |

**Shortcuts**

Purpose: Fetches all the shortcuts for your account.

Source API Documentation  <https://developer.zendesk.com/rest_api/docs/chat/shortcuts>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name        | Target Datatype |
| ----------- | --------------- |
| id          | INTEGER         |
| name        | STRING          |
| scope       | STRING          |
| agents      | STRING          |
| departments | STRING          |
| options     | INTEGER         |
| message     | STRING          |
| tags        | STRING          |

**Triggers**

Purpose: Lists all the triggers of an account.

Source API Documentation  <https://developer.zendesk.com/rest_api/docs/chat/triggers>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name        | Target Datatype |
| ----------- | --------------- |
| id          | INTEGER         |
| name        | STRING          |
| enabled     | INTEGER         |
| description | STRING          |

**Bans**

Purpose: Lists the bans for the account.

Source API Documentation  <https://developer.zendesk.com/rest_api/docs/chat/bans>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name        | Target Datatype |
| ----------- | --------------- |
| visitor     | RECORD          |
| ip\_address | RECORD          |

**Chats**

Purpose: Allows an account owner/administrator to list all the chats for the account.

Source API Documentation  <https://developer.zendesk.com/rest_api/docs/chat/chats>

Replication: Key-Based Replication

Replication Key: timestamp

**Fields**

| Name                     | Target Datatype |
| ------------------------ | --------------- |
| department\_id           | INTEGER         |
| comment                  | STRING          |
| missed                   | BOOLEAN         |
| rating                   | STRING          |
| conversions              | RECORD          |
| type                     | STRING          |
| webpath                  | RECORD          |
| triggered                | BOOLEAN         |
| message                  | STRING          |
| referrer\_search\_terms  | STRING          |
| referrer\_search\_engine | STRING          |
| zendesk\_ticket\_id      | INTEGER         |
| unread                   | STRING          |
| timestamp                | STRING          |
| end\_timestamp           | DATETIME        |
| session                  | RECORD          |
| history                  | RECORD          |
| response\_time           | DATETIME        |
| agent\_names             | STRING          |
| visitor                  | RECORD          |
| started\_by              | STRING          |
| triggered\_response      | BOOLEAN         |
| id                       | STRING          |
| count                    | RECORD          |
| agent\_ids               | STRING          |
| department\_name         | STRING          |
| duration                 | INTEGER         |