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.

See the 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.

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

To create the API token:

Log into your Kustomer account.
Go to Settings > API Keys.
Click New API Key.
Select the roles that can have access to the API key.
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.
Click Create.
Copy and paste your API token into a secured file.

Creating the connection

For more information, see Connecting to SaaS applications.

Fill in the required connection properties.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.
Click Create.

Connection settings
Setting	Description
Data gateway	Select a Data Movement gateway if required by your use case. Information note 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. For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.
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

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

The schema and info displayed below is for version 1.

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 Kustomer API method

assigned_teams

ARRAY

This is a nested data structure.

assigned_users

ARRAY

This is a nested data structure.

channels

ARRAY

This is a nested data structure.

created_at

STRING

created_by

OBJECT

This is a nested data structure:

id: STRING
type: STRING

custom

OBJECT

This is a nested data structure:

auto_response_at: STRING
brand_str: STRING
business_area_str: STRING
case_id_str: STRING
close_out_tree: STRING
contact_reason_tree: STRING
desk_ticket_url: STRING
issue_report_tree: STRING
new_primary_menu_str: STRING
order_number_id: STRING
refund_status_str: STRING
return_requested_str: STRING
return_str: STRING
rma_id_str: STRING
serial_number_str: STRING
shopify_order_str: STRING
yale_call_reason_tree: STRING
yale_connectivity_str: STRING
yale_finish_str: STRING
yale_model_str: STRING
yale_notes_txt: STRING
yale_resolution_str: STRING
yale_serial_number_str: STRING

customer

OBJECT

This is a nested data structure:

id: STRING
type: STRING

direction

STRING

done_count

INTEGER

ended

BOOLEAN

ended_at

STRING

ended_by

OBJECT

This is a nested data structure:

id: STRING
type: STRING

ended_by_type

STRING

ended_reason

STRING

external_id

STRING

first_done

OBJECT

This is a nested data structure:

assigned_teams: ARRAY, which is also a nested data structure.
assigned_users: ARRAY, which is also a nested data structure.
business_time: INTEGER
created_at: STRING
created_by: STRING
created_by_teams: ARRAY, which is also a nested data structure.
last_message_direction: STRING
last_message_direction_type: STRING
message_count: INTEGER
message_count_by_channel: OBJECT, which is also a nested data structure.
- email: INTEGER
- sms: INTEGER
- voice: INTEGER
note_count: INTEGER
outbound_message_count: INTEGER
outbound_message_count_by_channel: OBJECT, which is is also a nested data structure.
- email: INTEGER
- sms: INTEGER
- voice: INTEGER
time: INTEGER

first_message_in

OBJECT

This is a nested data structure:

channel: STRING
created_at: STRING
direction_type: STRING
id: STRING
sent_at: STRING

first_message_out

OBJECT

This is a nested data structure:

channel: STRING
created_at: STRING
created_by: STRING
created_by_teams: ARRAY, which is also a nested data structure.
direction_type: STRING
id: STRING
sent_at: STRING

first_response

OBJECT

This is a nested data structure:

assigned_teams: ARRAY, which is also a nested data structure.
assigned_users: ARRAY, which is also a nested data structure.
business_time: INTEGER
created_at: STRING
created_by: STRING
created_by_teams: ARRAY, which is also a nested data structure.
id: STRING
response_time: INTEGER
sent_at: STRING
time: INTEGER

first_response_since_last_done

OBJECT

This is a nested data structure:

assigned_teams: ARRAY, which is also a nested data structure.
assigned_users: ARRAY, which is also a nested data structure.
business_time: INTEGER
created_at: STRING
created_by: STRING
created_by_teams: ARRAY, which is also a nested data structure.
id: STRING
response_time: INTEGER
sent_at: STRING
time: INTEGER

STRING

imported_at

STRING

last_activity_at

STRING

last_done

OBJECT

This is a nested data structure:

assigned_teams: ARRAY, which is also a nested data structure.
assigned_users: ARRAY, which is also a nested data structure.
business_time: INTEGER
created_at: STRING
created_by: STRING
created_by_teams: ARRAY, which is also a nested data structure.
last_message_direction: STRING
last_message_direction_type: INTEGER
message_count: STRING
message_count_by_channel: OBJECT, which is also a nested data structure.
- email: INTEGER
- sms: INTEGER
- voice: INTEGER
note_count: INTEGER
outbound_message_count: INTEGER
outbound_message_count_by_channel: OBJECT, which is also a nested data structure.
- email: INTEGER
- sms: INTEGER
- voice: INTEGER
time: INTEGER

last_message_at

STRING

last_message_direction

STRING

last_message_in

OBJECT

This is a nested data structure:

