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 | |
| Stitch plan |
Standard |
API availability |
Available |
| Singer GitHub repository | |||
| 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_kustomerin 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
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:
-
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
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.
- 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.
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
The conversations table contains information about conversations in the Kustomer app.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
assigned_teams
ARRAY |
|||||||||||||||||||||||
|
assigned_users
ARRAY |
|||||||||||||||||||||||
|
channels
ARRAY |
|||||||||||||||||||||||
|
created_at STRING |
|||||||||||||||||||||||
|
created_by OBJECT
|
|||||||||||||||||||||||
|
custom OBJECT
|
|||||||||||||||||||||||
|
customer OBJECT
|
|||||||||||||||||||||||
|
direction STRING |
|||||||||||||||||||||||
|
done_count INTEGER |
|||||||||||||||||||||||
|
ended BOOLEAN |
|||||||||||||||||||||||
|
ended_at STRING |
|||||||||||||||||||||||
|
ended_by OBJECT
|
|||||||||||||||||||||||
|
ended_by_type STRING |
|||||||||||||||||||||||
|
ended_reason STRING |
|||||||||||||||||||||||
|
external_id STRING |
|||||||||||||||||||||||
|
first_done OBJECT
|
|||||||||||||||||||||||
|
first_message_in OBJECT
|
|||||||||||||||||||||||
|
first_message_out OBJECT
|
|||||||||||||||||||||||
|
first_response OBJECT
|
|||||||||||||||||||||||
|
first_response_since_last_done OBJECT
|
|||||||||||||||||||||||
|
id
STRING |
|||||||||||||||||||||||
|
imported_at STRING |
|||||||||||||||||||||||
|
last_activity_at STRING |
|||||||||||||||||||||||
|
last_done OBJECT
|
|||||||||||||||||||||||
|
last_message_at STRING |
|||||||||||||||||||||||
|
last_message_direction STRING |
|||||||||||||||||||||||
|
last_message_in OBJECT
|
|||||||||||||||||||||||
|
last_message_out OBJECT
|
|||||||||||||||||||||||
|
last_message_unresponded_to OBJECT
|
|||||||||||||||||||||||
|
last_message_unresponded_to_since_last_done OBJECT
|
|||||||||||||||||||||||
|
last_received_at STRING |
|||||||||||||||||||||||
|
last_response OBJECT
|
|||||||||||||||||||||||
|
links OBJECT
|
|||||||||||||||||||||||
|
merged_target BOOLEAN |
|||||||||||||||||||||||
|
message_count INTEGER |
|||||||||||||||||||||||
|
modified_at STRING |
|||||||||||||||||||||||
|
modified_by OBJECT
|
|||||||||||||||||||||||
|
name STRING |
|||||||||||||||||||||||
|
note_count INTEGER |
|||||||||||||||||||||||
|
org OBJECT
|
|||||||||||||||||||||||
|
outbound_message_count INTEGER |
|||||||||||||||||||||||
|
preview STRING |
|||||||||||||||||||||||
|
priority INTEGER |
|||||||||||||||||||||||
|
queue OBJECT
|
|||||||||||||||||||||||
|
reopen_count INTEGER |
|||||||||||||||||||||||
|
rev INTEGER |
|||||||||||||||||||||||
|
role_group_versions STRING |
|||||||||||||||||||||||
|
satisfaction STRING |
|||||||||||||||||||||||
|
satisfaction_level OBJECT
|
|||||||||||||||||||||||
|
sla OBJECT
|
|||||||||||||||||||||||
|
sla_data OBJECT
|
|||||||||||||||||||||||
|
sla_version OBJECT
|
|||||||||||||||||||||||
|
snooze OBJECT
|
|||||||||||||||||||||||
|
snooze_count INTEGER |
|||||||||||||||||||||||
|
status STRING |
|||||||||||||||||||||||
|
suggested_shortcuts STRING |
|||||||||||||||||||||||
|
suggested_tags STRING |
|||||||||||||||||||||||
|
tags
ARRAY |
|||||||||||||||||||||||
|
total_done OBJECT
|
|||||||||||||||||||||||
|
total_open OBJECT
|
|||||||||||||||||||||||
|
total_snooze OBJECT
|
|||||||||||||||||||||||
|
type STRING |
|||||||||||||||||||||||
|
updated_at
STRING |
customers
The customers table contains information about customers in the Kustomer app.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
active_users STRING |
||||||||||||||||||||||||||||||||
|
avatar_url STRING |
||||||||||||||||||||||||||||||||
|
birthday_at STRING |
||||||||||||||||||||||||||||||||
|
conversation_counts OBJECT
|
||||||||||||||||||||||||||||||||
|
created_at STRING |
||||||||||||||||||||||||||||||||
|
created_by OBJECT
|
||||||||||||||||||||||||||||||||
|
custom OBJECT
|
||||||||||||||||||||||||||||||||
|
deleted STRING |
||||||||||||||||||||||||||||||||
|
display_color STRING |
||||||||||||||||||||||||||||||||
|
display_icon STRING |
||||||||||||||||||||||||||||||||
|
display_name STRING |
||||||||||||||||||||||||||||||||
|
emails
ARRAY
|
||||||||||||||||||||||||||||||||
|
external_id STRING |
||||||||||||||||||||||||||||||||
|
external_ids
ARRAY
|
||||||||||||||||||||||||||||||||
|
facebook_ids STRING |
||||||||||||||||||||||||||||||||
|
first_name STRING |
||||||||||||||||||||||||||||||||
|
gender STRING |
||||||||||||||||||||||||||||||||
|
id
STRING |
||||||||||||||||||||||||||||||||
|
imported_at DATE-TIME |
||||||||||||||||||||||||||||||||
|
instagram_ids STRING |
||||||||||||||||||||||||||||||||
|
last_activity_at DATE-TIME |
||||||||||||||||||||||||||||||||
|
last_conversation OBJECT
|
||||||||||||||||||||||||||||||||
|
last_customer_activity_at STRING |
||||||||||||||||||||||||||||||||
|
last_message_at STRING |
||||||||||||||||||||||||||||||||
|
last_message_in OBJECT
|
||||||||||||||||||||||||||||||||
|
last_message_out OBJECT
|
||||||||||||||||||||||||||||||||
|
last_message_unresponded_to OBJECT
|
||||||||||||||||||||||||||||||||
|
last_name STRING |
||||||||||||||||||||||||||||||||
|
last_seen_at STRING |
||||||||||||||||||||||||||||||||
|
links OBJECT
|
||||||||||||||||||||||||||||||||
|
locale STRING |
||||||||||||||||||||||||||||||||
|
locations STRING |
||||||||||||||||||||||||||||||||
|
modified_at STRING |
||||||||||||||||||||||||||||||||
|
modified_by OBJECT
|
||||||||||||||||||||||||||||||||
|
name STRING |
||||||||||||||||||||||||||||||||
|
org OBJECT
|
||||||||||||||||||||||||||||||||
|
phones
ARRAY
|
||||||||||||||||||||||||||||||||
|
preview OBJECT
|
||||||||||||||||||||||||||||||||
|
progressive_status STRING |
||||||||||||||||||||||||||||||||
|
recent_items
ARRAY
|
||||||||||||||||||||||||||||||||
|
recent_location OBJECT
|
||||||||||||||||||||||||||||||||
|
rev INTEGER |
||||||||||||||||||||||||||||||||
|
role_group_versions STRING |
||||||||||||||||||||||||||||||||
|
satisfaction_level OBJECT
|
||||||||||||||||||||||||||||||||
|
sentiment OBJECT
|
||||||||||||||||||||||||||||||||
|
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.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
created_at STRING |
||||||||||||||||||
|
custom OBJECT
|
||||||||||||||||||
|
customer OBJECT
|
||||||||||||||||||
|
description STRING |
||||||||||||||||||
|
external_id STRING |
||||||||||||||||||
|
icon STRING |
||||||||||||||||||
|
id
STRING |
||||||||||||||||||
|
klass OBJECT
|
||||||||||||||||||
|
links OBJECT
|
||||||||||||||||||
|
org OBJECT
|
||||||||||||||||||
|
title STRING |
||||||||||||||||||
|
type STRING |
||||||||||||||||||
|
updated_at
STRING |
messages
The messages table contains information about messages in the Kustomer app.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
created_at STRING |
||||||||||||||||||
|
custom OBJECT
|
||||||||||||||||||
|
customer OBJECT
|
||||||||||||||||||
|
description STRING |
||||||||||||||||||
|
external_id STRING |
||||||||||||||||||
|
icon STRING |
||||||||||||||||||
|
id
STRING |
||||||||||||||||||
|
images ARRAY |
||||||||||||||||||
|
klass OBJECT
|
||||||||||||||||||
|
links OBJECT
|
||||||||||||||||||
|
org OBJECT
|
||||||||||||||||||
|
tags ARRAY |
||||||||||||||||||
|
title STRING |
||||||||||||||||||
|
type STRING |
||||||||||||||||||
|
updated_at
STRING |
notes
The notes table contains information about notes in the Kustomer app.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
body STRING |
||
|
conversation OBJECT
|
||
|
created_at DATE-TIME |
||
|
created_by OBJECT
|
||
|
customer OBJECT
|
||
|
deleted BOOLEAN |
||
|
deleted_at DATE-TIME |
||
|
deleted_by OBJECT
|
||
|
external_id STRING |
||
|
id
STRING |
||
|
imported_at DATE-TIME |
||
|
links OBJECT
|
||
|
modified_at DATE-TIME |
||
|
modified_by OBJECT
|
||
|
org OBJECT
|
||
|
type STRING |
||
|
updated_at
DATE-TIME |
||
|
user_mentions
ARRAY
|
shortcuts
The shortcuts table contains information about shortcuts in the Kustomer app.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
conversation OBJECT
|
||||||||||||||||||||||||||||||||||||||||
|
created_at DATE-TIME |
||||||||||||||||||||||||||||||||||||||||
|
created_by OBJECT
|
||||||||||||||||||||||||||||||||||||||||
|
deleted BOOLEAN |
||||||||||||||||||||||||||||||||||||||||
|
draft OBJECT
|
||||||||||||||||||||||||||||||||||||||||
|
id
STRING |
||||||||||||||||||||||||||||||||||||||||
|
is_private BOOLEAN |
||||||||||||||||||||||||||||||||||||||||
|
links OBJECT
|
||||||||||||||||||||||||||||||||||||||||
|
modified_at STRING |
||||||||||||||||||||||||||||||||||||||||
|
modified_by OBJECT
|
||||||||||||||||||||||||||||||||||||||||
|
name STRING |
||||||||||||||||||||||||||||||||||||||||
|
org OBJECT
|
||||||||||||||||||||||||||||||||||||||||
|
payload OBJECT
|
||||||||||||||||||||||||||||||||||||||||
|
type STRING |
||||||||||||||||||||||||||||||||||||||||
|
updated_at
DATE-TIME |
tags
The tags table contains information about tags in the Kustomer app.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
color STRING |
||
|
created_at DATE-TIME |
||
|
created_by OBJECT
|
||
|
deleted BOOLEAN |
||
|
id
STRING |
||
|
links OBJECT
|
||
|
modified_at STRING |
||
|
modified_by OBJECT
|
||
|
name STRING |
||
|
org OBJECT
|
||
|
type STRING |
||
|
updated_at
DATE-TIME |
teams
The teams table contains information about teams in the Kustomer app.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
created_at DATE-TIME |
||
|
created_by OBJECT
|
||
|
deleted BOOLEAN |
||
|
deleted_at STRING |
||
|
deleted_by OBJECT
|
||
|
display_name STRING |
||
|
icon STRING |
||
|
id
STRING |
||
|
links OBJECT
|
||
|
members
ARRAY |
||
|
modified_at STRING |
||
|
modified_by OBJECT
|
||
|
name STRING |
||
|
org OBJECT
|
||
|
role_groups
ARRAY |
||
|
type STRING |
||
|
updated_at
DATE-TIME |
users
The users table contains information about users in the Kustomer app.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
avatar_url STRING |
|||
|
created_at DATE-TIME |
|||
|
created_by OBJECT
|
|||
|
deleted_at STRING |
|||
|
display_name STRING |
|||
|
STRING |
|||
|
email_signature STRING |
|||
|
email_verified_at STRING |
|||
|
first_email_verified_at STRING |
|||
|
id
STRING |
|||
|
links OBJECT
|
|||
|
mobile STRING |
|||
|
modified_at STRING |
|||
|
modified_by OBJECT
|
|||
|
name STRING |
|||
|
org OBJECT
|
|||
|
password OBJECT
|
|||
|
role_groups
ARRAY |
|||
|
roles
ARRAY |
|||
|
type STRING |
|||
|
updated_at
DATE-TIME |
|||
|
user_type STRING |
| Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.