kustomer.md

description
This page describes how to use Census with Kustomer

Kustomer

Getting Started

In this guide, we will show you how to connect Kustomer to Census and create your first sync.

Prerequisites

• Have your Census account ready. If you need one, create a Free Trial Census account now.
• Have your Planhat account ready.
• Have the proper credentials to access to your data source. See our docs for each supported data source for further information:
  • Azure Synapse
  • ​Databricks​
  • ​Elasticsearch​
  • ​Google BigQuery​
  • ​Google Sheets​
  • ​MySQL​
  • ​Postgres​
  • ​Redshift​
  • ​Snowflake​
  • ​SQL Server​

1. Generate a Kustomer API Key

In your Kustomer account:

1. Navigate to Settings > Security > API Key

   [KUSTOMER_DOMAIN].kustomerapp.com/app/settings/api_keys

2. Create an API Key with the following permissions:

   1. org.admin.klass.read
   2. org.user.kobject.read
   3. org.admin.metadata.read
   4. org.admin.search.read
   5. org.user.customer.write
   6. org.user.kobject.write
   7. org.permission.customer
   8. org.permission.company

3. Hold onto this API Key for the next section, you'll need it!

In Kustomer, once a token is created, it will be created with those scopes and it is immutable. If there is a permission change, you will need to create a completely separate API key. Make sure to copy and store it securely once generated.

More on Kustomer's API permission scopes here.

2. Connect Kustomer to Census

• Head back to Census and navigate to Destinations.
• Click the New Destination button.
• Select Kustomer in the dropdown list.
• Paste your Kustomer account's API Key. Save your connection and if everything is set up correctly, you should see a successful connection test verifying the connection.

Supported Objects

Object Name	Supported?	Sync Keys
Customer	✅	External Id, Default Customer Email, Custom Fields
Company	✅	External Id, Custom Fields

Contact us if you want Census to support more objects for Kustomer.

Supported Sync Behaviors

{% hint style="info" %} Learn more about all of our sync behaviors in our Syncs documentation. {% endhint %}

Behaviors	Supported?	Objects
Update or Create	✅	All

Contact us if you want Census to support more Sync behaviors for Kustomer.

Need help connecting to Kustomer?

​Contact us via [email protected] or start a conversation with us via the in-app chat.