Channel App SDK
Official TypeScript and Go SDKs, developer guides, and runnable examples for building Channel apps.
Building your first Channel app?
Start with the first-app Quickstart in Korean,
English, or Japanese.
It takes you from creating a private app through running a Command, React WAM, and bot/manager
message flows.
Choose Your Path
The localized guide indexes provide the same map in
Korean, English, and
Japanese.
Recommended Documentation Order
Start with the Quickstart before reading package references. Continue in this order when you need
to customize or ship the app:
- Build and run the first app: Korean,
English, or Japanese
- Learn Function, Extension, WAM, and authentication boundaries:
Korean, English, or
Japanese
- Define typed app Functions and understand the wire contract: Korean,
English, or Japanese
- Implement Command metadata, actions, and autocomplete:
Korean,
English, or
Japanese
- Build the WAM React UI and host-authorized calls:
Korean, English, or
The Quickstart ends with this same reading map. The guides and public SDK exports define the current
contract; the tutorials show it as complete server-and-WAM apps.
SDKs and Runnable Examples
TypeScript
Use the TypeScript packages for a NestJS app server, typed Functions, Extension metadata, token and
signature handling, React WAM hooks, and WAM UI components.
Go
Use github.com/channel-io/app-sdk/go for a Go app server, typed Functions, Extension builders,
token and signature handling, and native calls. A Go app can use the same TypeScript/React WAM SDK
for its frontend.
Contributing to the SDK
The commands below are for developing this SDK repository. App projects should follow the
Quickstart and their selected tutorial instead.
Repository layout
proto/: shared SDK contractsgo/: Go SDK modulets/: TypeScript SDK workspace and npm packagesdocs/guides/: app developer guides in Korean, English, and Japanesedocs/reference/: protocol and language-specific SDK referencesskills/build-channel-app/: reusable coding-agent workflow
Install, build, and test
make install
make lint
make build
make test
make verify
Language-specific targets include make build-ts, make test-go, make lint-go, and
make proto-lint.
Pull requests and releases
Before opening a pull request, run the relevant checks above. When changing protocol definitions or
generated schemas, commit the generated files and run:
make proto-check
TypeScript package releases are managed with Changesets. Add a changeset for a user-visible package
change:
cd ts
pnpm changeset
Do not edit package versions or changelog release sections by hand. The release workflow creates a
release pull request and publishes npm packages when that pull request is merged.
The Go SDK is released separately with module tags such as go/v0.1.0. Keep the module path as
github.com/channel-io/app-sdk/go.
Because this repository is public, pull requests, commit messages, changelogs, fixtures,
screenshots, and generated files must not include private service URLs, credentials, tokens,
customer data, private repository names, internal task IDs, or organization-specific UUIDs.
Authors and reviewers are responsible for this full policy. CI detects known private identifiers
and internal task IDs with scripts/check-public-content.sh and scans secret patterns with
Gitleaks. Report suspected vulnerabilities privately as described in SECURITY.md.
Reference Index
- Guide indexes: Korean, English,
Japanese
- Agent guide
- Build Channel App skill
- TypeScript: reference map and
package overview
- Go: overview,
Functions and schemas,
server and routing,
authentication and tokens,
Extensions,
native Functions, and
WAM integration
- Shared wire contract: cross-language protocol
- Localized WAM guides: , ,
and
License
MIT
