Kommo
Create leads and manage your messenger-based sales pipeline in Kommo.
On this page
Connect
Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.
- In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
- For every project in a workspace: Workspace settings, Integrations.
- Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.
Call it from a workflow
Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.
// .workflow.js (native ctx)
export async function run(ctx) {
const res = await ctx.integrations.invoke("kommo", "create_lead", {
"name": "<lead name>",
"pipelineId": "<pipelineId>",
"statusId": "<statusId>"
});
if (!res.success) throw new Error(res.error);
ctx.log.info("Kommo answered", { output: res.output });
}// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";
export default defineWorkflow({
id: "kommo-create-lead",
name: "Kommo: Create New Lead",
description: "Calls Kommo when a row is created.",
trigger: { type: "entity_event", entity: "tickets", event: "created" },
async run(ctx, event) {
const res = await ctx.integrations.call("kommo", {
"action": "create_lead",
"name": "<lead name>",
"pipelineId": "<pipelineId>",
"statusId": "<statusId>"
}) as { success: boolean; error?: string };
if (!res.success) throw new Error(res.error);
},
});curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/kommo/create_lead" \
-H "Authorization: Bearer $APP_KEY" \
-H "content-type: application/json" \
-d '{"props":{"name":"<lead name>","pipelineId":"<pipelineId>","statusId":"<statusId>"}}'Actions
create_leadin catalog
Create New Lead. Creates a new lead.
| Input | Type | Description |
|---|---|---|
namerequired | text | Lead Name |
priceoptional | number | Price |
pipelineIdrequired | id (picked from your account) | Pipeline |
statusIdrequired | id (picked from your account) | Status |
responsible_user_idoptional | id (picked from your account) | Unique identified of a responsible user |
loss_reason_idoptional | id (picked from your account) | Loss Reason |
tags_to_addoptional | array | List of tags to add. |
create_contact
Create New Contact. Add a new contact.
| Input | Type | Description |
|---|---|---|
namerequired | text | Full Name |
first_nameoptional | text | First Name |
last_nameoptional | text | Last Name |
emailoptional | text | |
phoneoptional | text | Phone |
responsible_user_idoptional | id (picked from your account) | Unique identified of a responsible user |
tags_to_addoptional | array | Tags to Add |
custom_api_call
Custom API Call. Make a custom API call to a specific endpoint
| Input | Type | Description |
|---|---|---|
urlrequired | object (depends on other props) | url |
methodrequired | one of "GET" | "POST" | "PATCH" | "PUT" | "DELETE" | "HEAD" | Method |
headersrequired | object | Authorization headers are injected automatically from your connection. |
queryParamsrequired | object | Query Parameters |
body_typeoptional | one of "none" | "json" | "form_data" | "raw" | Body Type |
bodyoptional | object (depends on other props) | Body |
response_is_binaryoptional | boolean | Enable for files like PDFs, images, etc. |
failsafeoptional | boolean | No Error on Failure |
timeoutoptional | number | Timeout (in seconds) |
followRedirectsoptional | boolean | Follow redirects |
find_company
Find Company. Find an existing company.
| Input | Type | Description |
|---|---|---|
queryrequired | text | Search query (Searches through the filled fields of the company). |
find_contact
Find Contact. Finds an existing contact.
| Input | Type | Description |
|---|---|---|
queryrequired | text | Search query (Searches through the filled fields of the contact). |
find_lead
Find Lead. Finds an existing lead.
| Input | Type | Description |
|---|---|---|
queryrequired | text | Search query (Searches through the filled fields of the lead). |
update_contact
Update Contact. Updates an existing contact.
| Input | Type | Description |
|---|---|---|
contactIdoptional | id (picked from your account) | Contact |
nameoptional | text | Full Name |
first_nameoptional | text | First Name |
last_nameoptional | text | Last Name |
emailoptional | text | |
phoneoptional | text | Phone |
responsible_user_idoptional | id (picked from your account) | Unique identified of a responsible user |
tags_to_addoptional | array | List of tag names or IDs to add. |
tags_to_deleteoptional | array | List of tag names or IDs to remove. |
update_lead
Update Lead. Update existing lead info.
| Input | Type | Description |
|---|---|---|
leadIdrequired | id (picked from your account) | Lead |
nameoptional | text | Name |
priceoptional | number | Price |
pipelineIdoptional | id (picked from your account) | Pipeline |
statusIdoptional | id (picked from your account) | Status |
responsible_user_idoptional | id (picked from your account) | Unique identified of a responsible user |
loss_reason_idoptional | id (picked from your account) | Loss Reason |
tags_to_addoptional | array | Tags to Add |
tags_to_deleteoptional | array | Tags to Delete |
Details
- Id
kommo- Category
- CRM and sales
- Tags
- crm, sales, messenger, leads
- Package
@activepieces/piece-kommo@0.1.4- Tier
- Community