TaskFlow
DashboardFreewriteWhiteboardsProjectsCRMTasksNotificationsSettingsAgent TowerAPI Docs
OpenClaw Docs
?

User

Member

Caricamento in corso...

Home
Progetti
Task
Notifiche
CRM

    OpenClaw

    Documentation Mirror

    Documentation Overview

    Docs

    Auth credential semantics
    Scheduled tasks
    Hooks
    Automation & tasks
    Standing orders
    Task flow
    Background tasks
    BlueBubbles
    Broadcast groups
    Channel routing
    Discord
    Feishu
    Google Chat
    Group messages
    Groups
    iMessage
    Chat channels
    IRC
    LINE
    Channel location parsing
    Matrix
    Matrix migration
    Matrix push rules for quiet previews
    Mattermost
    Microsoft Teams
    Nextcloud Talk
    Nostr
    Pairing
    QA channel
    QQ bot
    Signal
    Slack
    Synology Chat
    Telegram
    Tlon
    Channel troubleshooting
    Twitch
    WeChat
    WhatsApp
    Yuanbao
    Zalo
    Zalo personal
    CI pipeline
    ACP
    Agent
    Agents
    Approvals
    Backup
    Browser
    Channels
    Clawbot
    `openclaw commitments`
    Completion
    Config
    Configure
    Cron
    Daemon
    Dashboard
    Devices
    Directory
    DNS
    Docs
    Doctor
    Flows (redirect)
    Gateway
    Health
    Hooks
    CLI reference
    Inference CLI
    Logs
    MCP
    Memory
    Message
    Migrate
    Models
    Node
    Nodes
    Onboard
    Pairing
    Plugins
    Proxy
    QR
    Reset
    Sandbox CLI
    Secrets
    Security
    Sessions
    Setup
    Skills
    Status
    System
    `openclaw tasks`
    TUI
    Uninstall
    Update
    Voicecall
    Webhooks
    Wiki
    Active memory
    Agent runtime
    Agent loop
    Agent runtimes
    Agent workspace
    Gateway architecture
    Channel docking
    Inferred commitments
    Compaction
    Context
    Context engine
    Delegate architecture
    Dreaming
    Experimental features
    Features
    Markdown formatting
    Memory overview
    Builtin memory engine
    Honcho memory
    QMD memory engine
    Memory search
    Messages
    Model failover
    Model providers
    Models CLI
    Multi-agent routing
    OAuth
    OpenClaw App SDK
    Presence
    QA overview
    Matrix QA
    Command queue
    Steering queue
    Retry policy
    Session management
    Session pruning
    Session tools
    SOUL.md personality guide
    Streaming and chunking
    System prompt
    Timezones
    TypeBox
    Typing indicators
    Usage tracking
    Date and time
    Node + tsx crash
    Diagnostics flags
    Authentication
    Background exec and process tool
    Bonjour discovery
    Bridge protocol
    CLI backends
    Configuration — agents
    Configuration — channels
    Configuration — tools and custom providers
    Configuration
    Configuration examples
    Configuration reference
    Diagnostics export
    Discovery and transports
    Doctor
    Gateway lock
    Health checks
    Heartbeat
    Gateway runbook
    Local models
    Gateway logging
    Multiple gateways
    Network model
    OpenAI chat completions
    OpenResponses API
    OpenShell
    OpenTelemetry export
    Gateway-owned pairing
    Prometheus metrics
    Gateway protocol
    Remote access
    Remote gateway setup
    Sandbox vs tool policy vs elevated
    Sandboxing
    Secrets management
    Secrets apply plan contract
    Security audit checks
    Security
    Tailscale
    Tools invoke API
    Troubleshooting
    Trusted proxy auth
    Debugging
    Environment variables
    FAQ
    FAQ: first-run setup
    FAQ: models and auth
    GPT-5.5 / Codex agentic parity
    GPT-5.5 / Codex parity maintainer notes
    Help
    Scripts
    Testing
    Testing: live suites
    General troubleshooting
    OpenClaw
    Ansible
    Azure
    Bun (experimental)
    ClawDock
    Release channels
    DigitalOcean
    Docker
    Docker VM runtime
    exe.dev
    Fly.io
    GCP
    Hetzner
    Hostinger
    Install
    Installer internals
    Kubernetes
    macOS VMs
    Migration guide
    Migrating from Claude
    Migrating from Hermes
    Nix
    Node.js
    Northflank
    Oracle Cloud
    Podman
    Railway
    Raspberry Pi
    Render
    Uninstall
    Updating
    Logging
    Network
    Audio and voice notes
    Camera capture
    Image and media support
    Nodes
    Location command
    Media understanding
    Talk mode
    Node troubleshooting
    Voice wake
    Pi integration architecture
    Pi development workflow
    Android app
    Platforms
    iOS app
    Linux app
    Gateway on macOS
    Canvas
    Gateway lifecycle
    macOS dev setup
    Health checks (macOS)
    Menu bar icon
    macOS logging
    Menu bar
    Peekaboo bridge
    macOS permissions
    Remote control
    macOS signing
    Skills (macOS)
    Voice overlay
    Voice wake (macOS)
    WebChat (macOS)
    macOS IPC
    macOS app
    Windows
    Plugin internals
    Plugin architecture internals
    Building plugins
    Plugin bundles
    Codex Computer Use
    Codex harness
    Community plugins
    Plugin compatibility
    Google Meet plugin
    Plugin hooks
    Plugin manifest
    Memory LanceDB
    Memory wiki
    Message presentation
    Agent harness plugins
    Building channel plugins
    Channel turn kernel
    Plugin entry points
    Plugin SDK migration
    Plugin SDK overview
    Building provider plugins
    Plugin runtime helpers
    Plugin setup and config
    Plugin SDK subpaths
    Plugin testing
    Skill workshop plugin
    Voice call plugin
    Webhooks plugin
    Zalo personal plugin
    OpenProse
    Alibaba Model Studio
    Anthropic
    Arcee AI
    Azure Speech
    Amazon Bedrock
    Amazon Bedrock Mantle
    Chutes
    Claude Max API proxy
    Cloudflare AI gateway
    ComfyUI
    Deepgram
    Deepinfra
    DeepSeek
    ElevenLabs
    Fal
    Fireworks
    GitHub Copilot
    GLM (Zhipu)
    Google (Gemini)
    Gradium
    Groq
    Hugging Face (inference)
    Provider directory
    Inferrs
    Inworld
    Kilocode
    LiteLLM
    LM Studio
    MiniMax
    Mistral
    Model provider quickstart
    Moonshot AI
    NVIDIA
    Ollama
    OpenAI
    OpenCode
    OpenCode Go
    OpenRouter
    Perplexity
    Qianfan
    Qwen
    Runway
    SGLang
    StepFun
    Synthetic
    Tencent Cloud (TokenHub)
    Together AI
    Venice AI
    Vercel AI gateway
    vLLM
    Volcengine (Doubao)
    Vydra
    xAI
    Xiaomi MiMo
    Z.AI
    Default AGENTS.md
    Release policy
    API usage and costs
    Credits
    Device model database
    Full release validation
    Memory configuration reference
    OpenClaw App SDK API design
    Prompt caching
    Rich output protocol
    RPC adapters
    SecretRef credential surface
    Session management deep dive
    AGENTS.md template
    BOOT.md template
    BOOTSTRAP.md template
    HEARTBEAT.md template
    IDENTITY template
    SOUL.md template
    TOOLS.md template
    USER template
    Tests
    Token use and costs
    Transcript hygiene
    Onboarding reference
    Contributing to the threat model
    Threat model (MITRE ATLAS)
    Formal verification (security models)
    Network proxy
    Agent bootstrapping
    Docs directory
    Getting started
    Docs hubs
    OpenClaw lore
    Onboarding (macOS app)
    Onboarding overview
    Personal assistant setup
    Setup
    Showcase
    Onboarding (CLI)
    CLI automation
    CLI setup reference
    ACP agents
    ACP agents — setup
    Agent send
    apply_patch tool
    Brave search
    Browser (OpenClaw-managed)
    Browser control API
    Browser troubleshooting
    Browser login
    WSL2 + Windows + remote Chrome CDP troubleshooting
    BTW side questions
    ClawHub
    Code execution
    Creating skills
    Diffs
    DuckDuckGo search
    Elevated mode
    Exa search
    Exec tool
    Exec approvals
    Exec approvals — advanced
    Firecrawl
    Gemini search
    Grok search
    Image generation
    Tools and plugins
    Kimi search
    LLM task
    Lobster
    Tool-loop detection
    Media overview
    MiniMax search
    Multi-agent sandbox and tools
    Music generation
    Ollama web search
    PDF tool
    Perplexity search
    Plugins
    Reactions
    SearXNG search
    Skills
    Skills config
    Slash commands
    Sub-agents
    Tavily
    Thinking levels
    Tokenjuice
    Trajectory bundles
    Text-to-speech
    Video generation
    Web search
    Web fetch
    Linux server
    Control UI
    Dashboard
    Web
    TUI
    WebChat

    OpenAPI Specs

    openapi
    TaskFlow
    docs/openclaw
    Original Docs

    Real-time Synchronized Documentation

    Last sync: 01/05/2026 07:01:51

    Note: This content is mirrored from docs.openclaw.ai and is subject to their terms and conditions.

    OpenClaw Docs

    v2.4.0 Production

    Last synced: Today, 22:00

    Technical reference for the OpenClaw framework. Real-time synchronization with the official documentation engine.

    Use this file to discover all available pages before exploring further.

    Message presentation

    Message presentation is OpenClaw's shared contract for rich outbound chat UI. It lets agents, CLI commands, approval flows, and plugins describe the message intent once, while each channel plugin renders the best native shape it can.

    Use presentation for portable message UI:

    • text sections
    • small context/footer text
    • dividers
    • buttons
    • select menus
    • card title and tone

    Do not add new provider-native fields such as Discord

    text
    components
    , Slack
    text
    blocks
    , Telegram
    text
    buttons
    , Teams
    text
    card
    , or Feishu
    text
    card
    to the shared message tool. Those are renderer outputs owned by the channel plugin.

    Contract

    Plugin authors import the public contract from:

    ts
    import type { MessagePresentation, ReplyPayloadDelivery, } from "openclaw/plugin-sdk/interactive-runtime";

    Shape:

    ts
    type MessagePresentation = { title?: string; tone?: "neutral" | "info" | "success" | "warning" | "danger"; blocks: MessagePresentationBlock[]; }; type MessagePresentationBlock = | { type: "text"; text: string } | { type: "context"; text: string } | { type: "divider" } | { type: "buttons"; buttons: MessagePresentationButton[] } | { type: "select"; placeholder?: string; options: MessagePresentationOption[] }; type MessagePresentationButton = { label: string; value?: string; url?: string; style?: "primary" | "secondary" | "success" | "danger"; }; type MessagePresentationOption = { label: string; value: string; }; type ReplyPayloadDelivery = { pin?: | boolean | { enabled: boolean; notify?: boolean; required?: boolean; }; };

    Button semantics:

    • text
      value
      is an application action value routed back through the channel's existing interaction path when the channel supports clickable controls.
    • text
      url
      is a link button. It can exist without
      text
      value
      .
    • text
      label
      is required and is also used in text fallback.
    • text
      style
      is advisory. Renderers should map unsupported styles to a safe default, not fail the send.

    Select semantics:

    • text
      options[].value
      is the selected application value.
    • text
      placeholder
      is advisory and may be ignored by channels without native select support.
    • If a channel does not support selects, fallback text lists the labels.

    Producer examples

    Simple card:

    json
    { "title": "Deploy approval", "tone": "warning", "blocks": [ { "type": "text", "text": "Canary is ready to promote." }, { "type": "context", "text": "Build 1234, staging passed." }, { "type": "buttons", "buttons": [ { "label": "Approve", "value": "deploy:approve", "style": "success" }, { "label": "Decline", "value": "deploy:decline", "style": "danger" } ] } ] }

    URL-only link button:

    json
    { "blocks": [ { "type": "text", "text": "Release notes are ready." }, { "type": "buttons", "buttons": [{ "label": "Open notes", "url": "https://example.com/release" }] } ] }

    Select menu:

    json
    { "title": "Choose environment", "blocks": [ { "type": "select", "placeholder": "Environment", "options": [ { "label": "Canary", "value": "env:canary" }, { "label": "Production", "value": "env:prod" } ] } ] }

    CLI send:

    bash
    openclaw message send --channel slack \ --target channel:C123 \ --message "Deploy approval" \ --presentation '{"title":"Deploy approval","tone":"warning","blocks":[{"type":"text","text":"Canary is ready."},{"type":"buttons","buttons":[{"label":"Approve","value":"deploy:approve","style":"success"},{"label":"Decline","value":"deploy:decline","style":"danger"}]}]}'

    Pinned delivery:

    bash
    openclaw message send --channel telegram \ --target -1001234567890 \ --message "Topic opened" \ --pin

    Pinned delivery with explicit JSON:

    json
    { "pin": { "enabled": true, "notify": true, "required": false } }

    Renderer contract

    Channel plugins declare render support on their outbound adapter:

    ts
    const adapter: ChannelOutboundAdapter = { deliveryMode: "direct", presentationCapabilities: { supported: true, buttons: true, selects: true, context: true, divider: true, }, deliveryCapabilities: { pin: true, }, renderPresentation({ payload, presentation, ctx }) { return renderNativePayload(payload, presentation, ctx); }, async pinDeliveredMessage({ target, messageId, pin }) { await pinNativeMessage(target, messageId, { notify: pin.notify === true }); }, };

    Capability fields are intentionally simple booleans. They describe what the renderer can make interactive, not every native platform limit. Renderers still own platform-specific limits such as maximum button count, block count, and card size.

    Core render flow

    When a

    text
    ReplyPayload
    or message action includes
    text
    presentation
    , core:

    1. Normalizes the presentation payload.
    2. Resolves the target channel's outbound adapter.
    3. Reads
      text
      presentationCapabilities
      .
    4. Calls
      text
      renderPresentation
      when the adapter can render the payload.
    5. Falls back to conservative text when the adapter is absent or cannot render.
    6. Sends the resulting payload through the normal channel delivery path.
    7. Applies delivery metadata such as
      text
      delivery.pin
      after the first successful sent message.

    Core owns fallback behavior so producers can stay channel-agnostic. Channel plugins own native rendering and interaction handling.

    Degradation rules

    Presentation must be safe to send on limited channels.

    Fallback text includes:

    • text
      title
      as the first line
    • text
      text
      blocks as normal paragraphs
    • text
      context
      blocks as compact context lines
    • text
      divider
      blocks as a visual separator
    • button labels, including URLs for link buttons
    • select option labels

    Unsupported native controls should degrade rather than fail the whole send. Examples:

    • Telegram with inline buttons disabled sends text fallback.
    • A channel without select support lists select options as text.
    • A URL-only button becomes either a native link button or a fallback URL line.
    • Optional pin failures do not fail the delivered message.

    The main exception is

    text
    delivery.pin.required: true
    ; if pinning is requested as required and the channel cannot pin the sent message, delivery reports failure.

    Provider mapping

    Current bundled renderers:

    ChannelNative render targetNotes
    DiscordComponents and component containersPreserves legacy
    text
    channelData.discord.components
    for existing provider-native payload producers, but new shared sends should use
    text
    presentation
    .
    SlackBlock KitPreserves legacy
    text
    channelData.slack.blocks
    for existing provider-native payload producers, but new shared sends should use
    text
    presentation
    .
    TelegramText plus inline keyboardsButtons/selects require inline button capability for the target surface; otherwise text fallback is used.
    MattermostText plus interactive propsOther blocks degrade to text.
    Microsoft TeamsAdaptive CardsPlain
    text
    message
    text is included with the card when both are provided.
    FeishuInteractive cardsCard header can use
    text
    title
    ; body avoids duplicating that title.
    Plain channelsText fallbackChannels without a renderer still get readable output.

    Provider-native payload compatibility is a transition affordance for existing reply producers. It is not a reason to add new shared native fields.

    Presentation vs InteractiveReply

    text
    InteractiveReply
    is the older internal subset used by approval and interaction helpers. It supports:

    • text
    • buttons
    • selects

    text
    MessagePresentation
    is the canonical shared send contract. It adds:

    • title
    • tone
    • context
    • divider
    • URL-only buttons
    • generic delivery metadata through
      text
      ReplyPayload.delivery

    Use helpers from

    text
    openclaw/plugin-sdk/interactive-runtime
    when bridging older code:

    ts
    import { interactiveReplyToPresentation, normalizeMessagePresentation, presentationToInteractiveReply, renderMessagePresentationFallbackText, } from "openclaw/plugin-sdk/interactive-runtime";

    New code should accept or produce

    text
    MessagePresentation
    directly.

    Delivery pin

    Pinning is delivery behavior, not presentation. Use

    text
    delivery.pin
    instead of provider-native fields such as
    text
    channelData.telegram.pin
    .

    Semantics:

    • text
      pin: true
      pins the first successfully delivered message.
    • text
      pin.notify
      defaults to
      text
      false
      .
    • text
      pin.required
      defaults to
      text
      false
      .
    • Optional pin failures degrade and leave the sent message intact.
    • Required pin failures fail delivery.
    • Chunked messages pin the first delivered chunk, not the tail chunk.

    Manual

    text
    pin
    ,
    text
    unpin
    , and
    text
    pins
    message actions still exist for existing messages where the provider supports those operations.

    Plugin author checklist

    • Declare
      text
      presentation
      from
      text
      describeMessageTool(...)
      when the channel can render or safely degrade semantic presentation.
    • Add
      text
      presentationCapabilities
      to the runtime outbound adapter.
    • Implement
      text
      renderPresentation
      in runtime code, not control-plane plugin setup code.
    • Keep native UI libraries out of hot setup/catalog paths.
    • Preserve platform limits in the renderer and tests.
    • Add fallback tests for unsupported buttons, selects, URL buttons, title/text duplication, and mixed
      text
      message
      plus
      text
      presentation
      sends.
    • Add delivery pin support through
      text
      deliveryCapabilities.pin
      and
      text
      pinDeliveredMessage
      only when the provider can pin the sent message id.
    • Do not expose new provider-native card/block/component/button fields through the shared message action schema.

    Related docs

    • Message CLI
    • Plugin SDK Overview
    • Plugin Architecture
    • Channel Presentation Refactor Plan

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine