Configuring Kommo as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Kommo option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
You’ll need a long-lived API token from your Kommo account. To generate one, go to Settings > Integrations in your Kommo account and create an integration to obtain the token. The following configurations are available:- API Key: The long-lived API token for authenticating with your Kommo account.
-
Subdomain: Your Kommo account subdomain. For example, if your Kommo URL is
mycompany.kommo.com, your subdomain ismycompany. - Start Date: (Optional) The earliest date from which records will be synced for incremental streams.
2. Select streams
Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.Tip: The stream can be found more easily by typing its name.Select the streams and click Next.
3. Configure data streams
Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.- Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
- Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
- Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
- Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
- Incremental: every time the extraction happens, we’ll get only the new data - which is good if, for example, you want to keep every record ever fetched.
- Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.
4. Configure data source
Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:- Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
- Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
5. Check your new source
You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.Streams and Fields
Available streams
The table below lists every stream, its slug (the exact identifier to pass when creating the source via API) and a short description.Fields by stream
Below you’ll find all available data streams from Kommo and their corresponding fields:Leads
Leads
Sales leads (deals) in your Kommo CRM. Supports incremental sync via
updated_at.Contacts
Contacts
Contacts (people) in your Kommo CRM. Supports incremental sync via
updated_at.Companies
Companies
Companies (organizations) in your Kommo CRM. Supports incremental sync via
updated_at.Pipelines
Pipelines
Sales pipelines configuration. Full table sync.
Pipeline Statuses
Pipeline Statuses
Pipeline stages/statuses. Full table sync. Each status belongs to a pipeline.
Tasks
Tasks
Tasks linked to leads, contacts, or companies. Supports incremental sync via
updated_at.Events
Events
Activity events and audit trail. Supports incremental sync via
created_at.Users
Users
Team members and users. Full table sync.