API Reference - Bitrix24 JS SDK

This is the index of every value @bitrix24/b24jssdk exports publicly — the classes, enums, constants and functions you can import and use at runtime — grouped by domain. Each entry says what the export is and links to its guide and its source. Pure type and interface exports are not listed here; they have their own page, the Types overview.

It deliberately does not restate signatures and parameter tables: those live in the guides, where they are audited against the source and their snippets are compiled in CI. This page is the map, not the territory. Per-symbol reference pages are a separate, later layer — tracked in #315.

New here? Start with Get Started and pick an entry point below — that choice determines everything else.

Entry points

Pick by where your code runs — this is the first decision, and everything else follows from it.

Export	What it is	Guide
`B24Hook`	Server-side webhook auth. Carries a long-lived secret — never ship it to a browser.	guide
`B24Frame`	An app running inside a Bitrix24 placement iframe.	guide
`initializeB24Frame`	The only correct way to construct a `B24Frame` — performs the parent handshake.	guide
`B24OAuth`	A marketplace/OAuth app, authenticated per portal with a refresh token. Server-side only, like `B24Hook` — never ship the client secret to a browser.	guide
`AbstractB24`	The shared base the three entry points extend — where the deprecated `b24.callMethod()`-style shortcuts live.	guide
`AuthHookManager`	Auth actions behind `B24Hook`.	guide
`AuthOAuthManager`	Auth actions behind `B24OAuth`, including token refresh.	guide

Actions — calling the REST API

The $b24.actions.v{2,3}.* surface. v2 and v3 are different dialects, not versions of one thing.

Export	What it is	Guide
`versionManager`	Routes a method to the v2 or v3 transport.	—
`ApiVersion`	The `restApi:v2` / `restApi:v3` discriminator.	guide
`HttpV2`	The v2 transport.	guide
`HttpV3`	The v3 transport.	guide
`FilterV3`	Typed builder for the v3 array-of-triples filter grammar.	guide
`BatchRefV3`	`$ref` / `$refArray` markers for v3 batch cross-command substitution.	guide

Results and errors

Every call returns a Result; failures split into soft (returned) and hard (thrown).

Export	What it is	Guide
`AjaxResult`	The response wrapper — `isSuccess`, `getData()`, `getErrorMessages()`.	guide
`Result`	The base result type.	guide
`AjaxError`	A transport-level error, with credentials redacted from `requestInfo`.	guide
`SdkError`	An SDK error carrying a stable `code` to discriminate on.	guide

Rate limiting

The limiter stack that keeps the SDK inside the portal's request budget.

Export	What it is	Guide
`RestrictionManager`	Owns the limiter stack and the retry policy.	guide
`ParamsFactory`	Preset limiter configurations (`getDefault()`, `getBatchProcessing()`).	guide
`RateLimiter`	Request-rate limiter.	guide
`OperatingLimiter`	Honours the portal's `operating` budget.	guide
`AdaptiveDelayer`	Backoff between retries.	guide

Realtime — Pull

Push notifications from the portal.

Export	What it is	Guide
`B24PullClientManager`	The Pull client.	guide
`PullStatus`	Connection status values.	guide
`SubscriptionType`	Subscription kinds.	guide
`ConnectionType`	Transport used by the client.	guide
`CloseReasons`	Why a connection closed.	—

Frame managers

Available on a B24Frame instance — the portal-side UI surface.

Export	What it is	Guide
`ParentManager`	`$b24.parent` — control the iframe inside the portal layout.	guide
`SliderManager`	`$b24.slider` — open paths and app pages in a slider.	guide
`PlacementManager`	`$b24.placement` — the context the user opened the app from.	guide
`DialogManager`	`$b24.dialog` — pick users, CRM entities, access targets.	guide
`OptionsManager`	`$b24.options` — persist app and per-user settings.	guide
`AuthManager`	`$b24.auth` — the frame's auth actions.	guide
`MessageManager`	The `postMessage` bridge to the parent window, reachable as `$b24.parent.message`.	—

Helper

Aggregated portal state — profile, app, licence, currency.

