> ## Documentation Index
> Fetch the complete documentation index at: https://botpress.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Kommo

> Connect your bot to Kommo CRM using the official integration.

[Open in Hub](https://studio.botpress.cloud/home?exploreHub=1\&hubItemId=intver_01KN89QSX1YDM04NFRHK0WKZMG)
*v0.1.0*

The official Kommo integration allows your bot to create and update leads, manage contacts, and search your CRM data.

## Setup

> [!NOTE]
>
> Before you begin, you need:
>
> * A [published bot](https://botpress.com/docs/get-started/quick-start.md)
> * A Kommo account with **administrator** access
> * A **private integration** in your Kommo account
> * A **long-lived access token** from that private integration

**1. Install the Kommo integration in Botpress**

1. In Botpress Studio, select **Explore Hub** in the upper-right corner.
2. Search for the **Kommo** integration, then select **Install Integration**.

Leave the configuration fields empty for now, you will fill them in after you create the private integration and token in Kommo.

**2. Create a private integration in Kommo**

1. Log in to your Kommo account.
2. Go to **Settings** → **Integrations marketplace**.
3. Select **Create Integration** in the upper-right corner.
4. Enter a name for your integration.
5. Select **all** scopes.
6. Save the integration.

**3. Generate a long-lived access token**

1. Open your integration’s settings in Kommo.
2. Select **Generate long-lived token**.
3. Choose an expiration date.
4. Copy the long-lived token and store it securely.

> [!NOTE]
>
> Treat the token like a password. If it is exposed, revoke it in Kommo and generate a new one.

**4. Configure the integration in Botpress**

In the Kommo integration **Configuration** page in Botpress, enter:

* **Base Domain**: Your Kommo subdomain only (for example `mycompany.kommo.com`)

  Do not include `https://` or trailing slashes.

* **Access Token**: The long-lived token from the previous step.

Select **Save Configuration** and enable the integration.

***

## Cards

{/* vale off */}

Here's a reference for all [Cards](https://botpress.com/docs/studio/concepts/cards/introduction.md) available with the integration:

### Create Contact

Creates a new contact

**input** `object`

**name** `string`

Full contact name

**firstName** `string`

First name

**lastName** `string`

Last name

**responsibleUserId** `number` *required*

User ID to assign this contact to

**createdBy** `number` *required*

User ID who creates this contact

**updatedBy** `number`

User ID who updates this contact

**output** `object`

**contact** `object` *required*

The created contact

**id** `number` *required*

Contact ID

**name** `string` *required*

Contact name

**firstName** `string` *required*

First name

**lastName** `string` *required*

Last name

**responsibleUserId** `number` *required*

User responsible for this contact

**groupId** `number` *required*

Group ID

**updatedBy** `number` *required*

User who last updated this contact

**createdAt** `number` *required*

When created (Unix timestamp)

**updatedAt** `number` *required*

When last updated (Unix timestamp)

**closestTaskAt** `number`

Closest task timestamp

**isDeleted** `boolean` *required*

Whether contact is deleted

**accountId** `number` *required*

Account ID

### Create Lead

Creates a new lead in Kommo CRM

**input** `object`

**name** `string` *required*

Lead name (required)

**price** `number`

Lead value in dollars

**responsibleUserId** `number`

User ID to assign this lead to

**pipelineId** `number`

Pipeline ID (defaults to main pipeline)

**statusId** `number`

Initial status/stage ID

**output** `object`

**lead** `object` *required*

The created lead

**id** `number` *required*

Lead ID

**name** `string` *required*

Lead name

**price** `number`

Lead value in dollars

**responsibleUserId** `number`

User responsible for this lead

**pipelineId** `number`

Which sales pipeline

**statusId** `number`

Which stage in the pipeline

**createdAt** `number` *required*

When created (Unix timestamp)

**updatedAt** `number` *required*

When last updated (Unix timestamp)

### Search Contacts

Search for contacts by name, phone number, or email

**input** `object`

**query** `string` *required*

Search query (name, phone number, or email)

**output** `object`

**contacts** `array` *required*

Array of matching contacts (empty if none found)

**array item properties**

**id** `number` *required*

Contact ID

**name** `string` *required*

Contact name

**firstName** `string` *required*

First name

**lastName** `string` *required*

Last name

**responsibleUserId** `number` *required*

User responsible for this contact

**groupId** `number` *required*

Group ID

**updatedBy** `number` *required*

User who last updated this contact

**createdAt** `number` *required*

When created (Unix timestamp)

**updatedAt** `number` *required*

When last updated (Unix timestamp)

**closestTaskAt** `number`

Closest task timestamp

**isDeleted** `boolean` *required*

Whether contact is deleted

**accountId** `number` *required*

Account ID

### Search Leads

search for leads by name or other fields

**input** `object`

**query** `string` *required*

Search query

**output** `object`

**leads** `array` *required*

Array of matching leads (empty if none found)

**array item properties**

**id** `number` *required*

Lead ID

**name** `string` *required*

Lead name

**price** `number`

Lead value in dollars

**responsibleUserId** `number`

User responsible for this lead

**pipelineId** `number`

Which sales pipeline

**statusId** `number`

Which stage in the pipeline

**createdAt** `number` *required*

When created (Unix timestamp)

**updatedAt** `number` *required*

When last updated (Unix timestamp)

### Update Lead

Updates an existing lead in Kommo

**input** `object`

**leadId** `number` *required*

Lead ID to update

**name** `string`

New name

**price** `number`

New price

**responsibleUserId** `number`

New responsible user

**pipelineId** `number`

New pipeline ID

**statusId** `number`

New status/stage ID

**output** `object`

**lead** `object` *required*

The updated lead

**id** `number` *required*

Lead ID

**name** `string` *required*

Lead name

**price** `number`

Lead value in dollars

**responsibleUserId** `number`

User responsible for this lead

**pipelineId** `number`

Which sales pipeline

**statusId** `number`

Which stage in the pipeline

**createdAt** `number` *required*

When created (Unix timestamp)

**updatedAt** `number` *required*

When last updated (Unix timestamp)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.