{"id":27657048,"url":"https://github.com/sendbird/sendbird-platform-sdk-typescript","last_synced_at":"2026-04-02T18:54:34.861Z","repository":{"id":63667103,"uuid":"447994114","full_name":"sendbird/sendbird-platform-sdk-typescript","owner":"sendbird","description":"Sendbird Typescript SDK for the server to server API","archived":false,"fork":false,"pushed_at":"2025-04-15T01:09:20.000Z","size":12862,"stargazers_count":10,"open_issues_count":12,"forks_count":9,"subscribers_count":20,"default_branch":"main","last_synced_at":"2025-04-20T04:08:53.766Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2022-01-14T14:23:33.000Z","updated_at":"2024-09-24T07:54:53.000Z","dependencies_parsed_at":"2025-04-08T02:33:46.130Z","dependency_job_id":"39900f24-3460-45b7-bcd2-2d13372ddcba","html_url":"https://github.com/sendbird/sendbird-platform-sdk-typescript","commit_stats":{"total_commits":21,"total_committers":7,"mean_commits":3.0,"dds":"0.47619047619047616","last_synced_commit":"3a22286893b61d29631eed746258e02f46e11a3c"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sendbird%2Fsendbird-platform-sdk-typescript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sendbird%2Fsendbird-platform-sdk-typescript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sendbird%2Fsendbird-platform-sdk-typescript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sendbird%2Fsendbird-platform-sdk-typescript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sendbird","download_url":"https://codeload.github.com/sendbird/sendbird-platform-sdk-typescript/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250544287,"owners_count":21448067,"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","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-24T06:53:41.490Z","updated_at":"2026-01-05T09:11:39.575Z","avatar_url":"https://github.com/sendbird.png","language":"TypeScript","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 Typescript 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)\nThis is a Node.js package written in Typescript  that makes talking to the [Sendbird Platform API](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) easier.\nWith this library you can extend your Sendbird integration to include advanced features like message-, and channel automation, user management, create user authentication tokens, and create bots.\n\n# 🔥 Quick start\n\n```javascript  \nimport * as sendbird from 'sendbird-platform-sdk-typescript';\nconst APP_ID = \"YOUR_APP_ID_FROM_DASHBOARD\";\nconst API_TOKEN = \"YOUR_MASTER_API_TOKEN_FROM_DASHBOARD\";\nconst serverConfig = new sendbird.ServerConfiguration(\"https://api-{app_id}.sendbird.com\", { \"app_id\": APP_ID })\nconst configuration = sendbird.createConfiguration({ baseServer : serverConfig });\nconst userAPI = new sendbird.UserApi(configuration);\n// List users, use the next token in the response to get the next page of users in subsequent requests\nuserAPI.listUsers(API_TOKEN, '', 10).then((users) =\u003e {\n    console.log(\"Listing first 10 users:\\n\")\n    console.log(users)\n}).catch((error) =\u003e {\n    console.log(\"Error listing users\")\n    console.log(error)\n})\n// How to create a user\nconst userData: sendbird.CreateUserData = {\n    userId: \"bob_smith\",\n    nickname: \"Bob\",\n    profileUrl: \"https://cataas.com/c\"\n}\nuserAPI.createUser(API_TOKEN, userData).then((user) =\u003e {\n    console.log(\"User created:\\n\")\n    console.log(user)\n}).catch((error) =\u003e {\n    console.log(\"Error creating user:\")\n    console.log(error)\n})\n```\n\n# ⚠️ Warnings\n\n 1. This package is not currently in npm. Please see  the Local development section for installation instructions.\n 2. This library is intended for server to server requests. **Do not use in a browser environment**. This SDK uses the Master API Token, which should never be exposed to the outside world like in a webpage or app.\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![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# ⚙️ Installation\n\n🚨 Package not yet in npm 🚨\n```npm install sendbird-platform-sdk-typescript```\n\n# 🤓 Local Development\n\n 1. Clone the repository\n 2. cd to the `sendbird-platform-sdk-typescript` directory\n 3. run `npm install`\n 4. cd to your project directory\n 5. run `npm install /path/to/sendbird-platform-sdk-typescript --save`\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   | [AnnouncementApi.md](AnnouncementApi.md)|\n| Bot | [BotApi.md](BotApi.md)  |\n| GroupChannel | [GroupChannelApi.md](GroupChannelApi.md)  |\n| Message | [MessageApi.md](MessageApi.md)  |\n| OpenChannel | [OpenChannelApi.md ](OpenChannelApi.md)  |\n| User | [UserApi.md](UserApi.md)  |\n| Moderation | [ModerationApi.md](ModerationApi.md)  |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsendbird%2Fsendbird-platform-sdk-typescript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsendbird%2Fsendbird-platform-sdk-typescript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsendbird%2Fsendbird-platform-sdk-typescript/lists"}