Private integrations are used to make an improvement for only one account or to add a feature that only one company/account needs (for example, a form for a website, integration with the client's unique software, etc.).

☝️

To create an integration, you need to have account administrator rights

Integration will be assigned to this account. This means that any of the administrators of this account will be able to manage the integration and will have access to its shared keys.

The client must understand that integrations have access to account data and to what extent.

Any integration must be registered in an account in order to receive keys for authorization, as there can be no anonymous API calls.

Kommo account

To develop a private integration it will be enough to register an account on our website Kommo.com. You can use a trial account or your own business account.

Now, when you have an account, let’s look at how an integration can affect it!

Instruments

Private integrations can work with the following instruments:

Instruments	Description
CRM API	The ability to manipulate and generate data in Kommo including accounts, users, leads, contacts, tasks, etc.
JS SDK	Set of functions and objects that facilitate accessing the environment (information about the widget, the authorized user, etc.)
Salesbot	A tool for creating custom scenarios to automate operations with a user via messengers
Digital pipeline	A powerful automation tool that allows you to set up reactions to different events, such as incoming emails, calls or messages, lead stage changes or website visits
Chat API	The ability to create integration with different messengers and enable Kommo users to send and receive messages through it
VoIP API	Set of API and JS methods that are useful to connect telephony services with Kommo

Create a private integration

This integration type can be developed under any kind of account. Feel free to use your business account or a technical account for development (or even a trial one).

👍
Private integrations don’t have to pass moderation!

To create an integration, follow these steps:

Log in as an account administrator.
Go to Settings → Integrations, click the Create integration button and submit the simple form.

If you use a technical account, you should choose Private in order to create a private integration.

Once you've clicked the Create Integration button, you see a form, containing the integration properties.

🚧
If you are going to use a long-lived token, don't type anything in Redirect URL field.

You can create a private integration with one click — You can create a private integration with just one click

Integration properties

Property	Required?	Description
Integration name	✅	The name of the integration (3-255 characters) is displayed in the marketplace and a modal window for granting access. If you just click "Save", your integration name will be Integration name.
Description	✅	Integration description (5 - 65,000 characters) is displayed in the modal integration window in the user account. It is allowed to use HTML layout. If you just click "Save", your integration description will be Description.
Allow access	✅	Grant access is the minimum set of necessary permissions for integration to work. You can read more about permissions in the scopes.If you just click "Save", all the scopes will be checked.
Integration icon	❌	Integration icon (400×272) (jpeg/jpg/png/gif) is displayed in the list of integrations and in the window for getting access from the user.
Redirect URL	❌	The redirect URL is a link to your site that will handle the work with keys. It is important that the domain must be protected by an SSL certificate if you plan to use integration in more than one account. We also check the availability of the domain every once in a while as a prerequisite for the integration to work.
Access revoked notification web hook	❌	Link for a hook about disabling integration. A GET request will be sent to this address when the user disables integration. The request will contain two parameters: account_id and client_id.
Duplicate control	❌	You need to check this box if your integration supports Duplicate control.
Multiple sources	❌	You need to check this box if your integration manages the sources itself via the Sources API. If the checkbox is set, Kommo will not create sources by default; the integration itself will have to create all the sources it needs.

As you noticed, you can upload a widget to the integration. An integration without a widget can be used just to get the keys needed for accessing the API, but the widget is the part that holds the programming details.

Now save the integration. Kommo will generate and show the necessary keys in the Keys and scopes tab. You can use the long-lived token or/and authorization code in the authorization process, Secret key and Integration ID will be used independently of the account in which it will be installed. If you upload a widget, a Widget code will be generated as well.