Kustomer (v1)

Kustomer is supported by the Singer community
This integration is powered by Singer's Kustomer tap. For support, visit the GitHub repo or join the Singer Slack.

Kustomer integration summary

Stitch’s Kustomer integration replicates data using the Kustomer REST API v1. Refer to the Schema section for a list of objects available for replication.

Kustomer feature snapshot

A high-level look at Stitch's Kustomer (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status	Released on March 26, 2020	Supported by	Singer Community
Stitch plan	Standard	API availability	Available
Singer GitHub repository	singer-io/tap-kustomer
REPLICATION SETTINGS
Anchor Scheduling	Supported	Advanced Scheduling	Supported
Table-level reset	Unsupported	Configurable Replication Methods	Unsupported
DATA SELECTION
Table selection	Supported	Column selection	Supported
Select all	Supported
TRANSPARENCY
Extraction Logs	Supported	Loading Reports	Supported

Connecting Kustomer

Kustomer setup requirements

To set up Kustomer in Stitch, you need:

A Kustomer admin role. Admin permissions or a role with read and write security permissions are required to create an API key in Kustomer.

Step 1: Create a Kustomer API key

Login to your Kustomer account.
Navigate to Settings > API Keys
Click New API Key.
Select the roles that can have access to the API key.
Leave the API expriation options blank. If you set an expiration date, the API key will expire and break the connection to Stitch. In the event that this happens, you’ll need to re-generate the API key in Kustomer and enter the new key into Stitch.
Click Create.
Copy the API key and keep it readily available for the next step.

Note: Kustomer will only display the key once, so save it somewhere secure for future reference.

Step 2: Add Kustomer as a Stitch data source

Sign into your Stitch account.
On the Stitch Dashboard page, click the Add Integration button.
Click the Kustomer icon.
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

For example, the name “Stitch Kustomer” would create a schema called stitch_kustomer in the destination. Note: Schema names cannot be changed after you save the integration.
In the API Key field, paste the API key you obtained in Step 1.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Kustomer integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Kustomer’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 4: Create a replication schedule

Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the Replication Scheduling documentation for more information.

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Kustomer integrations support the following replication scheduling methods:

Replication Frequency
Anchor Scheduling
Advanced Scheduling using Cron (Advanced or Premium plans only)

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 5: Set objects to replicate

Is an object missing or not replicating? Verify that the object meets the requirements for selection and replication.

The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

For Kustomer integrations, you can select:

Individual tables and columns
All tables and columns

Click the tabs to view instructions for each selection method.

In the integration’s Tables to Replicate tab, locate a table you want to replicate.
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
Repeat this process for all the tables and columns you want to replicate.
When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.

Important: Using the Select All feature will overwrite any previous selections. However, selections aren’t final until Finalize Your Selections is clicked. Clicking Cancel will restore your previous selections. Refer to the Select All guide for more info about this feature.

Click into the integration from the Stitch Dashboard page.
Click the Tables to Replicate tab.
In the list of tables, click the box next to the Table Names column.
In the menu that displays, click Track all Tables and Fields:
Click the Finalize Your Selections button at the bottom of the page to save your data selections.

Initial and historical replication jobs

After you finish setting up Kustomer, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Initial replication jobs with Anchor Scheduling

If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Replication will continue after the seven days are over. If you’re no longer interested in this source, be sure to pause or delete the integration to prevent unwanted usage.

Kustomer table reference

Schemas and versioning

Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.

The schema and info displayed below is for version 1 of this integration.

This is the latest version of the Kustomer integration.

Table and column names in your destination

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

For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.

conversations

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	updated_at
Primary Key :	id	API endpoint :	getConversations

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

conversations table schema

id
STRING

The conversation ID.

updated_at
STRING

assigned_teams
ARRAY

Click to expand assigned_teams

value
STRING

conversations (table), assigned_teams (attribute)

assigned_users
ARRAY

Click to expand assigned_users

value
STRING

conversations (table), assigned_users (attribute)

channels
ARRAY

Click to expand channels

value
STRING

conversations (table), channels (attribute)

created_at
STRING

created_by
OBJECT

Click to expand created_by

id
STRING

type
STRING

conversations (table), created_by (attribute)