created_at: STRING
id: STRING
sent_at: STRING

last_message_out

OBJECT

This is a nested data structure:

created_at: STRING
id: STRING
sent_at: STRING

last_message_unresponded_to

OBJECT

This is a nested data structure:

created_at: STRING
id: STRING
sent_at: STRING

last_message_unresponded_to_since_last_done

OBJECT

This is a nested data structure:

created_at: STRING
id: STRING
sent_at: STRING

last_received_at

STRING

last_response

OBJECT

This is a nested data structure:

assigned_teams: ARRAY, which is also a nested data structure.
assigned_users: ARRAY, which is also a nested data structure.
business_time: INTEGER
created_at: STRING
created_by: STRING
created_by_teams: ARRAY, which is also a nested data structure.
id: STRING
time: INTEGER

links

OBJECT

This is a nested data structure:

self: STRING

merged_target

BOOLEAN

message_count

INTEGER

modified_at

STRING

modified_by

OBJECT

This is a nested data structure:

id: STRING
type: STRING

name

STRING

note_count

INTEGER

org

OBJECT

This is a nested data structure:

id: STRING
type: STRING

outbound_message_count

INTEGER

preview

STRING

priority

INTEGER

queue

OBJECT

This is a nested data structure:

id: STRING
type: STRING

reopen_count

INTEGER

rev

INTEGER

role_group_versions

STRING

satisfaction

STRING

satisfaction_level

OBJECT

This is a nested data structure:

sent_by_teams: ARRAY, which is also a nested data structure.

sla

OBJECT

This is a nested data structure:

breach: OBJECT, which is also a nested data structure.
- at: STRING
- metric: STRING
breached: BOOLEAN
matched_at: STRING
metrics: OBJECT, which is also a nested data structure.
- first_response: OBJECT, which is also a nested data structure.
  - breach_at: STRING
  - satisfied_at: STRING
- longest_unresponded_message: OBJECT, which is also a nested data structure.
  - breach_at: STRING
  - satisfied_at: STRING
status: STRING
summary: OBJECT, which is also a nested data structure.
- first_breach_at: STRING
- satisfied_at: STRING
version: INTEGER

sla_data

OBJECT

This is a nested data structure:

id: STRING
type: STRING

sla_version

OBJECT

This is a nested data structure:

id: STRING
type: STRING

snooze

OBJECT

This is a nested data structure:

status: STRING
status_at: STRING
time: STRING

snooze_count

INTEGER

status

STRING

suggested_shortcuts

STRING

suggested_tags

STRING

tags

ARRAY

This is a nested data structure.

total_done

OBJECT

This is a nested data structure:

business_time: INTEGER
time: INTEGER

total_open

OBJECT

This is a nested data structure:

business_time: INTEGER
business_time_since_last_done: INTEGER
time: INTEGER
time_since_last_done: INTEGER

total_snooze

OBJECT

This is a nested data structure:

business_time: INTEGER
time: INTEGER

type

STRING

updated_at

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 Kustomer API method

active_users

STRING

avatar_url

STRING

birthday_at

STRING

conversation_counts

OBJECT

This is a nested data structure:

all: INTEGER
done: INTEGER
open: INTEGER
snoozed: INTEGER

created_at

STRING

created_by

OBJECT

This is a nested data structure:

id: STRING
type: STRING

custom

OBJECT

This is a nested data structure:

accepts_marketing_bool: BOOLEAN
activation_date_str: STRING
app_version_str: STRING
august_id_str: STRING
august_serial_number_str: STRING
bridge_date_installed_at: STRING
bridge_serial_number_str: STRING
connect_firmware_version_str: STRING
connect_serial_number_str: STRING
doorbell_date_installed_at: STRING
doorbell_firmware_version_str: STRING
doorbell_serial_str: STRING
firmware_version_str: STRING
keypad_firmware_version_str: STRING
keypad_installed_at: STRING
keypad_serial_str: STRING
last_autoresponse_at: STRING
last_order_id_num: INTEGER
last_order_name_str: STRING
latest_csat_num: INTEGER
latest_nps_num: INTEGER
lock_date_installed_at: STRING
lock_firmware_version_str: STRING
lock_serial_number_str: STRING
orders_count_num: INTEGER
os00_str: STRING
owner_guest_str: STRING
products_owned_str: STRING
proof_of_purchase_str: STRING
purchase_date_str: STRING
sales_force_id_str: STRING
total_spent_num: INTEGER

deleted

STRING

display_color

STRING

display_icon

STRING

display_name

STRING

emails

ARRAY

This is a nested data structure:

email: STRING
type: STRING
verified: BOOLEAN

external_id

STRING

external_ids

