Category
App
Getting Started (Tutorial)
This document is maintained with the Channel App SDK. Check the SDK README first for current packages and the complete reading order. The source of truth for this Document is the GitHub source. Build Your First Channel App Follow this page from creating a development private app through running the /tutorial Command, React WAM, and bot/manager message flows. Choose either TypeScript or Go for the server. Both paths use the official SDK and public tutorial repository instead of implementing token
Concepts
This document is maintained with the Channel App SDK. Check the SDK README first for current packages and the complete reading order. The source of truth for this Document is the GitHub source. Concepts A Channel app consists of a server that executes Functions and, when needed, a web UI built as a WAM. Extensions connect related Functions to standard Channel capabilities, while AppStore defines the call, registration, and authorization boundaries. Channel client → AppStore → signed PUT /functioFunction Registration
This document is maintained with the Channel App SDK. Check the SDK README first for current packages and the complete reading order. The source of truth for this Document is the GitHub source. Function Registration A Function is a typed RPC that Channel or another app sends to an app server. The request method is the full Function name and params is its input. Register app-owned Functions as standalone names such as orders.get; standard Extension Functions combine an Extension name with a relatCommand Guide
This document is maintained with the Channel App SDK. Check the SDK README first for current packages and the complete reading order. The source of truth for this Document is the GitHub source. Command Guide The Command Extension lets a user or manager run app capabilities from Channel's desk/front command UI. Command metadata defines presentation and input; a typed Function referenced by the metadata performs the action. Current contract Function or field Required Role extension.command.metadatWAM Guide
This document is maintained with the Channel App SDK. Check the SDK README first for current packages and the complete reading order. The source of truth for this Document is the GitHub source. WAM Guide A WAM (Web App Module) is a React web UI opened inside a Channel client. It is not an app server and does not store server credentials. Use it for Extension actions that need user interaction, such as commands, widgets, and custom tabs. Open a WAM from an action The Channel client opens a WAM whExtension Guide
This document is maintained with the Channel App SDK. Check the SDK README first for current packages and the complete reading order. The source of truth for this Document is the GitHub source. Extension Guide What an Extension is An Extension is a named, versioned contract that connects typed app Functions to a standard Channel capability. Channel surfaces know how to discover and invoke a command, widget, custom tab, hook, OAuth flow, or other capability because the app implements that ExtensiProduction Readiness Guide
This document is maintained with the Channel App SDK. Check the SDK README first for current packages and the complete reading order. The source of truth for this Document is the GitHub source. Production Readiness Guide Use this guide after the app works end to end in an installed test Channel. It is not required to finish the first-app Quickstart. Its purpose is to turn a working Function, Extension, and optional WAM into a release that can be deployed, rolled back, observed, and operated safe