custom
OBJECT

Click to expand custom

auto_response_at
STRING

brand_str
STRING

case_id_str
STRING

close_out_tree
STRING

contact_reason_tree
STRING

desk_ticket_url
STRING

new_primary_menu_str
STRING

refund_status_str
STRING

return_requested_str
STRING

return_str
STRING

rma_id_str
STRING

serial_number_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

conversations (table), custom (attribute)

customer
OBJECT

Click to expand customer

id
STRING

type
STRING

conversations (table), customer (attribute)

direction
STRING

done_count
INTEGER

ended
BOOLEAN

ended_at
STRING

ended_by
OBJECT

Click to expand ended_by

id
STRING

type
STRING

conversations (table), ended_by (attribute)

ended_by_type
STRING

ended_reason
STRING

external_id
STRING

first_done
OBJECT

Click to expand first_done

assigned_teams
ARRAY

Click to expand assigned_teams

value
STRING

conversations (table), assigned_teams (attribute)

assigned_users
ARRAY

Click to expand assigned_users

value
STRING

conversations (table), assigned_users (attribute)

business_time
INTEGER

created_at
STRING

created_by
STRING

created_by_teams
ARRAY

Click to expand created_by_teams

value
STRING

conversations (table), created_by_teams (attribute)

last_message_direction
STRING

last_message_direction_type
STRING

message_count
INTEGER

message_count_by_channel
OBJECT

Click to expand message_count_by_channel

email
INTEGER

sms
INTEGER

voice
INTEGER

conversations (table), message_count_by_channel (attribute)

note_count
INTEGER

outbound_message_count
INTEGER

outbound_message_count_by_channel
OBJECT

Click to expand outbound_message_count_by_channel

email
INTEGER

sms
INTEGER

voice
INTEGER

conversations (table), outbound_message_count_by_channel (attribute)

time
INTEGER

conversations (table), first_done (attribute)

first_message_in
OBJECT

Click to expand first_message_in

channel
STRING

created_at
STRING

direction_type
STRING

id
STRING

sent_at
STRING

conversations (table), first_message_in (attribute)

first_message_out
OBJECT

Click to expand first_message_out

channel
STRING

created_at
STRING

created_by
STRING

created_by_teams
ARRAY

Click to expand created_by_teams

value
STRING

conversations (table), created_by_teams (attribute)

direction_type
STRING

id
STRING

sent_at
STRING

conversations (table), first_message_out (attribute)

first_response
OBJECT

Click to expand first_response

assigned_teams
ARRAY

Click to expand assigned_teams

value
STRING

conversations (table), assigned_teams (attribute)

assigned_users
ARRAY

Click to expand assigned_users

value
STRING

conversations (table), assigned_users (attribute)

business_time
INTEGER

created_at
STRING

created_by
STRING

created_by_teams
ARRAY

Click to expand created_by_teams

value
STRING

conversations (table), created_by_teams (attribute)

id
STRING

response_time
INTEGER

sent_at
STRING

time
INTEGER

conversations (table), first_response (attribute)

first_response_since_last_done
OBJECT

Click to expand first_response_since_last_done

assigned_teams
ARRAY

Click to expand assigned_teams

value
STRING

conversations (table), assigned_teams (attribute)

assigned_users
ARRAY

Click to expand assigned_users

value
STRING

conversations (table), assigned_users (attribute)

business_time
INTEGER

created_at
STRING

created_by
STRING

created_by_teams
ARRAY

Click to expand created_by_teams

value
STRING

conversations (table), created_by_teams (attribute)

id
STRING

response_time
INTEGER

sent_at
STRING

time
INTEGER

conversations (table), first_response_since_last_done (attribute)

imported_at
STRING

last_activity_at
STRING

last_done
OBJECT

Click to expand last_done

assigned_teams
ARRAY

Click to expand assigned_teams

value
STRING

conversations (table), assigned_teams (attribute)

assigned_users
ARRAY

Click to expand assigned_users

value
STRING

conversations (table), assigned_users (attribute)

business_time
INTEGER

created_at
STRING

created_by
STRING

created_by_teams
ARRAY

Click to expand created_by_teams

value
STRING

conversations (table), created_by_teams (attribute)

