Skip to main content
You need a Kustomer API key with org.admin.apps and org.permission.apps roles to register an OAuth app.

​
Register a Kustomer OAuth App

Register a private app with the Kustomer Apps Platform to obtain OAuth credentials.

1

Obtain an Admin API Key

Go to your Kustomer instance at https://<your-org>.kustomerapp.com.

  • Navigate to Settings > Security > API Keys.
  • Click Add API Key.
  • Assign the org.admin.apps and org.permission.apps roles.
  • Copy the API key immediately — it is only shown once.
2

Register the App

Use the API key to register your app via POST request to the Kustomer Apps Platform API.

  • Send a POST request to https://api.kustomerapp.com/v1/apps/available with your app definition JSON.
  • Include a unique app identifier and semantic version in the request body.
  • Set the redirect URI to https://api.stackone.com/connect/oauth2/kustomer/callback.
3

Generate OAuth Credentials

After registering the app, generate the Client ID and Client Secret.

  • Send a POST request to https://api.kustomerapp.com/v1/apps/available/{app}/secret/ to generate credentials.
  • Copy the Client ID and Client Secret — store them securely.

​
Find Your Organization Name

Your Kustomer organization name is needed for the base URL.

1

Locate from your browser URL

After logging in to Kustomer, look at the URL in your browser address bar. It follows the format https://<org-name>.kustomerapp.com.

  • Organization Name is the subdomain before .kustomerapp.com (e.g., mycompany).

​
Install the App

The OAuth app must be installed in the target organization before authorization can begin.

1

Install the App

Install the registered app in the Kustomer organization. Without this step, the OAuth flow will return a 400 ‘Invalid Client’ error.

​
Linking the Account from the Hub

1

Navigate to the Hub

Use one of the three Linking Account Methods to access the Hub.
2

Fill out the fields

Fill out the following fields using details from your provider:
  • Client ID
  • Client Secret
  • Organization Name
  • Scopes (Optional)
3

Connect

  • Click Connect
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup
If the account linking is successful, you will see the newly linked account in your Accounts page.