Skip to content

compozy ch send

Send one task-run coordination message

For people running agent work5 pages in this section

compozy ch send

Send one task-run coordination message

compozy ch send <channel> [flags]

Examples

  # Send a non-authoritative status message for a run
  compozy ch send coord-run-123 \
    --task-id task-123 \
    --run-id run-123 \
    --kind status \
    --correlation-id run-123 \
    --body '{"status":"investigating"}'

  # Report a blocker in the same task-bound channel
  compozy ch send coord-run-123 \
    --task-id task-123 \
    --run-id run-123 \
    --kind blocker \
    --correlation-id run-123 \
		--body '{"blocked_by":"missing credentials"}'

Options

      --body string              Raw JSON body for the channel message
      --channel-id string        Channel id; defaults to channel
      --correlation-id string    Correlation id; defaults to run id
  -h, --help                     help for send
      --idempotency-key string   Optional idempotency key/message id
      --kind string              Coordination message kind (default "status")
      --metadata-ext string      Optional JSON object for coordination metadata ext
      --run-id string            Run id for coordination metadata
      --task-id string           Task id for coordination metadata
      --workflow-id string       Workflow id for coordination metadata

Options inherited from parent commands

      --json            Emit JSON output
  -o, --output string   Output format: human, json, jsonl, or toon (default "human")

Output Formats

The root -o, --output flag accepts these values. A renderer is supported only when this command writes that result; jsonl is for commands that emit one JSON record per line.

FormatCommand result
humanInteractive terminal rendering
jsonMachine-readable JSON rendering
jsonlOne JSON record per line when supported
toonCompact agent-readable rendering

Example:

compozy ch send <channel> -o json

On this page