Sendbird Platform SDK (TypeScript)

0.0.18 verified Fri May 01 auth: no javascript

OpenAPI-generated TypeScript client for the Sendbird Platform API. Current stable version is 2.1.6, released as a minor/patch cadence. Supports all platform endpoints (users, channels, messages, bots, metadata, push preferences) with full TypeScript types and fetch-based HTTP. Key differentiators: auto-generated from official OpenAPI spec, object-form function calls since v2.0.0 (breaking change from v1), nullable type support, and weekly DND schedules in push preferences.

Common errors

error Cannot find module 'sendbird-platform-sdk-typescript' ↓

cause Package not installed or import path incorrect.

fix

Run 'npm install sendbird-platform-sdk-typescript' and ensure import is correct: 'import { SendbirdPlatformSDK } from "sendbird-platform-sdk-typescript"'.

error TypeError: sdk.user.listUsers is not a function ↓

cause Using v1 syntax (positional arguments) on v2.

fix

Update to object form: sdk.user.listUsers({}) or check version-specific docs.

Warnings

breaking v2.0.0 changed function calls to require object form for all parameters. ↓

fix Update all function calls to pass an options object instead of positional arguments.

gotcha SDK uses fetch which may not be available in older Node.js versions (<18). ↓

fix Use Node.js >=18 or provide a fetch polyfill.

gotcha Type definitions may not match actual API response shape for nullable fields. ↓

fix Upgrade to >=2.1.1 which improved nullable type handling.

Install

npm install sendbird-platform-sdk-typescript

yarn add sendbird-platform-sdk-typescript

pnpm add sendbird-platform-sdk-typescript

Imports

SendbirdPlatformSDK

wrong

const SendbirdPlatformSDK = require('sendbird-platform-sdk-typescript')

correct

import { SendbirdPlatformSDK } from 'sendbird-platform-sdk-typescript'

SDK is ESM-only, default export is not available. Use named import.

createUser

wrong

import createUser from 'sendbird-platform-sdk-typescript'

correct

import { createUser } from 'sendbird-platform-sdk-typescript'

All functions are named exports from the package root.

SendbirdPlatformSDKType

wrong

import { SendbirdPlatformSDKType } from 'sendbird-platform-sdk-typescript'

correct

import type { SendbirdPlatformSDKType } from 'sendbird-platform-sdk-typescript'

Type imports should use `import type` to avoid runtime overhead.

Quickstart

Initializes the SDK with appId and apiToken from environment variables, then lists users.

import { SendbirdPlatformSDK } from 'sendbird-platform-sdk-typescript';

const sdk = new SendbirdPlatformSDK({
  appId: process.env.SENDBIRD_APP_ID ?? '',
  apiToken: process.env.SENDBIRD_API_TOKEN ?? '',
});

async function main() {
  const { users } = await sdk.user.listUsers();
  console.log(users);
}

main().catch(console.error);