Skip to main content

How to connect to Kustomer

Learn how to connect Kustomer to Endear using an API key and what data syncs

In order to connect your Kustomer account to Endear, you will need to provide your Kustomer API Key. Endear connects to Kustomer's API (https://api.kustomerapp.com) using this key, so no subdomain or username is required.

What the integration syncs

  • Support tickets — Kustomer conversations (across chat, email, SMS, Instagram and other channels) sync into Endear as tickets, including status, assignments and conversation history. This is enabled by default.

  • Customers — Kustomer customer records (contact information, tags, activity) can sync into Endear's CRM. This is disabled by default, so ask your Endear team to enable customer ingestion if you want this data.

  • Custom fields — Kustomer custom fields can be mapped to Endear customer fields on request.

How to Create Your API Key

  1. Open API Keys settings — In the Kustomer app, click the Settings (gear) icon, expand Security, and select API Keys. This page lists all existing keys for your org and is where admins manage them.

  2. Add a new key — Click Add API Key (labeled New API Key in some versions) in the top right.

  3. Name it and set roles — Give it a descriptive name tied to the integration (for example, "Endear"). Please grant the following scopes: org.permission.brand, org.permission.customer, org.permission.conversation, org.permission.search

  4. Set expiration — Enter a number of days, or choose No Expiration. If you set an expiry, the key stops working on that date and any integration using it breaks until you rotate it. We recommend no expiration since this token will live and be managed by Endear.

  5. Create and store the key — Click Create. Copy the token immediately into a password manager or secrets store — Kustomer will not show it again, and a lost key has to be regenerated.

Connecting Kustomer in Endear

  1. Open your Endear Tickets module:

  2. Follow the prompts to add a new support integration and select Kustomer.

  3. Paste your Kustomer API Key and save.

Once connected, Endear will begin syncing your Kustomer conversations as tickets. Depending on the volume of historical data, the initial sync can take some time to complete.

What's Next

To learn how tickets appear and are used in Endear, see How to sync support tickets into Endear. For a comparison of what each integration syncs, see Overview of Endear Integrations.

Did this answer your question?