ARRAY

This is a nested data structure:

external_id: STRING
verified: BOOLEAN

facebook_ids

STRING

first_name

STRING

gender

STRING

imported_at

DATE-TIME

instagram_ids

STRING

last_activity_at

DATE-TIME

last_conversation

OBJECT

This is a nested data structure:

channels: ARRAY, which is also a nested data structure.
id: STRING
sentiment: OBJECT, which is also a nested data structure.
- confidence: NUMBER
- polarity: INTEGER
tags: ARRAY, which is also a nested data structure.

last_customer_activity_at

STRING

last_message_at

STRING

last_message_in

OBJECT

This is a nested data structure:

channel: STRING
sent_at: STRING
sentiment: STRING

last_message_out

OBJECT

This is a nested data structure:

sent_at: STRING

last_message_unresponded_to

OBJECT

This is a nested data structure:

channel: STRING
sent_at: STRING

last_name

STRING

last_seen_at

STRING

links

OBJECT

This is a nested data structure:

self: STRING

locale

STRING

locations

STRING

modified_at

STRING

modified_by

OBJECT

This is a nested data structure:

id: STRING
type: STRING

name

STRING

org

OBJECT

This is a nested data structure:

id: STRING
type: STRING

phones

ARRAY

This is a nested data structure:

phone: STRING
type: STRING
verified: BOOLEAN

preview

OBJECT

This is a nested data structure:

channel: STRING
preview_at: STRING
subject: STRING
text: STRING
type: STRING

progressive_status

STRING

recent_items

ARRAY

This is a nested data structure:

id: STRING
meta: OBJECT, which is also a nested data structure.
- klass_name: STRING
type: STRING
updated_at: STRING

recent_location

OBJECT

This is a nested data structure:

updated_at: STRING

rev

INTEGER

role_group_versions

STRING

satisfaction_level

OBJECT

This is a nested data structure:

first_satisfaction: OBJECT, which is also a nested data structure.
- sent_by_teams: ARRAY, which is also a nested data structure.
last_satisfaction: OBJECT, which is also a nested data structure.
- sent_by_teams: ARRAY, which is also a nested data structure.

sentiment

OBJECT

This is a nested data structure:

confidence: NUMBER
polarity: INTEGER

shared_emails

STRING

shared_external_ids

STRING

shared_phones

STRING

shared_socials

STRING

signed_up_at

STRING

smooch_ids

STRING

socials

STRING

tags

STRING

time_zone

STRING

updated_at

STRING

urls

STRING

username

STRING

verified

BOOLEAN

watchers

STRING

whatsapps

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 Kustomer API method

created_at

STRING

custom

OBJECT

This is a nested data structure:

billing_status_str: STRING
comment_txt: STRING
delighted_link_str: STRING
order_created_at: STRING
order_number_str: STRING
order_updated_at: STRING
purchase_amount_num: INTEGER
score_num: INTEGER
shipping_address_str: STRING
shipping_country_str: STRING
shipping_state_str: STRING
shipping_zip_str: STRING
skus_txt: STRING
special_instructions_str: STRING
tags_str: STRING
total_price_num: NUMBER
total_price_str: STRING
updated_at: STRING

customer

OBJECT

This is a nested data structure:

id: STRING
type: STRING

description

STRING

external_id

STRING

icon

STRING

klass

OBJECT

This is a nested data structure:

id: STRING
type: STRING

links

OBJECT

This is a nested data structure:

self: STRING

org

OBJECT

This is a nested data structure:

type: STRING

title

STRING

type

STRING

updated_at

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 Kustomer API method

created_at

STRING

custom

OBJECT

This is a nested data structure:

billing_status_str: STRING
comment_txt: STRING
delighted_link_str: STRING
order_created_at: STRING
order_number_str: STRING
order_updated_at: STRING
purchase_amount_num: INTEGER
score_num: INTEGER
shipping_address_str: STRING
shipping_country_str: STRING
shipping_state_str: STRING
shipping_zip_str: STRING
skus_txt: STRING
special_instructions_str: STRING
tags_str: STRING
total_price_num: NUMBER
total_price_str: STRING
updated_at: STRING

customer

OBJECT

This is a nested data structure:

id: STRING
type: STRING

description

STRING

external_id

STRING

icon

STRING

images

ARRAY

This is a nested data structure.

klass

OBJECT

This is a nested data structure:

id: STRING
type: STRING

links

OBJECT

This is a nested data structure:

self: STRING

org

OBJECT

This is a nested data structure:

id: STRING
type: STRING

tags

ARRAY

This is a nested data structure.

title

STRING

type

STRING

updated_at

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 Kustomer API method

body

STRING

conversation