Export	What it is	Guide
`useB24Helper`	Composable that initialises and exposes the helper.	guide
`LoadDataType`	Which data sets the helper loads.	guide
`EnumAppStatus`	Application status values.	guide
`TypeSpecificUrl`	Portal URLs the helper resolves.	guide
`StatusDescriptions`	Human-readable app-status descriptions.	guide
`TypeOption`	The value-type discriminator `$b24.options` stores settings under.	guide

Logging

Monolog-style logging. Logger.log() never throws and never rejects.

Export	What it is	Guide
`LoggerFactory`	Build a configured logger — start here.	guide
`Logger`	The logger implementation.	guide
`AbstractLogger`	Base class implementing the level convenience methods.	guide
`NullLogger`	No-op logger; the SDK's default.	guide
`LogLevel`	Severity levels, DEBUG through EMERGENCY.	guide
`ConsoleHandler`	Writes to the browser console.	guide
`ConsoleV2Handler`	Improved console handler.	guide
`MemoryHandler`	Keeps records in memory — useful in tests.	guide
`StreamHandler`	Writes to a Node stream.	guide
`TelegramHandler`	Sends records to a Telegram chat.	guide
`ConsolaAdapter`	Bridges to Consola.	guide
`WinstonAdapter`	Bridges to Winston.	guide
`LineFormatter`	Formats a record as a line.	guide
`JsonFormatter`	Formats a record as JSON.	guide
`TelegramFormatter`	Formats a record for Telegram HTML.	guide
`memoryUsageProcessor`	Adds memory usage to a record.	guide
`pidProcessor`	Adds the process id to a record.	guide

Tools

Small utilities the SDK uses and re-exports.

Export	What it is	Guide
`Type`	Runtime type guards.	guide
`Text`	String, id and date helpers.	guide
`Browser`	Browser and platform detection.	guide
`useFormatter`	Number and date formatting.	guide
`Environment`	Where the code is running.	guide
`getEnvironment`	Resolve the current environment.	guide
`omit`	Object helper — drop keys.	guide
`pick`	Object helper — keep keys.	guide
`isArrayOfArray`	Array shape guard.	guide
`getEnumValue`	Enum lookup helper.	guide
`B24LangList`	Supported portal languages.	guide
`B24LocaleMap`	Locale mapping.	guide

Domain types

Typed shapes for the portal's own entities.

Export	What it is	Guide
`EnumCrmEntityTypeId`	CRM entity type ids.	guide
`DataType`	Generic data-type discriminator.	guide
`CatalogProductType`	Catalog product types.	—
`ProductRowDiscountTypeId`	Discount types on a product row.	—
`EnumBizprocDocumentType`	Business-process document types.	—
`getDocumentType`	Build a bizproc document type.	—
`getDocumentId`	Build a bizproc document id.	—

Everything else

Also exported, and reachable from the groups above or from the guides — listed so this page stays a complete index of the public surface:

AppFrame CatalogProductImageType CatalogRoundingRuleType EnumBitrix24Edition EnumBizprocBaseType EnumCrmEntityType EnumCrmEntityTypeShort ListRpcError LoggerBrowser LoggerType LsKeys MessageCommands RefreshTokenError RpcMethod SenderType ServerMode SystemCommands convertBizprocDocumentTypeToCrmEntityTypeId getDocumentTypeForFilter getEnumCrmEntityTypeShort

Not yet covered by a guide

These exports are public but have no deep-dive page of their own yet. They are listed here rather than quietly omitted, so the gap is a visible, closable list instead of something a reader discovers by failing to find it:

AppFrame CatalogProductImageType CatalogProductType CatalogRoundingRuleType CloseReasons EnumBitrix24Edition EnumBizprocBaseType EnumBizprocDocumentType EnumCrmEntityType EnumCrmEntityTypeShort ListRpcError LoggerBrowser LoggerType LsKeys MessageCommands MessageManager ProductRowDiscountTypeId RpcMethod SenderType ServerMode SystemCommands convertBizprocDocumentTypeToCrmEntityTypeId getDocumentId getDocumentType getDocumentTypeForFilter getEnumCrmEntityTypeShort versionManager

Most are enums and type namespaces whose meaning is evident from the source linked above. If you needed one of these and the source was not enough, that is worth an issue — it tells us which page to write next.