![\"Bitrix24\"](\"https://raw.githubusercontent.com/gustavojosemelo/n8n-nodes-bitrix24/main/nodes/Bitrix24/bitrix24.svg\")
\n\n \n
\n \n ![\"npm](\"https://img.shields.io/npm/v/@gustavojosemelo/n8n-nodes-bitrix24?color=blue&label=npm\")
![\"npm](\"https://img.shields.io/npm/dm/@gustavojosemelo/n8n-nodes-bitrix24?color=green\")
![\"license\"](\"https://img.shields.io/github/license/gustavojosemelo/n8n-nodes-bitrix24\")
![\"n8n](\"https://img.shields.io/badge/n8n-community%20node-orange\"){kind=icon}
\n A full-featured n8n community node for Bitrix24 — covering CRM, Tasks, Open Channels, Chatbots, Drive, Document Generator, News Feed, and a Raw API executor.\n
\n\n---\n\n## ✨ Features\n\n| Category | Resources | Operations |\n|---|---|---|\n| 📋 **CRM** | Deal, Lead, Contact, Company | Create · Get · Update · Delete · List · Search |\n| ✅ **Tasks** | Task, Task Comment | Create · Get · Update · Delete · List · Complete |\n| 👤 **Users** | User | Get · Get Current · List · Search |\n| 💬 **Open Channels** | Message, Conversation | Send · History · Complete · Assign |\n| 🤖 **Chatbot** | Bot, Bot Message | Register · Send · Update · Delete |\n| 📁 **Drive** | File, Folder | Upload · Get · List · Delete · Rename |\n| 📄 **Document Generator** | Document, Template | Generate PDF · List Templates · Download URL |\n| 📰 **News Feed** | Blog Post, CRM Activity | Create · Get · Update · Delete · List · Complete |\n| ⚡ **Raw API** | Any method | Execute · Batch · Auto-paginate |\n\n### Highlights\n\n- 🔄 **Dynamic dropdowns** — Pipelines, Stages, Users, and custom `UF_` fields loaded live from your Bitrix24\n- 🔍 **Smart filters** — Quick filters (dropdowns) + Advanced raw JSON filter on all list operations\n- 📦 **Auto-pagination** — Fetch all pages automatically (Bitrix24 returns max 50/page)\n- ⚡ **Raw API** — Execute any Bitrix24 method directly, just like Make's \"Make an API Call\"\n- 🔗 **Batch API** — Run multiple methods in one request with cross-result references\n- 🔔 **Trigger Node** — Auto-registers webhooks on activation, cleans up on deactivation\n- 🔐 **Dual auth** — Webhook URL mode (simple) and OAuth2 mode (for marketplace apps)\n\n---\n\n## 📦 Installation\n\n### Via n8n Interface (recommended)\n\n1. Go to **Settings → Community Nodes**\n2. Click **Install**\n3. Enter: `@gustavojosemelo/n8n-nodes-bitrix24`\n4. Confirm and restart n8n\n\n### Via npm\n\n```bash\nnpm install @gustavojosemelo/n8n-nodes-bitrix24\n```\n\n### Via Docker\n\n```bash\ndocker exec -it n8n npm install @gustavojosemelo/n8n-nodes-bitrix24 --prefix /home/node/.n8n/custom\ndocker restart n8n\n```\n\n---\n\n## 🔐 Authentication\n\nThis node supports two authentication modes, selectable in the credential:\n\n### Webhook Mode (recommended for personal use)\n\nThe simplest option. Uses a Bitrix24 inbound webhook URL with the token already embedded.\n\n1. In Bitrix24, go to **Developer Resources → Other → Inbound Webhook**\n2. Create a new webhook and copy the full URL\n > Example: `https://yourdomain.bitrix24.com/rest/1/abc123token/`\n3. In n8n, create a **Bitrix24 API** credential\n4. Select **Authentication Mode: Webhook**\n5. Paste the full URL\n\n### OAuth2 Mode (for Marketplace apps)\n\nFor registered apps in the Bitrix24 developer zone.\n\n1. Register an app at **Bitrix24 Developer Zone → My Apps**\n2. Copy the **Client ID**, **Client Secret**, and your portal **Domain**\n3. In n8n, select **Authentication Mode: OAuth2** and fill in the fields\n\n---\n\n## 🚀 Usage\n\n### CRM — Dynamic Fields\n\nWhen creating or updating a **Deal**, **Lead**, **Contact**, or **Company**, the node automatically loads:\n\n- **Pipeline** — dropdown with your real funnels (`crm.category.list`)\n- **Stage** — dropdown filtered by the selected pipeline (`crm.dealcategory.stages`)\n- **Responsible User** — dropdown with active users (`user.get`)\n- **Custom Fields (UF_)** — separate section listing all `UF_*` fields with their readable labels\n\n### List / Search — Filtering\n\nEvery list operation has two filter modes:\n\n- **Quick Filters** — pre-built dropdowns for the most common fields\n- **Advanced Filter (Raw JSON)** — pass any `FILTER` object directly to the Bitrix24 API\n\n```json\n// Advanced filter example for crm.deal.list\n{\n \"STAGE_ID\": \"WON\",\n \">OPPORTUNITY\": 10000,\n \"ASSIGNED_BY_ID\": \"5\"\n}\n```\n\nSet **Max Results** to `0` to fetch all pages automatically.\n\n### ⚡ Raw API — Execute any method\n\nSelect **Category: Raw API** to call any Bitrix24 REST method:\n\n| Field | Example |\n|---|---|\n| Method | `crm.deal.list` |\n| Parameters (JSON) | `{\"filter\": {\"STAGE_ID\": \"NEW\"}, \"select\": [\"ID\",\"TITLE\"]}` |\n| Fetch All Pages | Enable for list methods |\n\n```json\n// Batch example\n{\n \"cmd\": {\n \"get_deal\": \"crm.deal.get?id=42\",\n \"deal_contacts\": \"crm.deal.contact.items.get?id=42\"\n }\n}\n```\n\nResults can reference each other: `$result[get_deal][ASSIGNED_BY_ID]`\n\n### 🔔 Trigger Node — Available Events\n\n| Group | Event | Description |\n|---|---|---|\n| CRM Deal | `ONCRMDEALADD` | Deal created |\n| CRM Deal | `ONCRMDEALUPDATE` | Deal updated |\n| CRM Deal | `ONCRMDEALMOVE` | Deal stage changed |\n| CRM Deal | `ONCRMDEALDELETION` | Deal deleted |\n| CRM Lead | `ONCRMLEADADD` | Lead created |\n| CRM Lead | `ONCRMLEADUPDATE` | Lead updated |\n| CRM Contact | `ONCRMCONTACTADD` | Contact created |\n| CRM Company | `ONCRMCOMPANYADD` | Company created |\n| Tasks | `ONTASKADD` | Task created |\n| Tasks | `ONTASKUPDATE` | Task updated |\n| Tasks | `ONTASKCOMMENTADD` | Comment added to task |\n| Messages | `ONIMBOTMESSAGEADD` | New open channel message |\n| Messages | `ONOPENLINESSESSIONSTART` | New support session opened |\n| Messages | `ONOPENLINESSESSIONFINISH` | Support session closed |\n\n**Tip:** Enable **Include Full Object** to automatically fetch the complete entity (all fields including `UF_*`) after receiving the event — at the cost of one extra API call.\n\n---\n\n## 🏗️ Project Structure\n\n```\nnodes/Bitrix24/\n├── Bitrix24.node.ts # Main regular node\n├── Bitrix24Trigger.node.ts # Trigger node\n├── GenericFunctions.ts # HTTP helper, auth, loadOptions\n├── bitrix24.svg # Node icon\n├── credentials/\n│ └── Bitrix24Api.credentials.ts\n└── resources/\n ├── crm/\n │ ├── deal.ts\n │ ├── lead.ts\n │ ├── contact.ts\n │ └── company.ts\n ├── tasks/\n │ └── task.ts # Task + Task Comment\n ├── users/\n │ └── user.ts\n ├── openChannels/\n │ └── message.ts # Message + Conversation\n ├── chatbot/\n │ └── bot.ts # Bot + Bot Message\n ├── drive/\n │ └── file.ts # File + Folder\n ├── documentGenerator/\n │ └── document.ts\n ├── newsFeed/\n │ └── newsFeed.ts # Blog Post + CRM Activity\n └── rawApi/\n └── rawApi.ts\n```\n\n---\n\n## 🛠️ Local Development\n\n```bash\n# Clone the repo\ngit clone https://github.com/gustavojosemelo/n8n-nodes-bitrix24.git\ncd n8n-nodes-bitrix24\n\n# Install dependencies\nnpm install\n\n# Build\nnpm run build\n\n# Link for local n8n testing\ncd ~/.n8n/custom\nnpm link n8n-nodes-bitrix24\n```\n\n---\n\n## 📋 API Rate Limits\n\nBitrix24 limits **2 requests/second** by default on commercial plans. For large list operations, use **Max Results: 0** to enable automatic pagination with built-in rate control.\n\n---\n\n## 🤝 Contributing\n\nPull requests are welcome! For major changes, please open an issue first to discuss what you'd like to change.\n\n1. Fork the repository\n2. Create your branch: `git checkout -b feature/my-feature`\n3. Commit: `git commit -m 'feat: add my feature'`\n4. Push: `git push origin feature/my-feature`\n5. Open a Pull Request\n\n---\n\n## 📄 License\n\n[MIT](./LICENSE) © [Gustavo José Melo](https://universonext.com.br)\n\n---\n\n\n Made with ❤️ by Next Comunicação\n
\n","readmeFilename":"README.md"}