OBJECT

This is a nested data structure:

id: STRING
type: STRING

created_at

DATE-TIME

created_by

OBJECT

This is a nested data structure:

id: STRING
type: STRING

customer

OBJECT

This is a nested data structure:

id: STRING
type: STRING

deleted

BOOLEAN

deleted_at

DATE-TIME

deleted_by

OBJECT

This is a nested data structure:

id: STRING
type: STRING

external_id

STRING

imported_at

DATE-TIME

links

OBJECT

This is a nested data structure:

self: STRING

modified_at

DATE-TIME

modified_by

OBJECT

This is a nested data structure:

id: STRING
type: STRING

org

OBJECT

This is a nested data structure:

id: STRING
type: STRING

type

STRING

updated_at

DATE-TIME

user_mentions

ARRAY

This is a nested data structure:

id: STRING
type: STRING

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 Kustomer API method

conversation

OBJECT

This is a nested data structure:

name: OBJECT, which is also a nested data structure.
- operator: STRING
- value: STRING
tags: OBJECT, which is also a nested data structure.
- operator: STRING
- value: STRING, which is also a nested data structure.

created_at

DATE-TIME

created_by

OBJECT

This is a nested data structure:

id: STRING
type: STRING

deleted

BOOLEAN

draft

OBJECT

This is a nested data structure:

text: STRING

STRING

is_private

BOOLEAN

links

OBJECT

This is a nested data structure:

self: STRING

modified_at

STRING

modified_by

OBJECT

This is a nested data structure:

id: STRING
type: STRING

name

STRING

org

OBJECT

This is a nested data structure:

id: STRING
type: STRING

payload

OBJECT

This is a nested data structure:

text: STRING, which is also a nested data structure.
- blocks: ARRAY, which is also a nested data structure.
  - data: OBJECT, which is also a nested data structure.
  - depth: INTEGER
  - entity_ranges: ARRAY, which is also a nested data structure.
    - key: INTEGER
    - length: INTEGER
    - offset: INTEGER
  - inline_style_ranges: ARRAY, which is also a nested data structure.
    - key: INTEGER
    - length: INTEGER
    - style: STRING
  - key: STRING
  - text: STRING
  - type: STRING
- entity_map: OBJECT, which is also a nested data structure.
  - 0: OBJECT, which is also a nested data structure.
    - data: OBJECT, which is also a nested data structure.
      - fallback_text: STRING
      - key: STRING
      - url: STRING
    - mutability: STRING
    - type: STRING
  - 1: OBJECT, which is also a nested data structure.
    - data: OBJECT, which is also a nested data structure.
      - fallback_text: STRING
      - key: STRING
      - url: STRING
    - mutability: STRING
    - type: STRING
  - 2: OBJECT, which is also a nested data structure.
    - data: OBJECT, which is also a nested data structure.
      - url: STRING
    - mutability: STRING
    - type: STRING
  - 3: OBJECT, which is also a nested data structure.
    - data: OBJECT, which is also a nested data structure.
      - url: STRING
    - mutability: STRING
    - type: STRING

type

STRING

updated_at

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 Kustomer API method

created_at

DATE-TIME

created_by

OBJECT

This is a nested data structure:

id: STRING
type: STRING

deleted

BOOLEAN

deleted_at

STRING

deleted_by

OBJECT

This is a nested data structure:

id: STRING
type: STRING

display_name

STRING

icon

STRING

links

OBJECT

This is a nested data structure:

self: STRING

members

ARRAY

This is a nested data structure.

modified_at

STRING

modified_by

OBJECT

This is a nested data structure:

id: STRING
type: STRING

name

STRING

org

OBJECT

This is a nested data structure:

id: STRING
type: STRING

role_groups

ARRAY

This is a nested data structure.

type

STRING

updated_at

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 Kustomer API method

avatar_url

STRING

created_at

DATE-TIME

created_by

OBJECT

This is a nested data structure:

id: STRING
type: STRING

deleted_at

STRING

display_name

STRING

email

STRING

email_signature

STRING

email_verified_at

STRING

first_email_verified_at

STRING

links

OBJECT

This is a nested data structure:

self: STRING

mobile

STRING

modified_at

STRING

modified_by

OBJECT

This is a nested data structure:

id: STRING
type: STRING

name

STRING

org

OBJECT

This is a nested data structure:

id: STRING
type: STRING

password

OBJECT

This is a nested data structure:

allow_new: BOOLEAN
force_new: BOOLEAN
updated_at: DATE-TIME

role_groups

ARRAY

This is a nested data structure.

roles

ARRAY

This is a nested data structure.

type

STRING

updated_at

DATE-TIME

user_type

STRING

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here