HookStartPayload

Payload for “hook_start” events — a host lifecycle hook is beginning.

Class Diagram

---
title: HookStartPayload
config:
  look: handDrawn
  theme: colorful
  class:
    hideEmptyMembersBox: true
---
classDiagram
    class HookStartPayload {
        +string hookInvocationId
        +string hookType
        +string scope
        +dictionary input
        +RedactionMetadata redaction
    }
    class RedactionMetadata {
        +boolean sanitized
        +RedactedField[] fields
        +string policy
    }
    HookStartPayload *-- RedactionMetadata

Yaml Example

hookInvocationId: hook_abc123
hookType: preToolUse

Properties

Name	Type	Description
hookInvocationId	string	Stable hook invocation identifier
hookType	string	Host-defined hook type
scope	string	Whether the hook is scoped to a turn or the outer session
input	dictionary	Hook input after host-side sanitization
redaction	RedactionMetadata	Redaction state for sensitive hook input fields

Composed Types

The following types are composed within HookStartPayload:

• RedactionMetadata