Skip to main content

Basic Usage

Signature

Function Builder

Configuration Options

Required Properties

Optional Properties

Source Types

Webhook

App Event

Agent Completion

Job Completion

Service

Channels with service source use onConnect() / onDisconnect() lifecycle hooks and pushIncoming() for feeding incoming events.

File Watcher

Manual

No automatic wiring. Push programmatically via scope.channelNotifications.send().

ChannelNotification Type

The return type of onEvent():
Meta keys must be valid identifiers: letters, digits, and underscores only. Keys like my-env or 123start will fail validation.

Two-Way Channels

When twoWay: true, implement onReply() to handle responses from Claude:
The channel-reply tool is auto-registered with this input schema:

Server Configuration

Enable channels at the server level: