Channels
Connect Channel
Connect a channel to an instance by providing its configuration.
POST
Connects a channel to the instance. What happens next depends on the channel’s connection type:
- Token-based channels (like Discord or Telegram): provide the required credentials in
configand the channel connects immediately. - Interactive channels (like WhatsApp): the connection starts a pairing flow. You’ll get back QR data to scan, and the status will be
"awaiting_scan"until the user completes the process.
openclaw.json and restarts the gateway.
Authentication
Requires an org-level API key or a scoped token with thechannels permission.
Path Parameters
Body Parameters
A key-value map of configuration fields for this channel. Use the channel info endpoint to discover which fields are required. For interactive channels, you can optionally provide extra config.
Response
Either
"connected" (channel is live) or "awaiting_scan" (interactive channels waiting for user action).