# Kustomer

Kustomer is a cloud-based solution, which helps small to large businesses streamline communication and provide client support via multiple channels.

Kustomer integration replicates data using the [Kustomer REST API v1](https://apidocs.kustomer.com/?version=latest).

See the [Schema](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Kustomer.htm#Schema) section for a list of objects available for replication.

## Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Information noteMake sure that the account you use has read access to the tables you want to fetch.

To create the API token:

1. Log into your [Kustomer](https://dash.readme.com/to/kustomer-enterprise-group) account.

2. Go to Settings &gt; API Keys.

3. Click New API Key.

4. Select the roles that can have access to the API key.

5. Leave the API expiration option blank.

   If you set an expiration date, the API key will expire and the connection will break. If this happens, you need to re-generate the API key in Kustomer and enter the new key.

6. Click Create.

7. Copy and paste your API token into a secured file.

## Creating the connection

For more information, see [Connecting to SaaS applications](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/Landing/connecting-web-applications.htm).

1. Fill in the required connection properties.

2. Provide a name for the connection in Connection name.

3. Select Open connection metadata to define metadata for the connection when it has been created.

4. Click Create.

Connection settings

| Setting | Description |
| --- | --- |
| Data gateway | Select a Data Movement gateway if required by your use case.<br><br>Information note<br><br>This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None.<br><br>For information on the benefits of Data Movement gateway and use cases that require it, see [Qlik Data Gateway - Data Movement](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Gateways/replication-gateway.htm). |
| Start Date | Enter the date, in the format `MM/DD/YYYY`, from which the data must be replicated from your source to your target. |
| API Token | API token. |

## Schema

Information note

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

Depending on your destination, table and column names may not appear as they are outlined below.

### conversations

The `conversations` table contains information about conversations in the Kustomer app.

| **Replication Method** | CDC |
| --- | --- |
| **Primary Key** | id |
| **Replication Key** | updated\_at |
| **Useful links** | [Kustomer documentation](https://dev.kustomer.com/v1/conversations/)<br><br>[Kustomer API method](https://dev.kustomer.com/v1/conversations/get-conversations "Opens in new tab: Kustomer API method") |

conversations table schema

| **assigned\_teams**<br><br>ARRAY<br><br>This is a nested data structure. |
| --- |
| **assigned\_users**<br><br>ARRAY<br><br>This is a nested data structure. |
| **channels**<br><br>ARRAY<br><br>This is a nested data structure. |
| **created\_at**<br><br><br>STRING |
| **created\_by**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **custom**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>auto_response_at: STRING</li><li>brand_str: STRING</li><li>business_area_str: STRING</li><li>case_id_str: STRING</li><li>close_out_tree: STRING</li><li>contact_reason_tree: STRING</li><li>desk_ticket_url: STRING</li><li>issue_report_tree: STRING</li><li>new_primary_menu_str: STRING</li><li>order_number_id: STRING</li><li>refund_status_str: STRING</li><li>return_requested_str: STRING</li><li>return_str: STRING</li><li>rma_id_str: STRING</li><li>serial_number_str: STRING</li><li>shopify_order_str: STRING</li><li>yale_call_reason_tree: STRING</li><li>yale_connectivity_str: STRING</li><li>yale_finish_str: STRING</li><li>yale_model_str: STRING</li><li>yale_notes_txt: STRING</li><li>yale_resolution_str: STRING</li><li>yale_serial_number_str: STRING</li></ul> |
| **customer**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **direction**<br><br><br>STRING |
| **done\_count**<br><br><br>INTEGER |
| **ended**<br><br><br>BOOLEAN |
| **ended\_at**<br><br><br>STRING |
| **ended\_by**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **ended\_by\_type**<br><br><br>STRING |
| **ended\_reason**<br><br><br>STRING |
| **external\_id**<br><br><br>STRING |
| **first\_done**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>assigned_teams: ARRAY, which is also a nested data structure.</li><li>assigned_users: ARRAY, which is also a nested data structure.</li><li>business_time: INTEGER</li><li>created_at: STRING</li><li>created_by: STRING</li><li>created_by_teams: ARRAY, which is also a nested data structure.</li><li>last_message_direction: STRING</li><li>last_message_direction_type: STRING</li><li>message_count: INTEGER</li><li>message_count_by_channel: OBJECT, which is also a nested data structure.											<ul><li>email: INTEGER</li><li>sms: INTEGER</li><li>voice: INTEGER</li></ul></li><li>note_count: INTEGER</li><li>outbound_message_count: INTEGER</li><li>outbound_message_count_by_channel: OBJECT, which is is also a nested data structure.											<ul><li>email: INTEGER</li><li>sms: INTEGER</li><li>voice: INTEGER</li></ul></li><li>time: INTEGER</li></ul> |
| **first\_message\_in**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>channel: STRING</li><li>created_at: STRING</li><li>direction_type: STRING</li><li>id: STRING</li><li>sent_at: STRING</li></ul> |
| **first\_message\_out**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>channel: STRING</li><li>created_at: STRING</li><li>created_by: STRING</li><li>created_by_teams: ARRAY, which is also a nested data structure.</li><li>direction_type: STRING</li><li>id: STRING</li><li>sent_at: STRING</li></ul> |
| **first\_response**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>assigned_teams: ARRAY, which is also a nested data structure.</li><li>assigned_users: ARRAY, which is also a nested data structure.</li><li>business_time: INTEGER</li><li>created_at: STRING</li><li>created_by: STRING</li><li>created_by_teams: ARRAY, which is also a nested data structure.</li><li>id: STRING</li><li>response_time: INTEGER</li><li>sent_at: STRING</li><li>time: INTEGER</li></ul> |
| **first\_response\_since\_last\_done**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>assigned_teams: ARRAY, which is also a nested data structure.</li><li>assigned_users: ARRAY, which is also a nested data structure.</li><li>business_time: INTEGER</li><li>created_at: STRING</li><li>created_by: STRING</li><li>created_by_teams: ARRAY, which is also a nested data structure.</li><li>id: STRING</li><li>response_time: INTEGER</li><li>sent_at: STRING</li><li>time: INTEGER</li></ul> |
| **id**<br><br><br>STRING |
| **imported\_at**<br><br><br>STRING |
| **last\_activity\_at**<br><br><br>STRING |
| **last\_done**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>assigned_teams: ARRAY, which is also a nested data structure.</li><li>assigned_users: ARRAY, which is also a nested data structure.</li><li>business_time: INTEGER</li><li>created_at: STRING</li><li>created_by: STRING</li><li>created_by_teams: ARRAY, which is also a nested data structure.</li><li>last_message_direction: STRING</li><li>last_message_direction_type: INTEGER</li><li>message_count: STRING</li><li>message_count_by_channel: OBJECT, which is also a nested data structure.											<ul><li>email: INTEGER</li><li>sms: INTEGER</li><li>voice: INTEGER</li></ul></li><li>note_count: INTEGER</li><li>outbound_message_count: INTEGER</li><li>outbound_message_count_by_channel: OBJECT, which is also a nested data structure.											<ul><li>email: INTEGER</li><li>sms: INTEGER</li><li>voice: INTEGER</li></ul></li><li>time: INTEGER</li></ul> |
| **last\_message\_at**<br><br><br>STRING |
| **last\_message\_direction**<br><br><br>STRING |
| **last\_message\_in**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>created_at: STRING</li><li>id: STRING</li><li>sent_at: STRING</li></ul> |
| **last\_message\_out**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>created_at: STRING</li><li>id: STRING</li><li>sent_at: STRING</li></ul> |
| **last\_message\_unresponded\_to**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>created_at: STRING</li><li>id: STRING</li><li>sent_at: STRING</li></ul> |
| **last\_message\_unresponded\_to\_since\_last\_done**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>created_at: STRING</li><li>id: STRING</li><li>sent_at: STRING</li></ul> |
| **last\_received\_at**<br><br><br>STRING |
| **last\_response**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>assigned_teams: ARRAY, which is also a nested data structure.</li><li>assigned_users: ARRAY, which is also a nested data structure.</li><li>business_time: INTEGER</li><li>created_at: STRING</li><li>created_by: STRING</li><li>created_by_teams: ARRAY, which is also a nested data structure.</li><li>id: STRING</li><li>time: INTEGER</li></ul> |
| **links**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>self: STRING</li></ul> |
| **merged\_target**<br><br><br>BOOLEAN |
| **message\_count**<br><br><br>INTEGER |
| **modified\_at**<br><br><br>STRING |
| **modified\_by**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **name**<br><br><br>STRING |
| **note\_count**<br><br><br>INTEGER |
| **org**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **outbound\_message\_count**<br><br><br>INTEGER |
| **preview**<br><br><br>STRING |
| **priority**<br><br><br>INTEGER |
| **queue**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **reopen\_count**<br><br><br>INTEGER |
| **rev**<br><br><br>INTEGER |
| **role\_group\_versions**<br><br><br>STRING |
| **satisfaction**<br><br><br>STRING |
| **satisfaction\_level**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>sent_by_teams: ARRAY, which is also a nested data structure.</li></ul> |
| **sla**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>breach: OBJECT, which is also a nested data structure.											<ul><li>at: STRING</li><li>metric: STRING</li></ul></li><li>breached: BOOLEAN</li><li>matched_at: STRING</li><li>metrics: OBJECT, which is also a nested data structure.											<ul><li>first_response: OBJECT, which is also a nested data structure.													<ul><li>breach_at: STRING</li><li>satisfied_at: STRING</li></ul></li><li>longest_unresponded_message: OBJECT, which is also a nested data structure.													<ul><li>breach_at: STRING</li><li>satisfied_at: STRING</li></ul></li></ul></li><li>status: STRING</li><li>summary: OBJECT, which is also a nested data structure.											<ul><li>first_breach_at: STRING</li><li>satisfied_at: STRING</li></ul></li><li>version: INTEGER</li></ul> |
| **sla\_data**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **sla\_version**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **snooze**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>status: STRING</li><li>status_at: STRING</li><li>time: STRING</li></ul> |
| **snooze\_count**<br><br><br>INTEGER |
| **status**<br><br><br>STRING |
| **suggested\_shortcuts**<br><br><br>STRING |
| **suggested\_tags**<br><br><br>STRING |
| **tags**<br><br>ARRAY<br><br>This is a nested data structure. |
| **total\_done**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>business_time: INTEGER</li><li>time: INTEGER</li></ul> |
| **total\_open**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>business_time: INTEGER</li><li>business_time_since_last_done: INTEGER</li><li>time: INTEGER</li><li>time_since_last_done: INTEGER</li></ul> |
| **total\_snooze**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>business_time: INTEGER</li><li>time: INTEGER</li></ul> |
| **type**<br><br><br>STRING |
| **updated\_at**<br><br><br>STRING |

### customers

The `customers` table contains information about customers in the Kustomer app.

| **Replication Method** | CDC |
| --- | --- |
| **Primary Key** | id |
| **Replication Key** | updated\_at |
| **Useful links** | [Kustomer documentation](https://dev.kustomer.com/v1/customers/)<br><br>[Kustomer API method](https://dev.kustomer.com/v1/customers/get-customers "Opens in new tab: Kustomer API method") |

customers table schema

| **active\_users**<br><br><br>STRING |
| --- |
| **avatar\_url**<br><br><br>STRING |
| **birthday\_at**<br><br><br>STRING |
| **conversation\_counts**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>all: INTEGER</li><li>done: INTEGER</li><li>open: INTEGER</li><li>snoozed: INTEGER</li></ul> |
| **created\_at**<br><br><br>STRING |
| **created\_by**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **custom**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>accepts_marketing_bool: BOOLEAN</li><li>activation_date_str: STRING</li><li>app_version_str: STRING</li><li>august_id_str: STRING</li><li>august_serial_number_str: STRING</li><li>bridge_date_installed_at: STRING</li><li>bridge_serial_number_str: STRING</li><li>connect_firmware_version_str: STRING</li><li>connect_serial_number_str: STRING</li><li>doorbell_date_installed_at: STRING</li><li>doorbell_firmware_version_str: STRING</li><li>doorbell_serial_str: STRING</li><li>firmware_version_str: STRING</li><li>keypad_firmware_version_str: STRING</li><li>keypad_installed_at: STRING</li><li>keypad_serial_str: STRING</li><li>last_autoresponse_at: STRING</li><li>last_order_id_num: INTEGER</li><li>last_order_name_str: STRING</li><li>latest_csat_num: INTEGER</li><li>latest_nps_num: INTEGER</li><li>lock_date_installed_at: STRING</li><li>lock_firmware_version_str: STRING</li><li>lock_serial_number_str: STRING</li><li>orders_count_num: INTEGER</li><li>os00_str: STRING</li><li>owner_guest_str: STRING</li><li>products_owned_str: STRING</li><li>proof_of_purchase_str: STRING</li><li>purchase_date_str: STRING</li><li>sales_force_id_str: STRING</li><li>total_spent_num: INTEGER</li></ul> |
| **deleted**<br><br><br>STRING |
| **display\_color**<br><br><br>STRING |
| **display\_icon**<br><br><br>STRING |
| **display\_name**<br><br><br>STRING |
| **emails**<br><br>ARRAY<br><br>This is a nested data structure:<br><br><ul><li>email: STRING</li><li>type: STRING</li><li>verified: BOOLEAN</li></ul> |
| **external\_id**<br><br><br>STRING |
| **external\_ids**<br><br>ARRAY<br><br>This is a nested data structure:<br><br><ul><li>external_id: STRING</li><li>verified: BOOLEAN</li></ul> |
| **facebook\_ids**<br><br><br>STRING |
| **first\_name**<br><br><br>STRING |
| **gender**<br><br><br>STRING |
| **id**<br><br><br>STRING |
| **imported\_at**<br><br><br>DATE-TIME |
| **instagram\_ids**<br><br><br>STRING |
| **last\_activity\_at**<br><br><br>DATE-TIME |
| **last\_conversation**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>channels: ARRAY, which is also a nested data structure.</li><li>id: STRING</li><li>sentiment: OBJECT, which is also a nested data structure.											<ul><li>confidence: NUMBER</li><li>polarity: INTEGER</li></ul></li><li>tags: ARRAY, which is also a nested data structure.</li></ul> |
| **last\_customer\_activity\_at**<br><br><br>STRING |
| **last\_message\_at**<br><br><br>STRING |
| **last\_message\_in**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>channel: STRING</li><li>sent_at: STRING</li><li>sentiment: STRING</li></ul> |
| **last\_message\_out**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>sent_at: STRING</li></ul> |
| **last\_message\_unresponded\_to**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>channel: STRING</li><li>sent_at: STRING</li></ul> |
| **last\_name**<br><br><br>STRING |
| **last\_seen\_at**<br><br><br>STRING |
| **links**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>self: STRING</li></ul> |
| **locale**<br><br><br>STRING |
| **locations**<br><br><br>STRING |
| **modified\_at**<br><br><br>STRING |
| **modified\_by**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **name**<br><br><br>STRING |
| **org**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **phones**<br><br>ARRAY<br><br>This is a nested data structure:<br><br><ul><li>phone: STRING</li><li>type: STRING</li><li>verified: BOOLEAN</li></ul> |
| **preview**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>channel: STRING</li><li>preview_at: STRING</li><li>subject: STRING</li><li>text: STRING</li><li>type: STRING</li></ul> |
| **progressive\_status**<br><br><br>STRING |
| **recent\_items**<br><br>ARRAY<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>meta: OBJECT, which is also a nested data structure.											<ul><li>klass_name: STRING</li></ul></li><li>type: STRING</li><li>updated_at: STRING</li></ul> |
| **recent\_location**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>updated_at: STRING</li></ul> |
| **rev**<br><br><br>INTEGER |
| **role\_group\_versions**<br><br><br>STRING |
| **satisfaction\_level**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>first_satisfaction: OBJECT, which is also a nested data structure.											<ul><li>sent_by_teams: ARRAY, which is also a nested data structure.</li></ul></li><li>last_satisfaction: OBJECT, which is also a nested data structure.											<ul><li>sent_by_teams: ARRAY, which is also a nested data structure.</li></ul></li></ul> |
| **sentiment**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>confidence: NUMBER</li><li>polarity: INTEGER</li></ul> |
| **shared\_emails**<br><br><br>STRING |
| **shared\_external\_ids**<br><br><br>STRING |
| **shared\_phones**<br><br><br>STRING |
| **shared\_socials**<br><br><br>STRING |
| **signed\_up\_at**<br><br><br>STRING |
| **smooch\_ids**<br><br><br>STRING |
| **socials**<br><br><br>STRING |
| **tags**<br><br><br>STRING |
| **time\_zone**<br><br><br>STRING |
| **updated\_at**<br><br><br>STRING |
| **urls**<br><br><br>STRING |
| **username**<br><br><br>STRING |
| **verified**<br><br><br>BOOLEAN |
| **watchers**<br><br><br>STRING |
| **whatsapps**<br><br><br>STRING |

### kobjects

The `kobjects` table contains information about Kustomer objects in the Kustomer app.

| **Replication Method** | CDC |
| --- | --- |
| **Primary Key** | id |
| **Replication Key** | updated\_at |
| **Useful links** | [Kustomer documentation](https://dev.kustomer.com/v1/klasses/)<br><br>[Kustomer API method](https://dev.kustomer.com/v1/klasses/get-kobject "Opens in new tab: Kustomer API method") |

kobjects table schema

| **created\_at**<br><br><br>STRING |
| --- |
| **custom**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>billing_status_str: STRING</li><li>comment_txt: STRING</li><li>delighted_link_str: STRING</li><li>order_created_at: STRING</li><li>order_number_str: STRING</li><li>order_updated_at: STRING</li><li>purchase_amount_num: INTEGER</li><li>score_num: INTEGER</li><li>shipping_address_str: STRING</li><li>shipping_country_str: STRING</li><li>shipping_state_str: STRING</li><li>shipping_zip_str: STRING</li><li>skus_txt: STRING</li><li>special_instructions_str: STRING</li><li>tags_str: STRING</li><li>total_price_num: NUMBER</li><li>total_price_str: STRING</li><li>updated_at: STRING</li></ul> |
| **customer**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **description**<br><br><br>STRING |
| **external\_id**<br><br><br>STRING |
| **icon**<br><br><br>STRING |
| **id**<br><br><br>STRING |
| **klass**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **links**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>self: STRING</li></ul> |
| **org**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>type: STRING</li></ul> |
| **title**<br><br><br>STRING |
| **type**<br><br><br>STRING |
| **updated\_at**<br><br><br>STRING |

### messages

The `messages` table contains information about messages in the Kustomer app.

| **Replication Method** | CDC |
| --- | --- |
| **Primary Key** | id |
| **Replication Key** | updated\_at |
| **Useful links** | [Kustomer documentation](https://dev.kustomer.com/v1/messages/)<br><br>[Kustomer API method](https://dev.kustomer.com/v1/messages/get-message "Opens in new tab: Kustomer API method") |

messages table schema

| **created\_at**<br><br><br>STRING |
| --- |
| **custom**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>billing_status_str: STRING</li><li>comment_txt: STRING</li><li>delighted_link_str: STRING</li><li>order_created_at: STRING</li><li>order_number_str: STRING</li><li>order_updated_at: STRING</li><li>purchase_amount_num: INTEGER</li><li>score_num: INTEGER</li><li>shipping_address_str: STRING</li><li>shipping_country_str: STRING</li><li>shipping_state_str: STRING</li><li>shipping_zip_str: STRING</li><li>skus_txt: STRING</li><li>special_instructions_str: STRING</li><li>tags_str: STRING</li><li>total_price_num: NUMBER</li><li>total_price_str: STRING</li><li>updated_at: STRING</li></ul> |
| **customer**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **description**<br><br><br>STRING |
| **external\_id**<br><br><br>STRING |
| **icon**<br><br><br>STRING |
| **id**<br><br><br>STRING |
| **images**<br><br><br>ARRAY<br><br>This is a nested data structure. |
| **klass**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **links**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>self: STRING</li></ul> |
| **org**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **tags**<br><br><br>ARRAY<br><br>This is a nested data structure. |
| **title**<br><br><br>STRING |
| **type**<br><br><br>STRING |
| **updated\_at**<br><br><br>STRING |

### notes

The `notes` table contains information about notes in the Kustomer app.

| **Replication Method** | CDC |
| --- | --- |
| **Primary Key** | id |
| **Replication Key** | updated\_at |
| **Useful links** | [Kustomer documentation](https://dev.kustomer.com/v1/notes/)<br><br>[Kustomer API method](https://dev.kustomer.com/v1/notes/get-notes "Opens in new tab: Kustomer API method") |

notes table schema

| **body**<br><br><br>STRING |
| --- |
| **conversation**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **created\_at**<br><br><br>DATE-TIME |
| **created\_by**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **customer**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **deleted**<br><br><br>BOOLEAN |
| **deleted\_at**<br><br><br>DATE-TIME |
| **deleted\_by**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **external\_id**<br><br><br>STRING |
| **id**<br><br><br>STRING |
| **imported\_at**<br><br><br>DATE-TIME |
| **links**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>self: STRING</li></ul> |
| **modified\_at**<br><br><br>DATE-TIME |
| **modified\_by**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **org**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **type**<br><br><br>STRING |
| **updated\_at**<br><br><br>DATE-TIME |
| **user\_mentions**<br><br>ARRAY<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |

### shortcuts

The `shortcuts` table contains information about shortcuts in the Kustomer app.

| **Replication Method** | CDC |
| --- | --- |
| **Primary Key** | id |
| **Replication Key** | updated\_at |
| **Useful links** | [Kustomer documentation](https://dev.kustomer.com/v1/shortcuts)<br><br>[Kustomer API method](https://dev.kustomer.com/v1/shortcuts/KaRhy9CmfHsmaG4gZ "Opens in new tab: Kustomer API method") |

shortcuts table schema

| **conversation**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>name: OBJECT, which is also a nested data structure.											<ul><li>operator: STRING</li><li>value: STRING</li></ul></li><li>tags: OBJECT, which is also a nested data structure.											<ul><li>operator: STRING</li><li>value: STRING, which is also a nested data structure.</li></ul></li></ul> |
| --- |
| **created\_at**<br><br><br>DATE-TIME |
| **created\_by**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **deleted**<br><br><br>BOOLEAN |
| **draft**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>text: STRING</li></ul> |
| **id**<br><br><br>STRING |
| **is\_private**<br><br><br>BOOLEAN |
| **links**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>self: STRING</li></ul> |
| **modified\_at**<br><br><br>STRING |
| **modified\_by**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **name**<br><br><br>STRING |
| **org**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **payload**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>text: STRING, which is also a nested data structure.											<ul><li>blocks: ARRAY, which is also a nested data structure.													<ul><li>data: OBJECT, which is also a nested data structure.</li><li>depth: INTEGER</li><li>entity_ranges: ARRAY, which is also a nested data structure.															<ul><li>key: INTEGER</li><li>length: INTEGER</li><li>offset: INTEGER</li></ul></li><li>inline_style_ranges: ARRAY, which is also a nested data structure.															<ul><li>key: INTEGER</li><li>length: INTEGER</li><li>style: STRING</li></ul></li><li>key: STRING</li><li>text: STRING</li><li>type: STRING</li>														&gt;													</ul></li><li>entity_map: OBJECT, which is also a nested data structure.													<ul><li>0: OBJECT, which is also a nested data structure.															<ul><li>data: OBJECT, which is also a nested data structure.																	<ul><li>fallback_text: STRING</li><li>key: STRING</li><li>url: STRING</li></ul></li><li>mutability: STRING</li><li>type: STRING</li></ul></li><li>1: OBJECT, which is also a nested data structure.															<ul><li>data: OBJECT, which is also a nested data structure.																	<ul><li>fallback_text: STRING</li><li>key: STRING</li><li>url: STRING</li></ul></li><li>mutability: STRING</li><li>type: STRING</li></ul></li><li>2: OBJECT, which is also a nested data structure.															<ul><li>data: OBJECT, which is also a nested data structure.																	<ul><li>url: STRING</li></ul></li><li>mutability: STRING</li><li>type: STRING</li></ul></li><li>3: OBJECT, which is also a nested data structure.															<ul><li>data: OBJECT, which is also a nested data structure.																	<ul><li>url: STRING</li></ul></li><li>mutability: STRING</li><li>type: STRING</li></ul></li></ul></li></ul></li></ul> |
| **type**<br><br><br>STRING |
| **updated\_at**<br><br><br>DATE-TIME |

### tags

The `tags` table contains information about tags in the Kustomer app.

| **Replication Method** | CDC |
| --- | --- |
| **Primary Key** | id |
| **Replication Key** | updated\_at |
| **Useful links** | [Kustomer documentation](https://dev.kustomer.com/v1/tags/)<br><br>[Kustomer API method](https://dev.kustomer.com/v1/tags/NWydnz3xaPBWCePQp "Opens in new tab: Kustomer API method") |

tags table schema

| **color**<br><br><br>STRING |
| --- |
| **created\_at**<br><br><br>DATE-TIME |
| **created\_by**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **deleted**<br><br><br>BOOLEAN |
| **id**<br><br><br>STRING |
| **links**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>self: STRING</li></ul> |
| **modified\_at**<br><br><br>STRING |
| **modified\_by**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **name**<br><br><br>STRING |
| **org**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **type**<br><br><br>STRING |
| **updated\_at**<br><br><br>DATE-TIME |

### teams

The `teams` table contains information about teams in the Kustomer app.

| **Replication Method** | CDC |
| --- | --- |
| **Primary Key** | id |
| **Replication Key** | updated\_at |
| **Useful links** | [Kustomer documentation](https://dev.kustomer.com/v1/teams/)<br><br>[Kustomer API method](https://dev.kustomer.com/v1/teams/get-team "Opens in new tab: Kustomer API method") |

teams table schema

| **created\_at**<br><br><br>DATE-TIME |
| --- |
| **created\_by**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **deleted**<br><br><br>BOOLEAN |
| **deleted\_at**<br><br><br>STRING |
| **deleted\_by**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **display\_name**<br><br><br>STRING |
| **icon**<br><br><br>STRING |
| **id**<br><br><br>STRING |
| **links**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>self: STRING</li></ul> |
| **members**<br><br>ARRAY<br><br>This is a nested data structure. |
| **modified\_at**<br><br><br>STRING |
| **modified\_by**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **name**<br><br><br>STRING |
| **org**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **role\_groups**<br><br>ARRAY<br><br>This is a nested data structure. |
| **type**<br><br><br>STRING |
| **updated\_at**<br><br><br>DATE-TIME |

### users

The `users` table contains information about users in the Kustomer app.

| **Replication Method** | CDC |
| --- | --- |
| **Primary Key** | id |
| **Replication Key** | updated\_at |
| **Useful links** | [Kustomer documentation](https://dev.kustomer.com/v1/users/)<br><br>[Kustomer API method](https://dev.kustomer.com/v1/users/get-user "Opens in new tab: Kustomer API method") |

users table schema

| **avatar\_url**<br><br><br>STRING |
| --- |
| **created\_at**<br><br><br>DATE-TIME |
| **created\_by**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **deleted\_at**<br><br><br>STRING |
| **display\_name**<br><br><br>STRING |
| **email**<br><br><br>STRING |
| **email\_signature**<br><br><br>STRING |
| **email\_verified\_at**<br><br><br>STRING |
| **first\_email\_verified\_at**<br><br><br>STRING |
| **id**<br><br><br>STRING |
| **links**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>self: STRING</li></ul> |
| **mobile**<br><br><br>STRING |
| **modified\_at**<br><br><br>STRING |
| **modified\_by**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **name**<br><br><br>STRING |
| **org**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>type: STRING</li></ul> |
| **password**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>allow_new: BOOLEAN</li><li>force_new: BOOLEAN</li><li>updated_at: DATE-TIME</li></ul> |
| **role\_groups**<br><br>ARRAY<br><br>This is a nested data structure. |
| **roles**<br><br>ARRAY<br><br>This is a nested data structure. |
| **type**<br><br><br>STRING |
| **updated\_at**<br><br><br>DATE-TIME |
| **user\_type**<br><br><br>STRING |