last_message_direction
STRING

last_message_direction_type
STRING

message_count
INTEGER

message_count_by_channel
OBJECT

Click to expand message_count_by_channel

email
INTEGER

sms
INTEGER

voice
INTEGER

conversations (table), message_count_by_channel (attribute)

note_count
INTEGER

outbound_message_count
INTEGER

outbound_message_count_by_channel
OBJECT

Click to expand outbound_message_count_by_channel

email
INTEGER

sms
INTEGER

voice
INTEGER

conversations (table), outbound_message_count_by_channel (attribute)

time
INTEGER

conversations (table), last_done (attribute)

last_message_at
STRING

last_message_direction
STRING

last_message_in
OBJECT

Click to expand last_message_in

created_at
STRING

id
STRING

sent_at
STRING

conversations (table), last_message_in (attribute)

last_message_out
OBJECT

Click to expand last_message_out

created_at
STRING

id
STRING

sent_at
STRING

conversations (table), last_message_out (attribute)

last_message_unresponded_to
OBJECT

Click to expand last_message_unresponded_to

created_at
STRING

id
STRING

sent_at
STRING

conversations (table), last_message_unresponded_to (attribute)

last_message_unresponded_to_since_last_done
OBJECT

Click to expand last_message_unresponded_to_since_last_done

created_at
STRING

id
STRING

sent_at
STRING

conversations (table), last_message_unresponded_to_since_last_done (attribute)

last_received_at
STRING

last_response
OBJECT

Click to expand last_response

assigned_teams
ARRAY

Click to expand assigned_teams

value
STRING

conversations (table), assigned_teams (attribute)

assigned_users
ARRAY

Click to expand assigned_users

value
STRING

conversations (table), assigned_users (attribute)

business_time
INTEGER

created_at
STRING

created_by
STRING

created_by_teams
ARRAY

Click to expand created_by_teams

value
STRING

conversations (table), created_by_teams (attribute)

id
STRING

time
INTEGER

conversations (table), last_response (attribute)

links
OBJECT

Click to expand links

self
STRING

conversations (table), links (attribute)

merged_target
BOOLEAN

message_count
INTEGER

modified_at
STRING

modified_by
OBJECT

Click to expand modified_by

id
STRING

type
STRING

conversations (table), modified_by (attribute)

name
STRING

note_count
INTEGER

org
OBJECT

Click to expand org

id
STRING

type
STRING

conversations (table), org (attribute)

outbound_message_count
INTEGER

preview
STRING

priority
INTEGER

queue
OBJECT

Click to expand queue

id
STRING

type
STRING

conversations (table), queue (attribute)

reopen_count
INTEGER

rev
INTEGER

role_group_versions
STRING

satisfaction
STRING

satisfaction_level
OBJECT

Click to expand satisfaction_level

sent_by_teams
ARRAY

Click to expand sent_by_teams

value
STRING

conversations (table), sent_by_teams (attribute)

conversations (table), satisfaction_level (attribute)

sla
OBJECT

Click to expand sla

breach
OBJECT

Click to expand breach

at
STRING

metric
STRING

conversations (table), breach (attribute)

breached
BOOLEAN

matched_at
STRING

metrics
OBJECT

Click to expand metrics

first_response
OBJECT

Click to expand first_response

breach_at
STRING

satisfied_at
STRING

conversations (table), first_response (attribute)

longest_unresponded_message
OBJECT

Click to expand longest_unresponded_message

breach_at
STRING

satisfied_at
STRING

conversations (table), longest_unresponded_message (attribute)

conversations (table), metrics (attribute)

status
STRING

summary
OBJECT

Click to expand summary

first_breach_at
STRING

satisfied_at
STRING

conversations (table), summary (attribute)

version
INTEGER

conversations (table), sla (attribute)

sla_data
OBJECT

Click to expand sla_data

id
STRING

type
STRING

conversations (table), sla_data (attribute)

sla_version
OBJECT

Click to expand sla_version

id
STRING

type
STRING

conversations (table), sla_version (attribute)

snooze
OBJECT

Click to expand snooze

status
STRING

status_at
STRING

time
STRING

conversations (table), snooze (attribute)

snooze_count
INTEGER

status
STRING

