Struct TaskStartedMessage 

pub struct TaskStartedMessage {

    pub session_id: String,
    pub task_id: String,
    pub task_type: Option<TaskType>,
    pub tool_use_id: Option<String>,
    pub description: String,
    pub subagent_type: Option<String>,
    pub is_backgrounded: Option<bool>,
    pub spawn_depth: Option<u32>,
    pub prompt: Option<String>,
    pub workflow_name: Option<String>,
    pub skip_transcript: Option<bool>,
    pub ambient: Option<bool>,
    pub uuid: String,
}

task_started system message — emitted once when a background task begins.

Fields

session_id: String

task_id: String

task_type: Option<TaskType>

tool_use_id: Option<String>

description: String

subagent_type: Option<String>

The subagent type for local_agent tasks (e.g. general-purpose, Explore). Absent for local_bash tasks.

is_backgrounded: Option<bool>

Whether the task was registered in the background (true) or in the foreground with the spawning tool call blocking on it (false). A later move to the background arrives as task_updated patch.is_backgrounded. Set for local_agent and local_bash tasks (CLI 2.1.239+).

spawn_depth: Option<u32>

Nesting depth of a spawned subagent (local_agent) task: 1 for a top-level spawn, N+1 when spawned from inside a depth-N agent. Not set on other tasks (CLI 2.1.239+).

prompt: Option<String>

The prompt handed to the subagent. Present for local_agent tasks.

workflow_name: Option<String>

skip_transcript: Option<bool>

ambient: Option<bool>

True for housekeeping tasks the CLI does not surface as user work (every skip_transcript task, plus auto-started live-update watchers); hosts should exclude them from activity indicators (CLI 2.1.259+).

uuid: String

Trait Implementations

impl Clone for TaskStartedMessage

fn clone(&self) -> TaskStartedMessage

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TaskStartedMessage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TaskStartedMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TaskStartedMessage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.