{"id":27689467,"url":"https://github.com/sendbird/sendbird-platform-sdk-javascript","last_synced_at":"2026-01-05T09:11:17.483Z","repository":{"id":40467382,"uuid":"426768793","full_name":"sendbird/sendbird-platform-sdk-javascript","owner":"sendbird","description":"Sendbird Platform API JavaScript SDK","archived":false,"fork":false,"pushed_at":"2025-07-27T02:31:22.000Z","size":2817,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":20,"default_branch":"main","last_synced_at":"2025-10-04T11:56:26.383Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sendbird.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-11-10T20:35:14.000Z","updated_at":"2025-07-08T01:47:45.000Z","dependencies_parsed_at":"2025-06-16T07:39:07.987Z","dependency_job_id":"0cfed3b1-5cc6-4275-b0f9-69217d92a9d2","html_url":"https://github.com/sendbird/sendbird-platform-sdk-javascript","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/sendbird/sendbird-platform-sdk-javascript","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sendbird%2Fsendbird-platform-sdk-javascript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sendbird%2Fsendbird-platform-sdk-javascript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sendbird%2Fsendbird-platform-sdk-javascript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sendbird%2Fsendbird-platform-sdk-javascript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sendbird","download_url":"https://codeload.github.com/sendbird/sendbird-platform-sdk-javascript/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sendbird%2Fsendbird-platform-sdk-javascript/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278308623,"owners_count":25965654,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-04-25T10:11:12.735Z","updated_at":"2026-01-05T09:11:17.477Z","avatar_url":"https://github.com/sendbird.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Sendbird banner image](http://ww1.prweb.com/prfiles/2021/09/14/18371217/Sendbird_Logo_RGB_lg.png)\n\n# [Sendbird JavaScript Platform SDK](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api)\n\n[![link to docs](https://img.shields.io/badge/SDK-docs-green)](/docs)\n[![NPM](https://img.shields.io/npm/v/sendbird-platform-sdk.svg)](https://www.npmjs.com/package/sendbird-platform-sdk)\n\nThis is a Node.js package that makes talking to the [Sendbird Platform API](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) easier. With this library you can extend your Sendbird integration to include advanced features like channel automation and user management.\n\n\u003e__Note__: Platform API SDK v2 includes only the APIs that were actively used in v1. If you need help getting started with the new SDK, [contact us](https://dashboard.sendbird.com/settings/contact_us).\n\n# Install\n```npm install @sendbird/sendbird-platform-sdk-javascript```\n\n# 🔥 Quick start\n\n```javascript  \nimport SendbirdPlatformSdk from '@sendbird/sendbird-platform-sdk-javascript';\n\nconst userId = \"1234\";\nconst name = \"bob\";\nconst profileUrl = \"https://picsum.photos/200\";\nconst apiToken = \"YOUR_API_TOKEN\";\nconst appId = \"YOUR_APP_ID\";\n\nconst opts = {\n  createAUserRequest: new SendbirdPlatformSdk.CreateAUserRequest(\n    userId,\n    name,\n    profileUrl\n  ),\n};\n\nasync function createUser() {\n  const userApiInstance = new SendbirdPlatformSdk.UserApi();\n  userApiInstance.apiClient.basePath = `https://api-${appId}.sendbird.com`;\n  try {\n    const data = await userApiInstance.createAUser({apiToken, ...opts});\n    console.log(data);\n  } catch (e) {\n    console.log(e);\n  }\n}\n\ncreateUser();\n\n```\n\n# ⚒️ Prerequisite\n\nIn order to make requests with this SDK you will need you master API token. This can be found through the [Sendbird dashboard](https://dashboard.sendbird.com/).  Each app you create in Sendbird has its own master api token. These tokens can be found in Settings \u003e Application \u003e General.\n\n![how to find you api token](https://i.imgur.com/0YMKtpX.png)\n\n# 💻 Requirements\n\nYou will need [Node.js](https://nodejs.org/en/download/) installed. This has been developed and tested with NodeJS 17+.\n\n\n# 📦 Installation\n\nYou can install the SDK directly from npm:\n```\n# Using npm\nnpm install @sendbird/sendbird-platform-sdk-javascript\n\n# Using yarn\nyarn add @sendbird/sendbird-platform-sdk-javascript\n```\n\u003e ⚠️ This SDK is intended for use in server-side environments only. Do not use it in browsers or frontend applications.\n\n# 🤓 Local Development\n\nTo run locally we need to make use of the [npm link](https://docs.npmjs.com/cli/v8/commands/npm-link) command. You will require two terminal tabs.\n\nPlease follow these steps:\n\n##### Terminal 1\n\n1. Clone this repo to your machine  ```git clone git@github.com:sendbird/sendbird-platform-sdk-javascript```\n2. Move into the newly cloned repo  ```cd sendbird-platform-sdk-javascript```\n3. Install node modules  ```npm install```\n4. Build the bundled JS   ```npm run build```\n5. Link the package   ```npm link```\n\n##### Terminal 2\n\n1. Create a new npm package or move into and existing one  ```mkdir app-using-sendbird-chat```\n```npm init -y```\n2. Link package to sendbird-platform-sdk ```npm link path/to/sdk/sendbird-platform-sdk-javascript```\n\nThe linking step is demonstrated visually here.\n\n![npm link walkthrough](https://i.imgur.com/897SxfC.gif)\n\n\n# 🗃️ Documentation \nAll the documentation for this project lives in the /docs directory of this repo. \n\n##### Helpful links\n\n|       | Documentation |\n| ----------- | ----------- |\n| Announcement   | [docs/AnnouncementApi.md](docs/AnnouncementApi.md)|\n| Bot | [docs/BotApi.md](docs/BotApi.md)  |\n| GroupChannel | [docs/GroupChannelApi.md](docs/GroupChannelApi.md)  |\n| Message | [docs/MessageApi.md](docs/MessageApi.md)  |\n| OpenChannel | [docs/OpenChannelApi.md ](docs/OpenChannelApi.md)  |\n| User | [docs/UserApi.md](docs/UserApi.md)  |\n| Moderation | [docs/ModerationApi.md](docs/ModerationApi.md)  |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsendbird%2Fsendbird-platform-sdk-javascript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsendbird%2Fsendbird-platform-sdk-javascript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsendbird%2Fsendbird-platform-sdk-javascript/lists"}