suggested_shortcuts
STRING

suggested_tags
STRING

tags
ARRAY

Click to expand tags

value
STRING

conversations (table), tags (attribute)

total_done
OBJECT

Click to expand total_done

business_time
INTEGER

time
INTEGER

conversations (table), total_done (attribute)

total_open
OBJECT

Click to expand total_open

business_time
INTEGER

business_time_since_last_done
INTEGER

time
INTEGER

time_since_last_done
INTEGER

conversations (table), total_open (attribute)

total_snooze
OBJECT

Click to expand total_snooze

business_time
INTEGER

time
INTEGER

conversations (table), total_snooze (attribute)

type
STRING

customers

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	updated_at
Primary Key :	id	API endpoint :	getCustomers

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

customers table schema

id
STRING

The customer ID.

updated_at
STRING

active_users
STRING

avatar_url
STRING

birthday_at
STRING

conversation_counts
OBJECT

Click to expand conversation_counts

all
INTEGER

done
INTEGER

open
INTEGER

snoozed
INTEGER

customers (table), conversation_counts (attribute)

created_at
STRING

created_by
OBJECT

Click to expand created_by

id
STRING

type
STRING

customers (table), created_by (attribute)

custom
OBJECT

Click to expand custom

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

customers (table), custom (attribute)

deleted
STRING

display_color
STRING

display_icon
STRING

display_name
STRING

emails
ARRAY

Click to expand emails

email
STRING

type
STRING

verified
BOOLEAN

customers (table), emails (attribute)

external_id
STRING

external_ids
ARRAY

Click to expand external_ids

type
STRING

verified
BOOLEAN

customers (table), external_ids (attribute)

facebook_ids
STRING

first_name
STRING

gender
STRING

imported_at
DATE-TIME

instagram_ids
STRING

last_activity_at
DATE-TIME

last_conversation
OBJECT

Click to expand last_conversation

channels
ARRAY

Click to expand channels

value
STRING

customers (table), channels (attribute)

id
STRING

sentiment
OBJECT

Click to expand sentiment

confidence
NUMBER

polarity
INTEGER

customers (table), sentiment (attribute)

tags
ARRAY

Click to expand tags

value
STRING

customers (table), tags (attribute)

customers (table), last_conversation (attribute)

last_customer_activity_at
STRING

last_message_at
STRING

last_message_in
OBJECT

Click to expand last_message_in

channel
STRING

sent_at
STRING

sentiment
STRING

customers (table), last_message_in (attribute)

last_message_out
OBJECT

Click to expand last_message_out

sent_at
STRING

customers (table), last_message_out (attribute)

last_message_unresponded_to
OBJECT

Click to expand last_message_unresponded_to

channel
STRING

sent_at
STRING

customers (table), last_message_unresponded_to (attribute)

last_name
STRING

last_seen_at
STRING

links
OBJECT

Click to expand links

self
STRING

customers (table), links (attribute)

locale
STRING

locations
STRING

modified_at
STRING

modified_by
OBJECT

Click to expand modified_by

id
STRING

type
STRING

customers (table), modified_by (attribute)

name
STRING

org
OBJECT

Click to expand org

id
STRING

type
STRING

customers (table), org (attribute)

phones
ARRAY

Click to expand phones

phone
STRING

type
STRING

verified
BOOLEAN

customers (table), phones (attribute)

preview
OBJECT

Click to expand preview

channel
STRING

preview_at
STRING

subject
STRING

text
STRING

type
STRING

customers (table), preview (attribute)

progressive_status
STRING

recent_items
ARRAY

Click to expand recent_items

id
STRING

meta
OBJECT

Click to expand meta

klass_name

customers (table), meta (attribute)

type
STRING

updated_at
STRING

customers (table), recent_items (attribute)

recent_location
OBJECT

Click to expand recent_location

updated_at
STRING

customers (table), recent_location (attribute)

rev
INTEGER

role_group_versions
STRING

satisfaction_level
OBJECT

Click to expand satisfaction_level

first_satisfaction
OBJECT

Click to expand first_satisfaction

sent_by_teams
ARRAY

Click to expand sent_by_teams

value
STRING

customers (table), sent_by_teams (attribute)

