ClaudeCode.Message.SystemMessage.HookStarted (ClaudeCode v0.36.3)

View Source

Represents a hook started system message from the Claude CLI.

Emitted when a hook begins execution.

Fields

  • :type - Always :system
  • :subtype - Always :hook_started
  • :session_id - Session identifier
  • :uuid - Message UUID
  • :hook_id - Unique identifier for this hook execution
  • :hook_name - Name of the hook being executed
  • :hook_event - Event that triggered the hook

JSON Format

{
  "type": "system",
  "subtype": "hook_started",
  "session_id": "...",
  "uuid": "...",
  "hook_id": "hook_abc123",
  "hook_name": "my_hook",
  "hook_event": "on_tool_start"
}

Summary

Types

t()

Functions

hook_started?(arg1)

Type guard to check if a value is a HookStarted.

new(json)

Creates a new HookStarted from JSON data.

Types

t()

@type t() :: %ClaudeCode.Message.SystemMessage.HookStarted{
  hook_event: String.t(),
  hook_id: String.t(),
  hook_name: String.t(),
  session_id: String.t(),
  subtype: :hook_started,
  type: :system,
  uuid: String.t() | nil
}

Functions

hook_started?(arg1)

@spec hook_started?(any()) :: boolean()

Type guard to check if a value is a HookStarted.

new(json)

@spec new(map()) :: {:ok, t()} | {:error, atom()}

Creates a new HookStarted from JSON data.

Examples

iex> HookStarted.new(%{
...>   "type" => "system",
...>   "subtype" => "hook_started",
...>   "session_id" => "session-1",
...>   "hook_id" => "hook_abc",
...>   "hook_name" => "my_hook",
...>   "hook_event" => "on_tool_start"
...> })
{:ok, %HookStarted{type: :system, subtype: :hook_started, ...}}

iex> HookStarted.new(%{"type" => "assistant"})
{:error, :invalid_message_type}