Kustomer

This documentation for the Kustomer integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Kustomer, visit our connection instructions.

Version

This integration utilizes the Kustomer API v1.

Base URL

The base URL used for all Kustomer API endpoints:

https://api.kustomerapp.com/v1

---

Authentication & Authorization

The DataGrail Kustomer integration connects using token authentication which requires an API Key.

Sensitive Credentials

Publicly exposing your API credentials can allow unauthorized access to Kustomer API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

Scopes

The Kustomer integration requires specific scopes that must be granted in order to function for a given capability.

Scope	Access	Deletion	System Detection
org.permission.customer	✅	✅
org.permission.conversation	✅
org.permission.draft	✅
org.permission.event	✅
org.permission.message	✅
org.permission.note	✅
org.permission.klass	✅
org.permission.apps			✅

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:

Method	Endpoint	Purpose	Docs
GET	/auth/tokens/current	Retrieve a list of all auth tokens associated with the current authenticated user

---

Limits

Limits in Kustomer are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

• DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
• DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

---

Capabilities

Access

DataGrail's Kustomer integration provides Synchronous Access capabilities for the following supported identifier category: Email.

Data Interactions

For Access requests, DataGrail will take the following actions:

1. Search for Customers by the Data Subject email address.
2. If a match is found, save the extracted customer data in customer_records, and then extract the following objects related to the customer:

Match Found

• conversations
• drafts
• sessions
• events (events by customer for session)
• messages
• notes
• klasses (custom objects)

3. Save all extracted objects in separate collections.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/customers/customer_id/conversations	Retrieves a list of conversations using the unique Customer ID.
GET	/customers/customer_id/drafts	Retrieves all outbound drafts to a customer based on the unique customer ID.
GET	/customers/customer_id/klasses/name	Finds all KObjects (custom objects) linked to a customer based on the name of the Klass.
GET	/customers/customer_id/messages	Retrieves messages for a customer based on the unique customer ID
GET	/customers/customer_id/notes	Retrieves notes for a customer based on the unique customer ID
GET	/customers/customer_id/sessions	Retrieves all sessions for a customer based on the unique customer ID.
GET	/customers/customer_id/sessions/session_id/events	Retrieves all tracking events for a specific customer session based on the unique IDs of the customer and the session
GET	/customers/email=	Retrieves a customer based on their email address
GET	/klasses	Retrieves all Klasses

---

Deletion

DataGrail's Kustomer integration provides Synchronous Deletion capabilities for the following supported identifier category: Email.

Data Interactions

In Deletion mode, DataGrail will take the following actions for Deletion requests:

1. Search for Customers using the Data Subject email address.
2. Delete extracted customer by their ID.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
DEL	/customers/id	Deletes a customer record based on the unique customer ID

System Detection

DataGrail provides continuous system detection, delivering a real-time inventory of your data assets.

Data Interactions

DataGrail's System Detection process runs once daily and performs the following actions:

Fetch all installed apps to detect new systems added.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/apps	Fetch all installed apps

---