[{"data":1,"prerenderedAt":701},["ShallowReactive",2],{"navigation":3,"-docs-examples-event-registration":445,"-docs-examples-event-registration-description":690},[4],{"title":5,"path":6,"stem":7,"children":8,"page":47},"Docs","\u002Fdocs","docs",[9,73,337],{"title":10,"path":11,"stem":12,"children":13,"restApiVersion":15,"category":15,"description":15,"badge":15},"Get Started","\u002Fdocs\u002Fgetting-started","docs\u002F1.getting-started\u002F1.index",[14,17,48,58],{"title":10,"path":11,"stem":12,"restApiVersion":15,"category":15,"description":16,"badge":15},null,"Quick start guide for working with the SDK for Bitrix24 REST API",{"title":18,"path":19,"stem":20,"children":21,"page":47},"Installation","\u002Fdocs\u002Fgetting-started\u002Finstallation","docs\u002F1.getting-started\u002F2.installation",[22,27,32,37,42],{"title":23,"path":24,"stem":25,"restApiVersion":15,"category":15,"description":26,"badge":15},"Vue","\u002Fdocs\u002Fgetting-started\u002Finstallation\u002Fvue","docs\u002F1.getting-started\u002F2.installation\u002F1.vue","Guide for installing Bitrix24 JS SDK in Vue applications.",{"title":28,"path":29,"stem":30,"restApiVersion":15,"category":15,"description":31,"badge":15},"Nuxt","\u002Fdocs\u002Fgetting-started\u002Finstallation\u002Fnuxt","docs\u002F1.getting-started\u002F2.installation\u002F2.nuxt","Guide for installing Bitrix24 JS SDK in Nuxt applications.",{"title":33,"path":34,"stem":35,"restApiVersion":15,"category":15,"description":36,"badge":15},"React","\u002Fdocs\u002Fgetting-started\u002Finstallation\u002Freact","docs\u002F1.getting-started\u002F2.installation\u002F3.react","Guide for installing Bitrix24 JS SDK in React applications.",{"title":38,"path":39,"stem":40,"restApiVersion":15,"category":15,"description":41,"badge":15},"Node.js","\u002Fdocs\u002Fgetting-started\u002Finstallation\u002Fnodejs","docs\u002F1.getting-started\u002F2.installation\u002F4.nodejs","Guide for installing Bitrix24 JS SDK in Node.js applications.",{"title":43,"path":44,"stem":45,"restApiVersion":15,"category":15,"description":46,"badge":15},"UMD","\u002Fdocs\u002Fgetting-started\u002Finstallation\u002Fumd","docs\u002F1.getting-started\u002F2.installation\u002F5.umd","Guide for using UMD version Bitrix24 JS SDK in you applications.",false,{"title":49,"restApiVersion":15,"category":15,"description":15,"badge":15,"shadow":47,"path":50,"stem":51,"children":52,"page":47},"Migration","\u002Fdocs\u002Fgetting-started\u002Fmigration","docs\u002F1.getting-started\u002F3.migration",[53],{"title":54,"path":55,"stem":56,"restApiVersion":15,"category":15,"description":57,"badge":15},"v0 to v1","\u002Fdocs\u002Fgetting-started\u002Fmigration\u002Fv1","docs\u002F1.getting-started\u002F3.migration\u002F1.v1","A comprehensive guide to migrate your application from Bitrix24 JS SDK v0 to Bitrix24 JS SDK v1.",{"title":59,"restApiVersion":15,"category":15,"description":15,"badge":15,"path":60,"stem":61,"children":62,"page":47},"AI Tools","\u002Fdocs\u002Fgetting-started\u002Fai","docs\u002F1.getting-started\u002F7.ai",[63,68],{"title":64,"path":65,"stem":66,"restApiVersion":15,"category":15,"description":67,"badge":15},"Skills","\u002Fdocs\u002Fgetting-started\u002Fai\u002Fskills","docs\u002F1.getting-started\u002F7.ai\u002F1.skills","Task-focused skill files for AI coding agents working with @bitrix24\u002Fb24jssdk.",{"title":69,"path":70,"stem":71,"restApiVersion":15,"category":15,"description":72,"badge":15},"LLMs.txt","\u002Fdocs\u002Fgetting-started\u002Fai\u002Fllms-txt","docs\u002F1.getting-started\u002F7.ai\u002F2.llms-txt","How to get AI tools like Cursor, Windsurf, GitHub Copilot, ChatGPT, and Claude to understand Bitrix24 JS SDK methods, tools, and best practices.",{"title":74,"path":75,"stem":76,"children":77,"restApiVersion":15,"category":15,"description":15,"badge":15},"Working with the REST API","\u002Fdocs\u002Fworking-with-the-rest-api","docs\u002F2.working-with-the-rest-api\u002F0.index",[78,81,88,93,98,102,107,111,116,121,125,130,135,140,145,150,155,160,165,170,174,179,184,190,195,200,205,210,215,220,225,230,235,241,246,252,257,262,267,272,278,284,290,295,300,305,311,316,321,326,332],{"title":79,"path":75,"stem":76,"restApiVersion":15,"category":15,"description":80,"badge":15},"Introduction","Overview of SDK capabilities for working with Bitrix24 REST API",{"title":82,"path":83,"stem":84,"restApiVersion":85,"category":86,"description":87,"badge":15},"Call","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcall-rest-api-ver2","docs\u002F2.working-with-the-rest-api\u002F1.call-rest-api-ver2","rest-api-ver2","actions","A method for making Bitrix24 REST API version 2 calls.",{"title":82,"path":89,"stem":90,"restApiVersion":91,"category":86,"description":92,"badge":15},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcall-rest-api-ver3","docs\u002F2.working-with-the-rest-api\u002F1.call-rest-api-ver3","rest-api-ver3","Method for making Bitrix24 REST API version 3 calls.",{"title":94,"path":95,"stem":96,"restApiVersion":85,"category":86,"description":97,"badge":15},"CallList","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcall-list-rest-api-ver2","docs\u002F2.working-with-the-rest-api\u002F2.call-list-rest-api-ver2","Method for quickly retrieving all data from list methods of Bitrix24 REST API version 2.",{"title":94,"path":99,"stem":100,"restApiVersion":91,"category":86,"description":101,"badge":15},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcall-list-rest-api-ver3","docs\u002F2.working-with-the-rest-api\u002F2.call-list-rest-api-ver3","Method for quickly retrieving all data from list methods of Bitrix24 REST API version 3.",{"title":103,"path":104,"stem":105,"restApiVersion":85,"category":86,"description":106,"badge":15},"FetchList","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ffetch-list-rest-api-ver2","docs\u002F2.working-with-the-rest-api\u002F2.fetch-list-rest-api-ver2","Returns an AsyncGenerator that allows processing data from list methods of Bitrix24 REST API version 2 as it is received without loading the entire array into memory at once. This is especially useful when working with very large volumes of data.",{"title":103,"path":108,"stem":109,"restApiVersion":91,"category":86,"description":110,"badge":15},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Ffetch-list-rest-api-ver3","docs\u002F2.working-with-the-rest-api\u002F2.fetch-list-rest-api-ver3","Returns an AsyncGenerator that allows processing data from list methods of Bitrix24 REST API version 3 as it is received without loading the entire array into memory at once. This is especially useful when working with very large volumes of data.",{"title":112,"path":113,"stem":114,"restApiVersion":15,"category":112,"description":115,"badge":15},"B24Hook","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhook","docs\u002F2.working-with-the-rest-api\u002F20.hook","Server-side entry point for talking to the Bitrix24 REST API through an inbound webhook (permanent token).",{"title":117,"path":118,"stem":119,"restApiVersion":85,"category":86,"description":120,"badge":15},"Batch","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fbatch-rest-api-ver2","docs\u002F2.working-with-the-rest-api\u002F3.batch-rest-api-ver2","Method for executing batch requests to Bitrix24 REST API version 2. Allows executing up to 50 commands in a single API call.",{"title":117,"path":122,"stem":123,"restApiVersion":91,"category":86,"description":124,"badge":15},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fbatch-rest-api-ver3","docs\u002F2.working-with-the-rest-api\u002F3.batch-rest-api-ver3","Method for executing batch requests to Bitrix24 REST API version 3. Allows executing up to 50 commands in a single API call.",{"title":79,"path":126,"stem":127,"restApiVersion":15,"category":128,"description":129,"badge":15},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe","docs\u002F2.working-with-the-rest-api\u002F30.frame","B24Frame","Designed for managing Bitrix24 applications running inside a placement iframe. Inherits from AbstractB24 and exposes managers for authentication, parent-window messaging, sliders, dialogs, placements, and options.",{"title":131,"path":132,"stem":133,"restApiVersion":15,"category":128,"description":134,"badge":15},"Initialization","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-initialize-b24-frame","docs\u002F2.working-with-the-rest-api\u002F30.frame-initialize-b24-frame","Function is designed to initialize a B24Frame",{"title":136,"path":137,"stem":138,"restApiVersion":15,"category":128,"description":139,"badge":15},"Auth","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-auth","docs\u002F2.working-with-the-rest-api\u002F31.frame-auth","Designed for managing authentication in Bitrix24 applications. It handles authentication data received from the parent window and provides methods for updating and retrieving this data.",{"title":141,"path":142,"stem":143,"restApiVersion":15,"category":128,"description":144,"badge":15},"Dialog","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-dialog","docs\u002F2.working-with-the-rest-api\u002F31.frame-dialog","Wraps the BX24 system dialogs (user picker, access permission picker, CRM entity picker) so they can be opened from inside a Bitrix24 application iframe.",{"title":146,"path":147,"stem":148,"restApiVersion":15,"category":128,"description":149,"badge":15},"Options","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-options","docs\u002F2.working-with-the-rest-api\u002F31.frame-options","Used for managing application and user settings in the Bitrix24 application. It allows initializing data, getting, and setting options through messages to the parent window.",{"title":151,"path":152,"stem":153,"restApiVersion":15,"category":128,"description":154,"badge":15},"Parent","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-parent","docs\u002F2.working-with-the-rest-api\u002F31.frame-parent","Provides methods for managing the parent application window in Bitrix24, including resizing the window, managing scroll, initiating calls, and opening the messenger.",{"title":156,"path":157,"stem":158,"restApiVersion":15,"category":128,"description":159,"badge":15},"Placement","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-placement","docs\u002F2.working-with-the-rest-api\u002F31.frame-placement","Used for managing the placement of widgets in the Bitrix24 application.",{"title":161,"path":162,"stem":163,"restApiVersion":15,"category":128,"description":164,"badge":15},"Slider","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-slider","docs\u002F2.working-with-the-rest-api\u002F31.frame-slider","Provides methods for working with sliders in the Bitrix24 application. It allows opening and closing sliders, as well as managing their content.",{"title":166,"path":167,"stem":168,"restApiVersion":85,"category":86,"description":169,"badge":15},"BatchByChunk","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fbatch-by-chunk-rest-api-ver2","docs\u002F2.working-with-the-rest-api\u002F4.batch-by-chunk-rest-api-ver2","Method for executing batch requests with automatic chunking for any number of commands. Automatically splits large command sets into batches of 50 and executes them sequentially. Use only arrays of tuples or arrays of objects.",{"title":166,"path":171,"stem":172,"restApiVersion":91,"category":86,"description":173,"badge":15},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fbatch-by-chunk-rest-api-ver3","docs\u002F2.working-with-the-rest-api\u002F4.batch-by-chunk-rest-api-ver3","Method for executing batch requests to Bitrix24 REST API version 3 with automatic chunking for any number of commands. Automatically splits large command sets into batches of 50 and executes them sequentially. Use only arrays of tuples or arrays of objects.",{"title":175,"path":176,"stem":177,"restApiVersion":15,"category":175,"description":178,"badge":15},"B24OAuth","\u002Fdocs\u002Fworking-with-the-rest-api\u002Foauth","docs\u002F2.working-with-the-rest-api\u002F40.oauth","Server-side entry point for talking to the Bitrix24 REST API with an OAuth 2.0 access token (and automatic refresh).",{"title":180,"path":181,"stem":182,"restApiVersion":15,"category":15,"description":183,"badge":15},"Choosing the method","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fchoosing-the-right-method","docs\u002F2.working-with-the-rest-api\u002F5.choosing-the-right-method","Decision guide for picking between Call, CallList, FetchList, Batch and BatchByChunk in REST API v2 and v3.",{"title":185,"path":186,"stem":187,"restApiVersion":15,"category":188,"description":189,"badge":15},"B24HelperManager","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper","docs\u002F2.working-with-the-rest-api\u002F50.helper","Helper","Aggregate manager that loads profile, app, payment, license, currency, and options data with one batched REST call, plus wires the Pull client.",{"title":191,"path":192,"stem":193,"restApiVersion":15,"category":188,"description":194,"badge":15},"useB24Helper","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper-use-b24-helper","docs\u002F2.working-with-the-rest-api\u002F51.helper-use-b24-helper","Closure-based composable that owns a single B24HelperManager instance and exposes lifecycle helpers (init \u002F destroy \u002F Pull client glue).",{"title":196,"path":197,"stem":198,"restApiVersion":15,"category":188,"description":199,"badge":15},"ProfileManager","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper-profile-manager","docs\u002F2.working-with-the-rest-api\u002F52.helper-profile-manager","Parsed `profile` REST response: id, name, last name, gender, photo, time zone, admin flag.",{"title":201,"path":202,"stem":203,"restApiVersion":15,"category":188,"description":204,"badge":15},"AppManager","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper-app-manager","docs\u002F2.working-with-the-rest-api\u002F53.helper-app-manager","Parsed `app.info` REST response: app id, code, version, status, install flag.",{"title":206,"path":207,"stem":208,"restApiVersion":15,"category":188,"description":209,"badge":15},"PaymentManager","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper-payment-manager","docs\u002F2.working-with-the-rest-api\u002F54.helper-payment-manager","Payment status of a Bitrix24 application — extracted from `app.info`.",{"title":211,"path":212,"stem":213,"restApiVersion":15,"category":188,"description":214,"badge":15},"LicenseManager","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper-license-manager","docs\u002F2.working-with-the-rest-api\u002F55.helper-license-manager","Bitrix24 license info from `app.info` — and an automatic restriction-manager retune for the matching tariff plan.",{"title":216,"path":217,"stem":218,"restApiVersion":15,"category":188,"description":219,"badge":15},"CurrencyManager","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper-currency-manager","docs\u002F2.working-with-the-rest-api\u002F56.helper-currency-manager","Currency catalogue cached in memory — base currency, per-currency formatters, and number-to-string formatter.",{"title":221,"path":222,"stem":223,"restApiVersion":15,"category":188,"description":224,"badge":15},"OptionsManager","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper-options-manager","docs\u002F2.working-with-the-rest-api\u002F57.helper-options-manager","Typed access to `app.option.get` \u002F `user.option.get`, plus a save() that batches `*.option.set` with an optional Pull notification.",{"title":226,"path":227,"stem":228,"restApiVersion":15,"category":15,"description":229,"badge":15},"Errors","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ferrors","docs\u002F2.working-with-the-rest-api\u002F6.errors","Reference for SdkError and AjaxError codes raised by the SDK, plus the Bitrix24 REST error codes that surface through them.",{"title":231,"path":232,"stem":233,"restApiVersion":15,"category":231,"description":234,"badge":15},"Pull","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fpull","docs\u002F2.working-with-the-rest-api\u002F60.pull","Real-time message stream from Bitrix24 to your application — WebSocket primary, long-polling fallback. Frame-only.",{"title":236,"path":237,"stem":238,"restApiVersion":15,"category":239,"description":240,"badge":15},"Logger","\u002Fdocs\u002Fworking-with-the-rest-api\u002Flogger","docs\u002F2.working-with-the-rest-api\u002F66.logger","logger","Logger inspired by PHP Monolog, provides a structured logging system with support for channels, handlers, processors, and formatters. Implementation follows PSR-3 principles and the chain of responsibility pattern.",{"title":242,"path":243,"stem":244,"restApiVersion":15,"category":239,"description":245,"badge":15},"Telegram","\u002Fdocs\u002Fworking-with-the-rest-api\u002Flogger-telegram","docs\u002F2.working-with-the-rest-api\u002F66.logger-telegram","Sending logs to Telegram",{"title":247,"path":248,"stem":249,"restApiVersion":15,"category":250,"description":251,"badge":15},"AjaxResult","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcore-ajax-result","docs\u002F2.working-with-the-rest-api\u002F70.core-ajax-result","Core","Specialised Result returned by every REST helper. Provides `isMore() \u002F getNext() \u002F getTotal() \u002F getStatus()` for paged responses, and immutable data.",{"title":253,"path":254,"stem":255,"restApiVersion":15,"category":250,"description":256,"badge":15},"Http","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcore-http","docs\u002F2.working-with-the-rest-api\u002F70.core-http","Low-level transport interface returned by `b24.getHttpClient(version)`. Direct access to the axios-based clients, restriction params, statistics, and reset.",{"title":258,"path":259,"stem":260,"restApiVersion":15,"category":250,"description":261,"badge":15},"B24LangList","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcore-lang-list","docs\u002F2.working-with-the-rest-api\u002F70.core-lang-list","Enum of Bitrix24 cloud interface languages plus the BCP-47 locale map.",{"title":263,"path":264,"stem":265,"restApiVersion":15,"category":250,"description":266,"badge":15},"RequestIdGenerator","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcore-request-id-generator","docs\u002F2.working-with-the-rest-api\u002F70.core-request-id-generator","Default `IRequestIdGenerator` implementation. Generates UUID v7 request ids and exposes the header \u002F query parameter names used by the SDK.",{"title":268,"path":269,"stem":270,"restApiVersion":15,"category":250,"description":271,"badge":15},"Result","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcore-result","docs\u002F2.working-with-the-rest-api\u002F70.core-result","Generic operation result with success flag, data, and an error map. Analogue of \\\\Bitrix\\\\Main\\\\Result from the Bitrix Framework.",{"title":273,"path":274,"stem":275,"restApiVersion":15,"category":276,"description":277,"badge":15},"Limiters","\u002Fdocs\u002Fworking-with-the-rest-api\u002Flimiters","docs\u002F2.working-with-the-rest-api\u002F77.limiters","limiters","The restrictions system provides a comprehensive mechanism for managing request frequency, operation execution time, and adaptive delays.",{"title":279,"path":280,"stem":281,"restApiVersion":15,"category":282,"description":283,"badge":15},"Logging & Redaction","\u002Fdocs\u002Fworking-with-the-rest-api\u002Flogging","docs\u002F2.working-with-the-rest-api\u002F78.logging","logging","What the SDK redacts automatically before any request information enters the logger or an AjaxError, what it does not redact, and how to wire a custom logger via setLogger(...) without re-introducing credential leaks.",{"title":285,"path":286,"stem":287,"restApiVersion":15,"category":288,"description":289,"badge":15},"Browser","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-browser","docs\u002F2.working-with-the-rest-api\u002F80.tools-browser","Tools","Cheap user-agent \u002F platform \u002F capability detector. Useful for runtime branches in front-end code.",{"title":291,"path":292,"stem":293,"restApiVersion":15,"category":288,"description":294,"badge":15},"Text","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-text","docs\u002F2.working-with-the-rest-api\u002F80.tools-text","Text and date utilities — UUID v7, encode \u002F decode HTML entities, type conversions, case helpers, Luxon-backed `toDateTime` \u002F `toB24Format`, query-string builder.",{"title":296,"path":297,"stem":298,"restApiVersion":15,"category":288,"description":299,"badge":15},"Type","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-type","docs\u002F2.working-with-the-rest-api\u002F80.tools-type","Runtime type guards — strings, numbers, plain objects, arrays, DOM nodes, Blobs, FormData, JSON-RPC message shapes.",{"title":301,"path":302,"stem":303,"restApiVersion":15,"category":288,"description":304,"badge":15},"useFormatter","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-use-formatters","docs\u002F2.working-with-the-rest-api\u002F80.tools-use-formatters","Composable that returns shared `FormatterNumbers` and `FormatterIban` instances pre-configured with country specifications.",{"title":306,"path":307,"stem":308,"restApiVersion":15,"category":309,"description":310,"badge":15},"IResult","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftypes-iresult","docs\u002F2.working-with-the-rest-api\u002F90.types-iresult","Types","Generic operation-result interface. Implemented by `Result\u003CT>` and (transitively) by `AjaxResult\u003CT>`.",{"title":312,"path":313,"stem":314,"restApiVersion":15,"category":309,"description":315,"badge":15},"TypeB24","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftypes-type-b24","docs\u002F2.working-with-the-rest-api\u002F90.types-type-b24","Public contract implemented by every entry-point class (B24Frame, B24Hook, B24OAuth). Single source of truth for the SDK surface.",{"title":317,"path":318,"stem":319,"restApiVersion":15,"category":250,"description":320,"badge":15},"Telemetry","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftelemetry","docs\u002F2.working-with-the-rest-api\u002F95.telemetry","Request id, SDK version, and SDK type query parameters added to every Bitrix24 REST call.",{"title":322,"path":323,"stem":324,"restApiVersion":15,"category":250,"description":325,"badge":15},"Error Codes","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ferror-codes","docs\u002F2.working-with-the-rest-api\u002F96.error-codes","Catalogue of error codes the SDK recognises — split into \"hard\" (thrown) and \"soft\" (returned as AjaxError inside AjaxResult).",{"title":327,"path":328,"stem":329,"restApiVersion":15,"category":330,"description":331,"badge":15},"HealthCheck","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-health-check","docs\u002F2.working-with-the-rest-api\u002Ftools-health-check","tools","Method for checking the availability of Bitrix24 REST API. Performs a simple request to the REST API to verify service health.",{"title":333,"path":334,"stem":335,"restApiVersion":15,"category":330,"description":336,"badge":15},"Ping","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-ping","docs\u002F2.working-with-the-rest-api\u002Ftools-ping","Method for measuring Bitrix24 REST API response speed. Performs a test request and returns response time in milliseconds.",{"title":338,"path":339,"stem":340,"children":341,"restApiVersion":15,"category":15,"description":15,"badge":15},"Examples","\u002Fdocs\u002Fexamples","docs\u002F99.examples\u002F0.index",[342,344,350,355,360,365,370,375,380,385,390,395,400,405,410,415,420,425,430,435,440],{"title":79,"path":339,"stem":340,"restApiVersion":15,"category":15,"description":343,"badge":15},"Recipes that pair the SDK with realistic scenarios — CRM analytics, mass messaging, AI assistants, OAuth installs, and more. Each recipe is a single, copy-paste-friendly file.",{"title":345,"path":346,"stem":347,"restApiVersion":15,"category":348,"description":349,"badge":15},"CRM analytics","\u002Fdocs\u002Fexamples\u002Fcrm-analytics","docs\u002F99.examples\u002F1.crm-analytics","examples","Stream all deals via actions.v2.fetchList.make, group by stage, print a funnel report (counts, conversion %, avg ticket, win rate).",{"title":351,"path":352,"stem":353,"restApiVersion":15,"category":348,"description":354,"badge":15},"Deals → CSV","\u002Fdocs\u002Fexamples\u002Fdashboard-deals-csv","docs\u002F99.examples\u002F1.dashboard-deals-csv","Stream every CRM deal that matches a date filter into a CSV file using a webhook and FetchListV2.",{"title":356,"path":357,"stem":358,"restApiVersion":15,"category":15,"description":359,"badge":15},"Entity List","\u002Fdocs\u002Fexamples\u002Fentity-list","docs\u002F99.examples\u002F10.entity-list","Render a paged Bitrix24 entity list with B24UI components and the SDK callList action.",{"title":361,"path":362,"stem":363,"restApiVersion":15,"category":348,"description":364,"badge":15},"Error handling","\u002Fdocs\u002Fexamples\u002Ferror-handling","docs\u002F99.examples\u002F10.error-handling","Demonstrates the four error layers (SdkError \u002F AjaxError \u002F network \u002F soft) and the hardErrorCodes \u002F softErrorCodes \u002F retryOnNetworkError knobs on the restriction manager.",{"title":366,"path":367,"stem":368,"restApiVersion":15,"category":348,"description":369,"badge":15},"Event registration","\u002Fdocs\u002Fexamples\u002Fevent-registration","docs\u002F99.examples\u002F11.event-registration","CLI tool — list, bind, and unbind Bitrix24 outbound webhook events via event.get \u002F event.bind \u002F event.unbind. Pairs with the webhook handler recipe.",{"title":371,"path":372,"stem":373,"restApiVersion":15,"category":348,"description":374,"badge":15},"OAuth install","\u002Fdocs\u002Fexamples\u002Foauth-install","docs\u002F99.examples\u002F12.oauth-install","Express server that handles ONAPPINSTALL \u002F ONAPPUPDATE \u002F ONAPPUNINSTALL events for a Bitrix24 marketplace app, persists tokens per portal, and builds a B24OAuth client on demand with a refresh callback wired to storage.",{"title":376,"path":377,"stem":378,"restApiVersion":15,"category":348,"description":379,"badge":15},"Frame app skeleton","\u002Fdocs\u002Fexamples\u002Fframe-app-skeleton","docs\u002F99.examples\u002F2.frame-app-skeleton","Minimum viable Bitrix24 iframe app: init handshake, set title, persist app state, open a slider, close cleanly.",{"title":381,"path":382,"stem":383,"restApiVersion":15,"category":348,"description":384,"badge":15},"Mass messaging","\u002Fdocs\u002Fexamples\u002Fmass-messaging","docs\u002F99.examples\u002F2.mass-messaging","Filter contacts in CRM, personalise a template, send IM notifications to assigned managers.",{"title":386,"path":387,"stem":388,"restApiVersion":15,"category":15,"description":389,"badge":15},"Installation Wizard","\u002Fdocs\u002Fexamples\u002Fapp-installation-wizard","docs\u002F99.examples\u002F20.app-installation-wizard","Multi-step install flow that creates user fields, registers placements, finalises the installation, and celebrates with confetti.",{"title":391,"path":392,"stem":393,"restApiVersion":15,"category":348,"description":394,"badge":15},"Task automation","\u002Fdocs\u002Fexamples\u002Ftask-automation","docs\u002F99.examples\u002F3.task-automation","Poll deal stages every 60 s. When a watched transition fires, create a task with description, deadline and priority.",{"title":396,"path":397,"stem":398,"restApiVersion":15,"category":348,"description":399,"badge":15},"Webhook CLI","\u002Fdocs\u002Fexamples\u002Fwebhook-cli-node","docs\u002F99.examples\u002F3.webhook-cli-node","A 30-line Node script that authenticates against a Bitrix24 portal via inbound webhook and prints the calling user — useful as the first thing you run after creating a webhook.",{"title":401,"path":402,"stem":403,"restApiVersion":15,"category":15,"description":404,"badge":15},"Node + Hook Export","\u002Fdocs\u002Fexamples\u002Fnode-hook-company-export","docs\u002F99.examples\u002F30.node-hook-company-export","Export Bitrix24 companies into a CSV file from a pure Node.js script using B24Hook.",{"title":406,"path":407,"stem":408,"restApiVersion":15,"category":348,"description":409,"badge":15},"Bulk update","\u002Fdocs\u002Fexamples\u002Fbulk-update-deals","docs\u002F99.examples\u002F4.bulk-update-deals","Migrate thousands of CRM deals to a new stage using BatchByChunkV2 — automatic chunking, partial-error handling, and a single progress line.",{"title":411,"path":412,"stem":413,"restApiVersion":15,"category":348,"description":414,"badge":15},"ERP sync","\u002Fdocs\u002Fexamples\u002Ferp-sync","docs\u002F99.examples\u002F4.erp-sync","Two-way contact sync between Bitrix24 and an external ERP. Match by INN (primary) or email (fallback). Cron every hour.",{"title":416,"path":417,"stem":418,"restApiVersion":15,"category":348,"description":419,"badge":15},"Disk files","\u002Fdocs\u002Fexamples\u002Fdisk-files","docs\u002F99.examples\u002F5.disk-files","List storages and folder children, create subfolders, inspect files. File upload (multipart) is intentionally out of scope.",{"title":421,"path":422,"stem":423,"restApiVersion":15,"category":348,"description":424,"badge":15},"Pull subscribe","\u002Fdocs\u002Fexamples\u002Fpull-subscribe-frame","docs\u002F99.examples\u002F5.pull-subscribe-frame","Open a live channel from a Bitrix24 frame app and react to push events using useB24Helper + the Pull client.",{"title":426,"path":427,"stem":428,"restApiVersion":15,"category":348,"description":429,"badge":15},"Telegram bot","\u002Fdocs\u002Fexamples\u002Ftelegram-bot","docs\u002F99.examples\u002F6.telegram-bot","Poll new CRM deals every two minutes; notify a Telegram chat with an HTML-formatted card.",{"title":431,"path":432,"stem":433,"restApiVersion":15,"category":348,"description":434,"badge":15},"Webhook handler","\u002Fdocs\u002Fexamples\u002Fwebhook-handler","docs\u002F99.examples\u002F7.webhook-handler","Express server that receives Bitrix24 outbound events, fetches details via REST, dispatches by event name. Always returns 200.",{"title":436,"path":437,"stem":438,"restApiVersion":15,"category":348,"description":439,"badge":15},"AI assistant","\u002Fdocs\u002Fexamples\u002Fai-assistant","docs\u002F99.examples\u002F8.ai-assistant","Load a deal and its activities, ask GPT-4o for the next-best action, create a task bound to the deal with priority and deadline.",{"title":441,"path":442,"stem":443,"restApiVersion":15,"category":348,"description":444,"badge":15},"Web search + LLM","\u002Fdocs\u002Fexamples\u002Fweb-search-llm","docs\u002F99.examples\u002F9.web-search-llm","Two-step RAG: ask any web-search provider, run the result through your LLM with [N] citations, post the answer as a CRM timeline comment on a deal.",{"id":446,"title":447,"audited":15,"badge":15,"body":448,"category":348,"description":369,"extension":681,"links":682,"meta":686,"navigation":687,"path":367,"restApiVersion":15,"seo":688,"stem":368,"__hash__":689},"docs\u002Fdocs\u002F99.examples\u002F11.event-registration.md","Outbound event registration",{"type":449,"value":450,"toc":673},"minimark",[451,456,460,494,497,501,504,508,565,569,612,616,628,632,669],[452,453,455],"h2",{"id":454},"what-it-does","What it does",[457,458,459],"p",{},"Recipe 7 (webhook handler) assumes events are already bound. This recipe closes that loop:",[461,462,463,471,488],"ul",{},[464,465,466,470],"li",{},[467,468,469],"code",{},"list"," — print all currently bound events on the portal",[464,472,473,476,477,480,481,480,484,487],{},[467,474,475],{},"bind"," — register a target URL as a handler for ",[467,478,479],{},"ONCRMDEALADD",", ",[467,482,483],{},"ONCRMDEALUPDATE",[467,485,486],{},"ONCRMDEALDELETE"," (idempotent — re-binding the same pair is a no-op)",[464,489,490,493],{},[467,491,492],{},"unbind"," — remove those bindings",[457,495,496],{},"Run it once after deploying your handler; re-run on every config change.",[452,498,500],{"id":499},"stack","Stack",[457,502,503],{},"Node.js 18+. No external dependencies.",[452,505,507],{"id":506},"environment","Environment",[509,510,515],"pre",{"className":511,"code":512,"language":513,"meta":514,"style":514},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","export B24_HOOK='https:\u002F\u002Fyour.bitrix24.com\u002Frest\u002F1\u002Fsecret'\nexport HANDLER_URL='https:\u002F\u002Fyour-server.example.com\u002Fwebhook'   # required for bind\u002Funbind\n","bash","",[467,516,517,544],{"__ignoreMap":514},[518,519,522,526,530,534,537,541],"span",{"class":520,"line":521},"line",1,[518,523,525],{"class":524},"spNyl","export",[518,527,529],{"class":528},"sTEyZ"," B24_HOOK",[518,531,533],{"class":532},"sMK4o","=",[518,535,536],{"class":532},"'",[518,538,540],{"class":539},"sfazB","https:\u002F\u002Fyour.bitrix24.com\u002Frest\u002F1\u002Fsecret",[518,542,543],{"class":532},"'\n",[518,545,547,549,552,554,556,559,561],{"class":520,"line":546},2,[518,548,525],{"class":524},[518,550,551],{"class":528}," HANDLER_URL",[518,553,533],{"class":532},[518,555,536],{"class":532},[518,557,558],{"class":539},"https:\u002F\u002Fyour-server.example.com\u002Fwebhook",[518,560,536],{"class":532},[518,562,564],{"class":563},"sHwdD","   # required for bind\u002Funbind\n",[452,566,568],{"id":567},"run","Run",[509,570,572],{"className":511,"code":571,"language":513,"meta":514,"style":514},"npx tsx 11-event-registration.ts list\nnpx tsx 11-event-registration.ts bind\nnpx tsx 11-event-registration.ts unbind\n",[467,573,574,589,600],{"__ignoreMap":514},[518,575,576,580,583,586],{"class":520,"line":521},[518,577,579],{"class":578},"sBMFI","npx",[518,581,582],{"class":539}," tsx",[518,584,585],{"class":539}," 11-event-registration.ts",[518,587,588],{"class":539}," list\n",[518,590,591,593,595,597],{"class":520,"line":546},[518,592,579],{"class":578},[518,594,582],{"class":539},[518,596,585],{"class":539},[518,598,599],{"class":539}," bind\n",[518,601,603,605,607,609],{"class":520,"line":602},3,[518,604,579],{"class":578},[518,606,582],{"class":539},[518,608,585],{"class":539},[518,610,611],{"class":539}," unbind\n",[452,613,615],{"id":614},"source","Source",[457,617,618,627],{},[619,620,624],"a",{"href":621,"rel":622},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fskills\u002Fb24jssdk-recipes\u002Fexamples\u002F11-event-registration.ts",[623],"nofollow",[467,625,626],{},"skills\u002Fb24jssdk-recipes\u002Fexamples\u002F11-event-registration.ts",".",[452,629,631],{"id":630},"notes","Notes",[461,633,634,644,650,660],{},[464,635,636,639,640,643],{},[467,637,638],{},"event.bind"," returns the code ",[467,641,642],{},"ERROR_EVENT_BINDING_EXISTS"," if the same (event, handler) pair is already bound — the recipe treats this as success for idempotent runs.",[464,645,646,649],{},[467,647,648],{},"event.unbind"," raises if the binding doesn't exist; the recipe logs and continues.",[464,651,652,653,655,656,659],{},"The webhook used to call ",[467,654,638],{}," must have the ",[467,657,658],{},"event"," scope (it does for incoming webhooks created from the portal admin UI).",[464,661,662,663,665,666,668],{},"For OAuth-installed apps, the equivalent of ",[467,664,638],{}," is binding events at the application level via the dev console or ",[467,667,638],{}," with the app's auth.",[670,671,672],"style",{},"html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}",{"title":514,"searchDepth":546,"depth":546,"links":674},[675,676,677,678,679,680],{"id":454,"depth":546,"text":455},{"id":499,"depth":546,"text":500},{"id":506,"depth":546,"text":507},{"id":567,"depth":546,"text":568},{"id":614,"depth":546,"text":615},{"id":630,"depth":546,"text":631},"md",[683],{"label":684,"iconName":685,"to":621},"Source on GitHub","GitHubIcon",{},{"title":366},{"title":447,"description":369},"YkkoA_qrkdQuWK9SHaz2Y9O4oa35_LF18wy4lkhHBHA",{"data":691,"body":692},{},{"type":693,"children":694},"root",[695],{"type":696,"tag":457,"props":697,"children":698},"element",{},[699],{"type":700,"value":369},"text",1780384105359]