customers (table), first_satisfaction (attribute)

last_satisfaction
OBJECT

Click to expand last_satisfaction

sent_by_teams
ARRAY

Click to expand sent_by_teams

value
STRING

customers (table), sent_by_teams (attribute)

customers (table), last_satisfaction (attribute)

customers (table), satisfaction_level (attribute)

sentiment
OBJECT

Click to expand sentiment

confidence
NUMBER

polarity
INTEGER

customers (table), sentiment (attribute)

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

urls
STRING

username
STRING

verified
BOOLEAN

watchers
STRING

whatsapps
STRING

kobjects

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	updated_at
Primary Key :	id	API endpoint :	getKObject

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

kobjects table schema

id
STRING

The KObject ID.

updated_at
STRING

The date the object was last updated.

created_at
STRING

custom
OBJECT

Click to expand custom

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

kobjects (table), custom (attribute)

customer
OBJECT

Click to expand customer

id
STRING

type
STRING

kobjects (table), customer (attribute)

description
STRING

external_id
STRING

icon
STRING

klass
OBJECT

Click to expand klass

id
STRING

type
STRING

kobjects (table), klass (attribute)

links
OBJECT

Click to expand links

self
STRING

kobjects (table), links (attribute)

org
OBJECT

Click to expand org

type
STRING

kobjects (table), org (attribute)

title
STRING

type
STRING

messages

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	updated_at
Primary Key :	id	API endpoint :	getMessages

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

messages table schema

id
STRING

The message ID.

updated_at
STRING

The day the message was last updated.

created_at
STRING

custom
OBJECT

Click to expand custom

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

messages (table), custom (attribute)

customer
OBJECT

Click to expand customer

id
STRING

type
STRING

messages (table), customer (attribute)

description
STRING

external_id
STRING

icon
STRING

images
ARRAY

Click to expand images

value
STRING

messages (table), images (attribute)

klass
OBJECT

Click to expand klass

id
STRING

type
STRING

messages (table), klass (attribute)

links
OBJECT

Click to expand links

self
STRING

messages (table), links (attribute)

org
OBJECT

Click to expand org

type
STRING

messages (table), org (attribute)

tags
ARRAY

Click to expand tags

value
STRING

messages (table), tags (attribute)

title
STRING

type
STRING

notes

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	updated_at
Primary Key :	id	API endpoint :	getNotes

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

notes table schema

id
STRING

The note ID.

updated_at
DATE-TIME

body
STRING

conversation
OBJECT

Click to expand conversation

id
STRING

type
STRING

notes (table), conversation (attribute)

created_at
DATE-TIME

created_by
OBJECT

Click to expand created_by

id
STRING

type
STRING

notes (table), created_by (attribute)

customer
OBJECT

Click to expand customer

id
STRING

type
STRING

notes (table), customer (attribute)

deleted
BOOLEAN

deleted_at
DATE-TIME

deleted_by
OBJECT

Click to expand deleted_by

id
STRING

type
STRING

notes (table), deleted_by (attribute)

external_id
STRING

imported_at
DATE-TIME

links
OBJECT

Click to expand links

self
STRING

notes (table), links (attribute)

modified_at
DATE-TIME

modified_by
OBJECT

Click to expand modified_by

id
STRING

type
STRING

notes (table), modified_by (attribute)

org
OBJECT

Click to expand org

id
STRING

type
STRING

notes (table), org (attribute)

type
STRING

user_mentions
ARRAY

Click to expand user_mentions

id
STRING

type
STRING

notes (table), user_mentions (attribute)

shortcuts

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	updated_at
Primary Key :	id	API endpoint :	getShortcuts

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

shortcuts table schema

id
STRING

The shortcut ID.

updated_at
DATE-TIME

The time the shortcut was last updated.

conversation
OBJECT

Click to expand conversation

name
OBJECT

Click to expand name

operator
STRING

value
STRING

shortcuts (table), name (attribute)

tags
OBJECT

Click to expand tags

operator
STRING

value
ARRAY

Click to expand value

value
STRING

shortcuts (table), value (attribute)

shortcuts (table), tags (attribute)

shortcuts (table), conversation (attribute)

created_at
DATE-TIME

created_by
OBJECT

