Bitrix24
App · 25 actions
Work with your Bitrix24 CRM and tasks: create and update leads, deals, contacts, companies and smart process items, add to-dos and timeline comments, manage tasks, send chat messages, and start workflows when records or tasks are added or changed.
Actions
| Action | What it does |
|---|---|
| Add timeline comment | Add a comment to the timeline of a lead, deal, contact, company or smart process item. |
| Complete task | Mark a task as done. |
| Create company | Add a company to the CRM with its type, email, phone, website and revenue. |
| Create contact | Add a contact to the CRM with their name, email, phone, job title and company. |
| Create deal | Add a deal to a pipeline at a stage, with its amount, contacts, company and close date. |
| Create lead | Add a lead to the Bitrix24 CRM with the person's name, email, phone, company, status and source. |
| Create smart process item | Add an item to one of your smart processes (custom CRM objects), with its stage, responsible person, company and contacts. |
| Create task | Create a task with an assignee, deadline and priority, in a project if you like, linked to CRM records if you like. |
| Create to-do | Add a to-do with a deadline to a lead, deal, contact, company or smart process item, shown in its timeline, with an optional reminder. |
| Delete CRM record | Delete a lead, deal, contact, company or smart process item for good. |
| Delete task | Delete a task for good. |
| Get deal | Get one deal with its pipeline, stage, amount, contact and company. |
| Get lead | Get one lead with all its fields, emails and phone numbers. |
| Get task | Get one task with its status, assignee, deadline and dates. |
| List contacts | Find contacts, newest first, by exact email or phone, last name, company, responsible person or creation date. |
| List deals | List deals, newest first, filtered by pipeline, stage, responsible person, company, contact, title or creation date. |
| List leads | List leads, newest first, filtered by status, responsible person, title, email or creation date. |
| List smart process items | List a smart process's items, newest first, filtered by stage, responsible person, title or creation date. |
| List tasks | List tasks, newest first, filtered by assignee, status, project, title or creation date. |
| List users | List the people in your Bitrix24, with their emails, job titles and departments, optionally searching by name. |
| Send chat message | Send a message in Bitrix24 chat to a person or a group chat, as the person who made the webhook. |
| Update contact | Change a contact's details, or add an email or phone number. |
| Update deal | Change a deal's details, such as moving it to another stage or changing its amount. |
| Update lead | Change a lead's details, such as its status or responsible person. |
| Update task | Change a task's title, description, assignee, deadline, priority or project. |
Add timeline comment
Add a comment to the timeline of a lead, deal, contact, company or smart process item.
Inputs
- Record type
record_typetextRequired - Lead, Deal, Contact, Company or one of your smart processes.
- Record ID
record_idtextRequired - The record's id, from a list step or an earlier step.
- Comment
commenttextRequired - The comment's text.
Outputs
comment_idnumber- The comment's id
record_idnumber- The record's id
record_typenumber- The record type's id (1 lead, 2 deal, 3 contact, 4 company)
Example output
{
"comment_id": 999,
"record_id": 410,
"record_type": 2
}Complete task
Mark a task as done. If the task needs its creator's review, it waits for review instead.
Inputs
- Task ID
task_idtextRequired - The task's id, from 'List tasks' or an earlier step.
Outputs
taskobject- The task
task_idnumber- The task's id
Example output
{
"task": {
"changedDate": "2026-11-02T10:06:08+02:00",
"closedDate": "2026-11-03T12:11:30+02:00",
"createdBy": "1",
"createdDate": "2026-11-02T10:06:08+02:00",
"deadline": "2026-11-09T18:00:00+02:00",
"description": "Confirm the renewal terms.",
"groupId": "0",
"id": "3711",
"priority": "1",
"responsibleId": "1",
"status": "5",
"title": "Call Acme back"
},
"task_id": 3711
}Create company
Add a company to the CRM with its type, email, phone, website and revenue. Returns the new company.
Inputs
- Name
titletextRequired - The company's name.
- Type
company_typetext - What the company is to you, such as Client or Supplier.
- Email
emailtext - The company's work email.
- Phone
phonetext - The company's work phone, with the country code.
- Website
websitetext - The company's website.
- Responsible person
assigned_by_idtext - The Bitrix24 user responsible for it.
- Annual revenue
revenuenumber - The company's yearly revenue.At least 0.
- Currency
currency_idtext - The currency of the amount, such as USD.
- Comment
commentstext - Notes kept on the record.
- More fields
more_fieldsobject - Any other fields, by their Bitrix24 code, such as {"UF_CRM_1721244482250": "Gold", "UTM_SOURCE": "google"}. Custom fields' codes are shown in Bitrix24 under the field's settings.
Outputs
companyobject- The company
company_idnumber- The new company's id
Example output
{
"company": {
"ASSIGNED_BY_ID": "1",
"COMMENTS": "Key account.",
"COMPANY_TYPE": "CUSTOMER",
"CURRENCY_ID": "USD",
"DATE_CREATE": "2026-11-02T10:06:08+02:00",
"DATE_MODIFY": "2026-11-02T10:06:08+02:00",
"EMAIL": [
{
"ID": "2001",
"TYPE_ID": "EMAIL",
"VALUE": "hello@acme.example",
"VALUE_TYPE": "WORK"
}
],
"ID": "9",
"PHONE": [
{
"ID": "2002",
"TYPE_ID": "PHONE",
"VALUE": "+15555550100",
"VALUE_TYPE": "WORK"
}
],
"REVENUE": "3000000.00",
"TITLE": "Acme Inc",
"WEB": [
{
"ID": "2003",
"TYPE_ID": "WEB",
"VALUE": "acme.example",
"VALUE_TYPE": "WORK"
}
]
},
"company_id": 9
}Create contact
Add a contact to the CRM with their name, email, phone, job title and company. Returns the new contact.
Inputs
- First name
first_nametext - Their first name. A first or last name is needed.
- Last name
last_nametext - Their last name. A first or last name is needed.
- Email
emailtext - Their work email.
- Phone
phonetext - Their work phone, with the country code.
- Position
positiontext - Their job title.
- Company
company_idtext - The company it belongs to.
- Source
source_idtext - Where it came from, such as Website.
- Responsible person
assigned_by_idtext - The Bitrix24 user responsible for it.
- Birthday
birthdatedate - Their date of birth.
- Comment
commentstext - Notes kept on the record.
- More fields
more_fieldsobject - Any other fields, by their Bitrix24 code, such as {"UF_CRM_1721244482250": "Gold", "UTM_SOURCE": "google"}. Custom fields' codes are shown in Bitrix24 under the field's settings.
Outputs
contactobject- The contact
contact_idnumber- The new contact's id
Example output
{
"contact": {
"ASSIGNED_BY_ID": "1",
"COMMENTS": "Met at the expo.",
"COMPANY_ID": "9",
"DATE_CREATE": "2026-11-02T10:06:08+02:00",
"DATE_MODIFY": "2026-11-02T10:06:08+02:00",
"EMAIL": [
{
"ID": "2001",
"TYPE_ID": "EMAIL",
"VALUE": "jo@example.com",
"VALUE_TYPE": "WORK"
}
],
"ID": "84",
"LAST_NAME": "Bloggs",
"NAME": "Jo",
"PHONE": [
{
"ID": "2002",
"TYPE_ID": "PHONE",
"VALUE": "+15555550100",
"VALUE_TYPE": "WORK"
}
],
"POST": "Head of Operations",
"SOURCE_ID": "WEB"
},
"contact_id": 84
}Create deal
Add a deal to a pipeline at a stage, with its amount, contacts, company and close date. Returns the new deal.
Inputs
- Title
titletextRequired - The deal's name.
- Pipeline
category_idtext - The deal pipeline. Leave empty for the main one, or let the stage decide.
- Stage
stage_idtext - The deal's stage. Each stage belongs to one pipeline.
- Amount
opportunitynumber - The deal's value.At least 0.
- Currency
currency_idtext - The currency of the amount, such as USD.
- Contacts
contact_idslist - The contacts it involves.
- Company
company_idtext - The company it belongs to.
- Responsible person
assigned_by_idtext - The Bitrix24 user responsible for it.
- Start date
begin_datedate - When the deal starts.
- Expected close date
close_datedate - When the deal is expected to close.
- Source
source_idtext - Where it came from, such as Website.
- Comment
commentstext - Notes kept on the record.
- More fields
more_fieldsobject - Any other fields, by their Bitrix24 code, such as {"UF_CRM_1721244482250": "Gold", "UTM_SOURCE": "google"}. Custom fields' codes are shown in Bitrix24 under the field's settings.
Outputs
dealobject- The deal
deal_idnumber- The new deal's id
Example output
{
"deal": {
"ASSIGNED_BY_ID": "1",
"BEGINDATE": "2026-11-02T02:00:00+02:00",
"CATEGORY_ID": "0",
"CLOSED": "N",
"CLOSEDATE": "2026-11-30T02:00:00+02:00",
"COMMENTS": "Renewal for next year.",
"COMPANY_ID": "9",
"CONTACT_ID": "84",
"CURRENCY_ID": "EUR",
"DATE_CREATE": "2026-11-02T14:29:00+02:00",
"DATE_MODIFY": "2026-11-02T14:29:00+02:00",
"ID": "410",
"MOVED_TIME": "2026-11-02T14:29:00+02:00",
"OPPORTUNITY": "1000000.00",
"SOURCE_ID": "CALLBACK",
"STAGE_ID": "PREPARATION",
"STAGE_SEMANTIC_ID": "P",
"TITLE": "Acme renewal"
},
"deal_id": 410
}Create lead
Add a lead to the Bitrix24 CRM with the person's name, email, phone, company, status and source. Returns the new lead.
Inputs
- Title
titletextRequired - The lead's name in the CRM.
- First name
first_nametext - The person's first name.
- Last name
last_nametext - The person's last name.
- Email
emailtext - The person's work email.
- Phone
phonetext - The person's work phone, with the country code.
- Company name
company_titletext - The name of their company, as text.
- Status
status_idtext - The lead's status, such as New.
- Source
source_idtext - Where it came from, such as Website.
- Responsible person
assigned_by_idtext - The Bitrix24 user responsible for it.
- Amount
opportunitynumber - The lead's expected value.At least 0.
- Currency
currency_idtext - The currency of the amount, such as USD.
- Comment
commentstext - Notes kept on the record.
- More fields
more_fieldsobject - Any other fields, by their Bitrix24 code, such as {"UF_CRM_1721244482250": "Gold", "UTM_SOURCE": "google"}. Custom fields' codes are shown in Bitrix24 under the field's settings.
Outputs
leadobject- The lead
lead_idnumber- The new lead's id
Example output
{
"lead": {
"ASSIGNED_BY_ID": "1",
"COMMENTS": "Asked for a demo.",
"COMPANY_TITLE": "Acme Inc",
"CURRENCY_ID": "USD",
"DATE_CREATE": "2026-11-02T10:06:08+02:00",
"DATE_MODIFY": "2026-11-02T10:06:08+02:00",
"EMAIL": [
{
"ID": "2001",
"TYPE_ID": "EMAIL",
"VALUE": "jo@example.com",
"VALUE_TYPE": "WORK"
}
],
"ID": "3465",
"LAST_NAME": "Bloggs",
"NAME": "Jo",
"OPPORTUNITY": "12500.00",
"PHONE": [
{
"ID": "2002",
"TYPE_ID": "PHONE",
"VALUE": "+15555550100",
"VALUE_TYPE": "WORK"
}
],
"SOURCE_ID": "WEB",
"STATUS_ID": "NEW",
"TITLE": "Website enquiry"
},
"lead_id": 3465
}Create smart process item
Add an item to one of your smart processes (custom CRM objects), with its stage, responsible person, company and contacts. Returns the new item.
Inputs
- Smart process
smart_processtextRequired - The smart process (custom CRM object), picked by name or given by its type id.
- Title
titletextRequired - The item's name.
- Pipeline ID
category_idtext - The id of the smart process's pipeline, if it has more than one.
- Stage
stage_idtext - The stage's code, such as DT1046_9:NEW, from the item list. Leave empty for the first stage.
- Responsible person
assigned_by_idtext - The Bitrix24 user responsible for it.
- Company
company_idtext - The company it belongs to.
- Contacts
contact_idslist - The contacts it involves.
- Amount
opportunitynumber - The item's value.At least 0.
- Currency
currency_idtext - The currency of the amount, such as USD.
- Close date
close_datedate - When the item is expected to close.
- More fields
more_fieldsobject - Any other fields, by the codes smart processes use, such as {"ufCrm5_1721244482250": "Gold"}.
Outputs
itemobject- The item
item_idnumber- The new item's id
Example output
{
"item": {
"assignedById": 6,
"categoryId": 9,
"companyId": 5,
"contactIds": [
4
],
"createdTime": "2026-11-02T14:00:14+02:00",
"currencyId": "EUR",
"id": 342,
"opportunity": 999.99,
"stageId": "DT1046_9:NEW",
"title": "Supplier onboarding",
"updatedTime": "2026-11-02T14:00:14+02:00"
},
"item_id": 342
}Create task
Create a task with an assignee, deadline and priority, in a project if you like, linked to CRM records if you like. Returns the new task.
Inputs
- Title
titletextRequired - What the task is.
- Description
descriptiontext - What needs doing.
- Assignee
responsible_idtext - Who does it. Leave empty to assign it to the person who made the webhook.
- Deadline
deadlinedate and time - When it is due.
- Priority
prioritytext - How important the task is. Bitrix24 defaults to Medium.One of:
0(Low),1(Medium),2(High). - Project ID
group_idtext - The id of the workgroup or project the task belongs to, from its address in Bitrix24.
- Participants
accomplice_idslist - People who help with the task.
- Observers
auditor_idslist - People who follow the task.
- CRM records
crm_linkstext - CRM records to link, separated by commas: D_12 for deal 12, L_5 for a lead, C_7 for a contact, CO_3 for a company.
Outputs
taskobject- The task
task_idnumber- The task's id
Example output
{
"task": {
"changedDate": "2026-11-02T10:06:08+02:00",
"closedDate": "",
"createdBy": "1",
"createdDate": "2026-11-02T10:06:08+02:00",
"deadline": "2026-11-09T18:00:00+02:00",
"description": "Confirm the renewal terms.",
"groupId": "0",
"id": "3711",
"priority": "1",
"responsibleId": "1",
"status": "2",
"title": "Call Acme back"
},
"task_id": 3711
}Create to-do
Add a to-do with a deadline to a lead, deal, contact, company or smart process item, shown in its timeline, with an optional reminder.
Inputs
- Record type
record_typetextRequired - Lead, Deal, Contact, Company or one of your smart processes.
- Record ID
record_idtextRequired - The record's id, from a list step or an earlier step.
- Deadline
deadlinedate and timeRequired - When it is due.
- Title
titletext - What the to-do is.
- Description
descriptiontext - More detail.
- Responsible person
responsible_idtext - The Bitrix24 user responsible for it.
- Remind minutes before
remind_minutes_beforenumber - Send a reminder this many minutes before the deadline.At least 0.
Outputs
activity_idnumber- The to-do's activity id
deadlinetext- When it is due
record_idnumber- The record's id
record_typenumber- The record type's id (1 lead, 2 deal, 3 contact, 4 company)
Example output
{
"activity_id": 999,
"deadline": "2026-11-09T15:00:00+00:00",
"record_id": 410,
"record_type": 2
}Delete CRM record
Delete a lead, deal, contact, company or smart process item for good.
Inputs
- Record type
record_typetextRequired - Lead, Deal, Contact, Company or one of your smart processes.
- Record ID
record_idtextRequired - The record's id, from a list step or an earlier step.
Outputs
deletedtrue/false- Always true once deleted
record_idnumber- The record's id
record_typenumber- The record type's id (1 lead, 2 deal, 3 contact, 4 company)
Example output
{
"deleted": true,
"record_id": 410,
"record_type": 2
}Delete task
Delete a task for good.
Inputs
- Task ID
task_idtextRequired - The task's id, from 'List tasks' or an earlier step.
Outputs
deletedtrue/false- Always true once deleted
task_idnumber- The deleted task's id
Example output
{
"deleted": true,
"task_id": 3711
}Get deal
Get one deal with its pipeline, stage, amount, contact and company.
Inputs
- Deal ID
deal_idtextRequired - The deal's id, from 'List deals' or an earlier step.
Outputs
dealobject- The deal
Example output
{
"deal": {
"ASSIGNED_BY_ID": "1",
"BEGINDATE": "2026-11-02T02:00:00+02:00",
"CATEGORY_ID": "0",
"CLOSED": "N",
"CLOSEDATE": "2026-11-30T02:00:00+02:00",
"COMMENTS": "Renewal for next year.",
"COMPANY_ID": "9",
"CONTACT_ID": "84",
"CURRENCY_ID": "EUR",
"DATE_CREATE": "2026-11-02T14:29:00+02:00",
"DATE_MODIFY": "2026-11-02T14:29:00+02:00",
"ID": "410",
"MOVED_TIME": "2026-11-02T14:29:00+02:00",
"OPPORTUNITY": "1000000.00",
"SOURCE_ID": "CALLBACK",
"STAGE_ID": "PREPARATION",
"STAGE_SEMANTIC_ID": "P",
"TITLE": "Acme renewal"
}
}Get lead
Get one lead with all its fields, emails and phone numbers.
Inputs
- Lead ID
lead_idtextRequired - The lead's id, from 'List leads' or an earlier step.
Outputs
leadobject- The lead
Example output
{
"lead": {
"ASSIGNED_BY_ID": "1",
"COMMENTS": "Asked for a demo.",
"COMPANY_TITLE": "Acme Inc",
"CURRENCY_ID": "USD",
"DATE_CREATE": "2026-11-02T10:06:08+02:00",
"DATE_MODIFY": "2026-11-02T10:06:08+02:00",
"EMAIL": [
{
"ID": "2001",
"TYPE_ID": "EMAIL",
"VALUE": "jo@example.com",
"VALUE_TYPE": "WORK"
}
],
"ID": "3465",
"LAST_NAME": "Bloggs",
"NAME": "Jo",
"OPPORTUNITY": "12500.00",
"PHONE": [
{
"ID": "2002",
"TYPE_ID": "PHONE",
"VALUE": "+15555550100",
"VALUE_TYPE": "WORK"
}
],
"SOURCE_ID": "WEB",
"STATUS_ID": "NEW",
"TITLE": "Website enquiry"
}
}Get task
Get one task with its status, assignee, deadline and dates.
Inputs
- Task ID
task_idtextRequired - The task's id, from 'List tasks' or an earlier step.
Outputs
taskobject- The task
Example output
{
"task": {
"changedDate": "2026-11-02T10:06:08+02:00",
"closedDate": "",
"createdBy": "1",
"createdDate": "2026-11-02T10:06:08+02:00",
"deadline": "2026-11-09T18:00:00+02:00",
"description": "Confirm the renewal terms.",
"groupId": "0",
"id": "3711",
"priority": "1",
"responsibleId": "1",
"status": "2",
"title": "Call Acme back"
}
}List contacts
Find contacts, newest first, by exact email or phone, last name, company, responsible person or creation date. Gets one page of 50; to see more, run it again with the next page it gives.
Inputs
- Email
emailtext - Only contacts with exactly this email.
- Phone
phonetext - Only contacts with exactly this phone number.
- Last name contains
searchtext - Only contacts whose last name contains this.
- Company
company_idtext - The company it belongs to.
- Responsible person
assigned_by_idtext - The Bitrix24 user responsible for it.
- Created on or after
created_afterdate - Only those created on or after this date.
- Start at
startnumber - Lists come 50 at a time. Leave empty for the first page, or give the next_start from the page before.At least 0.
Outputs
contactslist- The contacts
countnumber- How many are on this page
has_moretrue/false- Whether there is another page
next_startnumber- The Start at value for the next page; 0 when this is the last
totalnumber- How many match, on every page
Example output
{
"contacts": [
{
"ASSIGNED_BY_ID": "1",
"COMMENTS": "Met at the expo.",
"COMPANY_ID": "9",
"DATE_CREATE": "2026-11-02T10:06:08+02:00",
"DATE_MODIFY": "2026-11-02T10:06:08+02:00",
"EMAIL": [
{
"ID": "2001",
"TYPE_ID": "EMAIL",
"VALUE": "jo@example.com",
"VALUE_TYPE": "WORK"
}
],
"ID": "84",
"LAST_NAME": "Bloggs",
"NAME": "Jo",
"PHONE": [
{
"ID": "2002",
"TYPE_ID": "PHONE",
"VALUE": "+15555550100",
"VALUE_TYPE": "WORK"
}
],
"POST": "Head of Operations",
"SOURCE_ID": "WEB"
}
],
"count": 1,
"has_more": false,
"next_start": 0,
"total": 1
}List deals
List deals, newest first, filtered by pipeline, stage, responsible person, company, contact, title or creation date. Gets one page of 50; to see more, run it again with the next page it gives.
Inputs
- Pipeline
category_idtext - The deal pipeline. Leave empty for the main one, or let the stage decide.
- Stage
stage_idtext - The deal's stage. Each stage belongs to one pipeline.
- Responsible person
assigned_by_idtext - The Bitrix24 user responsible for it.
- Company
company_idtext - The company it belongs to.
- Contact
contact_idtext - Only deals with this contact.
- Title contains
searchtext - Only those whose title contains this.
- Created on or after
created_afterdate - Only those created on or after this date.
- Start at
startnumber - Lists come 50 at a time. Leave empty for the first page, or give the next_start from the page before.At least 0.
Outputs
countnumber- How many are on this page
dealslist- The deals
has_moretrue/false- Whether there is another page
next_startnumber- The Start at value for the next page; 0 when this is the last
totalnumber- How many match, on every page
Example output
{
"count": 1,
"deals": [
{
"ASSIGNED_BY_ID": "1",
"BEGINDATE": "2026-11-02T02:00:00+02:00",
"CATEGORY_ID": "0",
"CLOSED": "N",
"CLOSEDATE": "2026-11-30T02:00:00+02:00",
"COMMENTS": "Renewal for next year.",
"COMPANY_ID": "9",
"CONTACT_ID": "84",
"CURRENCY_ID": "EUR",
"DATE_CREATE": "2026-11-02T14:29:00+02:00",
"DATE_MODIFY": "2026-11-02T14:29:00+02:00",
"ID": "410",
"MOVED_TIME": "2026-11-02T14:29:00+02:00",
"OPPORTUNITY": "1000000.00",
"SOURCE_ID": "CALLBACK",
"STAGE_ID": "PREPARATION",
"STAGE_SEMANTIC_ID": "P",
"TITLE": "Acme renewal"
}
],
"has_more": false,
"next_start": 0,
"total": 1
}List leads
List leads, newest first, filtered by status, responsible person, title, email or creation date. Gets one page of 50; to see more, run it again with the next page it gives.
Inputs
- Status
status_idtext - The lead's status, such as New.
- Responsible person
assigned_by_idtext - The Bitrix24 user responsible for it.
- Title contains
searchtext - Only those whose title contains this.
- Email
emailtext - Only leads with exactly this email.
- Created on or after
created_afterdate - Only those created on or after this date.
- Start at
startnumber - Lists come 50 at a time. Leave empty for the first page, or give the next_start from the page before.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether there is another page
leadslist- The leads
next_startnumber- The Start at value for the next page; 0 when this is the last
totalnumber- How many match, on every page
Example output
{
"count": 1,
"has_more": false,
"leads": [
{
"ASSIGNED_BY_ID": "1",
"COMMENTS": "Asked for a demo.",
"COMPANY_TITLE": "Acme Inc",
"CURRENCY_ID": "USD",
"DATE_CREATE": "2026-11-02T10:06:08+02:00",
"DATE_MODIFY": "2026-11-02T10:06:08+02:00",
"EMAIL": [
{
"ID": "2001",
"TYPE_ID": "EMAIL",
"VALUE": "jo@example.com",
"VALUE_TYPE": "WORK"
}
],
"ID": "3465",
"LAST_NAME": "Bloggs",
"NAME": "Jo",
"OPPORTUNITY": "12500.00",
"PHONE": [
{
"ID": "2002",
"TYPE_ID": "PHONE",
"VALUE": "+15555550100",
"VALUE_TYPE": "WORK"
}
],
"SOURCE_ID": "WEB",
"STATUS_ID": "NEW",
"TITLE": "Website enquiry"
}
],
"next_start": 0,
"total": 1
}List smart process items
List a smart process's items, newest first, filtered by stage, responsible person, title or creation date. Gets one page of 50; to see more, run it again with the next page it gives.
Inputs
- Smart process
smart_processtextRequired - The smart process (custom CRM object), picked by name or given by its type id.
- Stage
stage_idtext - Only items at this stage, by its code.
- Responsible person
assigned_by_idtext - The Bitrix24 user responsible for it.
- Title contains
searchtext - Only those whose title contains this.
- Created on or after
created_afterdate - Only those created on or after this date.
- Start at
startnumber - Lists come 50 at a time. Leave empty for the first page, or give the next_start from the page before.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether there is another page
itemslist- The items
next_startnumber- The Start at value for the next page; 0 when this is the last
totalnumber- How many match, on every page
Example output
{
"count": 1,
"has_more": false,
"items": [
{
"assignedById": 6,
"categoryId": 9,
"companyId": 5,
"contactIds": [
4
],
"createdTime": "2026-11-02T14:00:14+02:00",
"currencyId": "EUR",
"id": 342,
"opportunity": 999.99,
"stageId": "DT1046_9:NEW",
"title": "Supplier onboarding",
"updatedTime": "2026-11-02T14:00:14+02:00"
}
],
"next_start": 0,
"total": 1
}List tasks
List tasks, newest first, filtered by assignee, status, project, title or creation date. Gets one page of 50; to see more, run it again with the next page it gives.
Inputs
- Assignee
responsible_idtext - Only tasks assigned to this person.
- Status
statustext - Only tasks with this status.One of:
2(Waiting to start),3(In progress),4(Waiting for review),5(Completed),6(Deferred). - Project ID
group_idtext - Only tasks in this workgroup or project.
- Title contains
searchtext - Only those whose title contains this.
- Created on or after
created_afterdate - Only those created on or after this date.
- Start at
startnumber - Lists come 50 at a time. Leave empty for the first page, or give the next_start from the page before.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether there is another page
next_startnumber- The Start at value for the next page; 0 when this is the last
taskslist- The tasks
totalnumber- How many match, on every page
Example output
{
"count": 1,
"has_more": false,
"next_start": 0,
"tasks": [
{
"changedDate": "2026-11-02T10:06:08+02:00",
"closedDate": "",
"createdBy": "1",
"createdDate": "2026-11-02T10:06:08+02:00",
"deadline": "2026-11-09T18:00:00+02:00",
"description": "Confirm the renewal terms.",
"groupId": "0",
"id": "3711",
"priority": "1",
"responsibleId": "1",
"status": "2",
"title": "Call Acme back"
}
],
"total": 1
}List users
List the people in your Bitrix24, with their emails, job titles and departments, optionally searching by name. Gets one page of 50; to see more, run it again with the next page it gives.
Inputs
- Search
searchtext - A name, email or other detail to search for.
- Include people who have left
include_inactivetrue/false - Also list users who have been dismissed.
- Start at
startnumber - Lists come 50 at a time. Leave empty for the first page, or give the next_start from the page before.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether there is another page
next_startnumber- The Start at value for the next page; 0 when this is the last
totalnumber- How many match, on every page
userslist- The users
Example output
{
"count": 1,
"has_more": false,
"next_start": 0,
"total": 1,
"users": [
{
"ACTIVE": true,
"EMAIL": "weber@example.com",
"ID": "1",
"LAST_NAME": "Weber",
"NAME": "Klaus",
"UF_DEPARTMENT": [
1
],
"WORK_POSITION": "Sales Manager"
}
]
}Send chat message
Send a message in Bitrix24 chat to a person or a group chat, as the person who made the webhook. Supports Bitrix24's formatting, such as [b]bold[/b].
Inputs
- Send to
dialog_idtextRequired - A person, or a group chat (chat followed by its id, such as chat345).
- Message
messagetextRequired - What to say.
Outputs
dialog_idtext- Where it was sent
message_idnumber- The message's id
Example output
{
"dialog_id": "chat345",
"message_id": 34239
}Update contact
Change a contact's details, or add an email or phone number. Only the fields you fill in change.
Inputs
- Contact ID
contact_idtextRequired - The contact's id, from 'List contacts' or an earlier step.
- First name
first_nametext - A new first name. Leave empty to keep it.
- Last name
last_nametext - A new last name. Leave empty to keep it.
- Add email
add_emailtext - An email to add alongside the ones they have.
- Add phone
add_phonetext - A phone number to add alongside the ones they have.
- Position
positiontext - Their job title.
- Company
company_idtext - The company it belongs to.
- Responsible person
assigned_by_idtext - The Bitrix24 user responsible for it.
- Comment
commentstext - Notes kept on the record.
- More fields
more_fieldsobject - Any other fields, by their Bitrix24 code, such as {"UF_CRM_1721244482250": "Gold", "UTM_SOURCE": "google"}. Custom fields' codes are shown in Bitrix24 under the field's settings.
Outputs
contact_idnumber- The contact's id
updatedtrue/false- Always true once saved
Example output
{
"contact_id": 84,
"updated": true
}Update deal
Change a deal's details, such as moving it to another stage or changing its amount. Only the fields you fill in change.
Inputs
- Deal ID
deal_idtextRequired - The deal's id, from 'List deals' or an earlier step.
- Title
titletext - A new title. Leave empty to keep it.
- Stage
stage_idtext - Move the deal to this stage of its own pipeline.
- Amount
opportunitynumber - The deal's value.At least 0.
- Currency
currency_idtext - The currency of the amount, such as USD.
- Contacts
contact_idslist - The contacts it involves. Replaces the ones it has.
- Company
company_idtext - The company it belongs to.
- Responsible person
assigned_by_idtext - The Bitrix24 user responsible for it.
- Expected close date
close_datedate - When the deal is expected to close.
- Comment
commentstext - Notes kept on the record.
- More fields
more_fieldsobject - Any other fields, by their Bitrix24 code, such as {"UF_CRM_1721244482250": "Gold", "UTM_SOURCE": "google"}. Custom fields' codes are shown in Bitrix24 under the field's settings.
Outputs
deal_idnumber- The deal's id
updatedtrue/false- Always true once saved
Example output
{
"deal_id": 410,
"updated": true
}Update lead
Change a lead's details, such as its status or responsible person. Only the fields you fill in change.
Inputs
- Lead ID
lead_idtextRequired - The lead's id, from 'List leads' or an earlier step.
- Title
titletext - A new title. Leave empty to keep it.
- First name
first_nametext - The person's first name.
- Last name
last_nametext - The person's last name.
- Add email
add_emailtext - An email to add alongside the ones it has.
- Add phone
add_phonetext - A phone number to add alongside the ones it has.
- Status
status_idtext - The lead's status, such as New.
- Source
source_idtext - Where it came from, such as Website.
- Responsible person
assigned_by_idtext - The Bitrix24 user responsible for it.
- Amount
opportunitynumber - The lead's expected value.At least 0.
- Currency
currency_idtext - The currency of the amount, such as USD.
- Comment
commentstext - Notes kept on the record.
- More fields
more_fieldsobject - Any other fields, by their Bitrix24 code, such as {"UF_CRM_1721244482250": "Gold", "UTM_SOURCE": "google"}. Custom fields' codes are shown in Bitrix24 under the field's settings.
Outputs
lead_idnumber- The lead's id
updatedtrue/false- Always true once saved
Example output
{
"lead_id": 3465,
"updated": true
}Update task
Change a task's title, description, assignee, deadline, priority or project. Only the fields you fill in change.
Inputs
- Task ID
task_idtextRequired - The task's id, from 'List tasks' or an earlier step.
- Title
titletext - A new title. Leave empty to keep it.
- Description
descriptiontext - What needs doing.
- Assignee
responsible_idtext - Who does it. Leave empty to assign it to the person who made the webhook.
- Deadline
deadlinedate and time - When it is due.
- Priority
prioritytext - How important the task is. Bitrix24 defaults to Medium.One of:
0(Low),1(Medium),2(High). - Project ID
group_idtext - The id of the workgroup or project the task belongs to, from its address in Bitrix24.
Outputs
taskobject- The task
task_idnumber- The task's id
Example output
{
"task": {
"changedDate": "2026-11-02T10:06:08+02:00",
"closedDate": "",
"createdBy": "1",
"createdDate": "2026-11-02T10:06:08+02:00",
"deadline": "2026-11-09T18:00:00+02:00",
"description": "Confirm the renewal terms.",
"groupId": "0",
"id": "3711",
"priority": "1",
"responsibleId": "1",
"status": "2",
"title": "Call Acme back"
},
"task_id": 3711
}