EXPAND YOUR CAPABILITIES WITH API
We try to provide maximum opportunities for Kommo integrations with other services and systems, so that you, our customers and partners, can expand the capabilities of Kommo for yourself, others and our users.
Writing your own widgets and integrations is not as difficult as it might seem at first glance. In order to further facilitate the life of the developer, in addition to instructions, we give examples of the use of methods, their description.
Also you can use the console to work with our API.
What is a widget?
If you just need to exchange data between Kommo and an external system, then you can use the REST API. Through it, you can remotely receive, add, and update data in Kommo.
In case your solution should be available to all Kommo clients or you need to connect JS and interact with the user in the browser, complement the system interfaces, then all these possibilities are in the system of widgets.
A widget is a set of settings, JS and PHP files that can be connected to any Kommo account, through the inclusion of the widget by the client.
The current mechanism of widgets in the future will be considered obsolete. A new format for widgets and integrations will be described in the near future in the documentation. The principle of interaction will not fundamentally change, but new opportunities will emerge.
Examples of using widgets :
- I want to display additional information about the contact (in the contact card) from my internal accounting system;
- I want my company’s employees to send a request to the accounting department to form a payment directly from the lead card;
- I am the developer of a third-party service (telephony, email-server) and I want to give Kommo clients the opportunity to use my service by publishing a public widget and making the integration more transparent and easy.
|A supplement to the system that can be enabled and configured by the user for their account in order to extend the functions of Kommo. It can contain a JS-file, a configuration file, a php-file, images, templates used in the work of the add-on.|
|Kommo is translated into three languages: English / Spanish (amocrm.com) and Russian (amocrm.ru). You can publish widgets in three languages explicitly specifying this in the manifest. Do not forget to also make the translation and take into account the time format. The new widget format will not support multiple localization and you will need to do several widgets if you want to use different localizations.|
|A file that is loaded with the widget, which contains a description and settings for the widget|
|During installation, some widgets require you to enter settings, for example, the name of the account in the external system, the authorization parameters in it, field settings, etc.|
|A company account in Kommo with its own payment details, billing information, personal data and a list of users who are allowed to access this data. Each account has its own subdomain in the system, for example, company.amocrm.com|