Click to expand created_by

id
STRING

type
STRING

shortcuts (table), created_by (attribute)

deleted
BOOLEAN

draft
OBJECT

Click to expand draft

text
STRING

shortcuts (table), draft (attribute)

is_private
BOOLEAN

links
OBJECT

Click to expand links

self
STRING

shortcuts (table), links (attribute)

modified_at
STRING

modified_by
OBJECT

Click to expand modified_by

id
STRING

type
STRING

shortcuts (table), modified_by (attribute)

name
STRING

org
OBJECT

Click to expand org

id
STRING

type
STRING

shortcuts (table), org (attribute)

payload
OBJECT

Click to expand payload

text
OBJECT

Click to expand text

blocks
ARRAY

Click to expand blocks

data
OBJECT

Click to expand data

shortcuts (table), data (attribute)

depth
INTEGER

entity_ranges
ARRAY

Click to expand entity_ranges

key
INTEGER

length
INTEGER

offset
INTEGER

shortcuts (table), entity_ranges (attribute)

inline_style_ranges
ARRAY

Click to expand inline_style_ranges

length
INTEGER

offset
INTEGER

style
STRING

shortcuts (table), inline_style_ranges (attribute)

key
STRING

text
STRING

type
STRING

shortcuts (table), blocks (attribute)

entity_map
OBJECT

Click to expand entity_map

0
OBJECT

Click to expand 0

data
OBJECT

Click to expand data

fallback_text
STRING

key
STRING

url
STRING

shortcuts (table), data (attribute)

mutability
STRING

type
STRING

shortcuts (table), 0 (attribute)

1
OBJECT

Click to expand 1

data
OBJECT

Click to expand data

fallback_text
STRING

key
STRING

url
STRING

shortcuts (table), data (attribute)

mutability
STRING

type
STRING

shortcuts (table), 1 (attribute)

2
OBJECT

Click to expand 2

data
OBJECT

Click to expand data

url
STRING

shortcuts (table), data (attribute)

mutability
STRING

type
STRING

shortcuts (table), 2 (attribute)

3
OBJECT

Click to expand 3

data
OBJECT

Click to expand data

url
STRING

shortcuts (table), data (attribute)

mutability
STRING

type
STRING

shortcuts (table), 3 (attribute)

shortcuts (table), entity_map (attribute)

shortcuts (table), text (attribute)

shortcuts (table), payload (attribute)

type
STRING

teams

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	updated_at
Primary Key :	id	API endpoint :	getTeams

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

teams table schema

id
STRING

The team ID.

updated_at
DATE-TIME

The time the team was last updated.

created_at
DATE-TIME

created_by
OBJECT

Click to expand created_by

id
STRING

type
STRING

teams (table), created_by (attribute)

deleted
BOOLEAN

deleted_at
STRING

deleted_by
OBJECT

Click to expand deleted_by

id
STRING

type
STRING

teams (table), deleted_by (attribute)

display_name
STRING

icon
STRING

links
OBJECT

Click to expand links

self
STRING

teams (table), links (attribute)

members
ARRAY

Click to expand members

value
STRING

teams (table), members (attribute)

modified_at
STRING

modified_by
OBJECT

Click to expand modified_by

id
STRING

type
STRING

teams (table), modified_by (attribute)

name
STRING

org
OBJECT

Click to expand org

id
STRING

type
STRING

teams (table), org (attribute)

role_groups
ARRAY

Click to expand role_groups

value
STRING

teams (table), role_groups (attribute)

type
STRING

users

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	updated_at
Primary Key :	id	API endpoint :	getUsers

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

Kustomer integration summary

Kustomer feature snapshot

Connecting Kustomer

Kustomer setup requirements

Step 1: Create a Kustomer API key

Step 2: Add Kustomer as a Stitch data source

Step 3: Define the historical replication start date

Step 4: Create a replication schedule

Step 5: Set objects to replicate

Initial and historical replication jobs

Free historical data loads

Kustomer table reference

conversations

conversations table schema

customers

customers table schema

kobjects

kobjects table schema

messages

messages table schema

notes

notes table schema

shortcuts

shortcuts table schema

tags

tags table schema

teams

teams table schema

users

users table schema