Описание
b24jssdk-skills — семь официальных скиллов Битрикс24 для JavaScript/TypeScript SDK: выбор способа подключения — когда брать B24Hook, когда B24Frame, а когда полный B24OAuth, REST-вызовы и фильтры — синтаксис, лимиты и пагинация, обработка ошибок и токенов — без типовых подводных камней интеграции. Для разработчиков приложений и виджетов, которые хотят писать против официального SDK, а не сырого REST.
Что умеет:
— выбирать способ подключения к порталу;
— строить REST-вызовы с фильтрами;
— обрабатывать ошибки и токены;
— давать семь тематических скиллов под задачу.
Полная документация ниже — автоматически из репозитория bitrix24/b24jssdk (ветка main). Оригинальные материалы проекта распространяются на условиях его лицензии.
@bitrix24/b24jssdk
JavaScript/TypeScript SDK for the Bitrix24 REST API. Supports three usage scenarios:
- B24Frame — iframe apps embedded in the Bitrix24 interface (uses the current user’s token automatically)
- B24Hook — server-side apps using a permanent webhook token
- B24OAuth — server-side apps using OAuth 2.0 with token refresh
Installation
pnpm add @bitrix24/b24jssdk
For Nuxt projects:
pnpm add @bitrix24/b24jssdk-nuxt
Quick Start
B24Frame (iframe app)
import { initializeB24Frame } from '@bitrix24/b24jssdk'
const $b24 = await initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'user.current',
requestId: 'get-current-user'
})
if (response.isSuccess) {
console.log(response.getData())
}
$b24.destroy()
B24Hook (server webhook)
import { B24Hook } from '@bitrix24/b24jssdk'
const $b24 = B24Hook.fromWebhookUrl(process.env.B24_HOOK!)
const response = await $b24.actions.v2.call.make({
method: 'user.current',
requestId: 'get-current-user'
})
if (response.isSuccess) {
console.log(response.getData())
}
$b24.destroy()
B24OAuth (OAuth app)
import { B24OAuth } from '@bitrix24/b24jssdk'
const $b24 = new B24OAuth(tokenData, appCredentials)
const response = await $b24.actions.v2.call.make({
method: 'user.current',
requestId: 'get-current-user'
})
if (response.isSuccess) {
console.log(response.getData())
}
$b24.destroy()
Documentation
Full documentation: https://bitrix24.github.io/b24jssdk/
Contributing
See AGENTS.md for contributor and AI agent guidance.
Security
Found a vulnerability? Please report it privately —
see SECURITY.md, which also explains what belongs here and what
belongs to Bitrix24 itself.
Changelog
See CHANGELOG.md.