hooks

package

Go to main page

Versions in this module

v0

v0.0.9

Jul 4, 2026

Changes in this version

type HookEvent

+ const HookTaskBlocked

+ const HookTaskNeedsAttention

+ const HookTaskRecovered

+ const HookTaskUnblocked

type HookEventFamily

+ const HookEventFamilyTask

type HookMatcher

+ func (m HookMatcher) MatchesTask(payload TaskContext) bool

type Hooks

+ func (h *Hooks) DispatchTaskBlocked(ctx context.Context, payload TaskBlockedPayload) (TaskBlockedPayload, error)

+ func (h *Hooks) DispatchTaskNeedsAttention(ctx context.Context, payload TaskNeedsAttentionPayload) (TaskNeedsAttentionPayload, error)

+ func (h *Hooks) DispatchTaskRecovered(ctx context.Context, payload TaskRecoveredPayload) (TaskRecoveredPayload, error)

+ func (h *Hooks) DispatchTaskUnblocked(ctx context.Context, payload TaskUnblockedPayload) (TaskUnblockedPayload, error)

+ type TaskAttentionPayload struct

+ At time.Time

+ Note string

+ Reason string

+ type TaskBlockPayload struct

+ BlockID string

+ ClearNote string

+ ClearedAt time.Time

+ Details json.RawMessage

+ Kind string

+ Reason string

+ type TaskBlockedPayload = TaskBlockPayload

+ type TaskContext struct

+ ActorID string

+ ActorKind string

+ AgentName string

+ ClaimTokenHash string

+ CoordinationChannelID string

+ NetworkChannel string

+ OriginKind string

+ OriginRef string

+ ReleaseReason string

+ RunID string

+ TaskID string

+ TaskStatus string

+ WorkflowID string

+ WorkspaceID string

+ type TaskNeedsAttentionPayload = TaskAttentionPayload

+ type TaskObservationPatch = AutonomyObservationPatch

+ type TaskRecoveredPayload = TaskAttentionPayload

+ type TaskUnblockedPayload = TaskBlockPayload

v0.0.8

Jun 22, 2026

v0.0.7

Jun 4, 2026

v0.0.6

Jun 3, 2026

v0.0.5

May 29, 2026

v0.0.4

May 27, 2026

v0.0.3

May 27, 2026

v0.0.2

May 27, 2026

v0.0.1

May 26, 2026

retracted

Changes in this version

+ var ErrAutomationFireCancelled = errors.New("hooks: automation fire canceled")

+ var ErrDispatchDepthExceeded = errors.New("hooks: dispatch depth exceeded")

+ var ErrExecutorResolverRequired = errors.New("hooks: executor resolver is required")

+ var ErrHookPatchRejected = errors.New("hooks: hook patch rejected")

+ var ErrInvalidHookExecutorKind = errors.New("hooks: invalid hook executor kind")

+ var ErrInvalidHookSource = errors.New("hooks: invalid hook source")

+ var ErrNativeCallbackRequired = errors.New("hooks: native executor callback is required")

+ var ErrNotImplemented = errors.New("hooks: executor not implemented")

+ var ErrPermissionEscalationBlocked = errors.New("hooks: permission escalation blocked")

+ var ErrSubprocessCommandRequired = errors.New("hooks: subprocess executor command is required")

+ func DefaultHookPriority(source HookSource) (int32, error)

+ func MatcherFieldAllowedForEvent(event HookEvent, field string) bool

+ func PriorityFromInt(value int) (int32, error)

+ func SortResolvedHooks(hooks []*ResolvedHook)

+ func TurnIDFromPayload(payload any) string

+ func ValidateHookDecl(decl HookDecl) error

+ func ValidateHookDecls(decls []HookDecl) error

+ func ValidateMatcherForEvent(event HookEvent, matcher HookMatcher) error

+ func WithDispatchEventEmitter(ctx context.Context, emitter DispatchEventEmitter) context.Context

+ func WithHookRunWriter(ctx context.Context, writer HookRunWriter) context.Context

+ type AgentCrashedPatch = AgentLifecyclePatch

+ type AgentCrashedPayload = AgentLifecyclePayload

+ type AgentHeartbeatPolicyResolvedPayload struct

+ Summary string

+ type AgentHeartbeatWakeAfterPayload struct

+ ConfigDigest string

+ PolicyDigest string

+ PolicySnapshotID string

+ Reason string

+ Result string

+ Source string

+ SyntheticPromptID string

+ WakeEventID string

+ type AgentHeartbeatWakeBeforePayload struct

+ ConfigDigest string

+ DryRun bool

+ PolicyDigest string

+ PolicySnapshotID string

+ Source string

+ type AgentLifecyclePatch struct

+ Labels map[string]string

+ type AgentLifecyclePayload struct

+ Args []string

+ Command string

+ Cwd string

+ Error string

+ Model string

+ PID int

+ Provider string

+ type AgentPreStartPayload struct

+ Args []string

+ Command string

+ Cwd string

+ Model string

+ Provider string

+ type AgentSoulMutationAfterPayload struct

+ Action string

+ NewDigest string

+ PreviousDigest string

+ RevisionID string

+ type AgentSoulSnapshotResolvedPayload struct

+ type AgentSpawnedPatch = AgentLifecyclePatch

+ type AgentSpawnedPayload = AgentLifecyclePayload

+ type AgentStartPatch struct

+ Args []string

+ Command *string

+ Cwd *string

+ type AgentStoppedPatch = AgentLifecyclePatch

+ type AgentStoppedPayload = AgentLifecyclePayload

+ type AuthoredContextObservationPatch = AutonomyObservationPatch

+ type AuthoredContextProvenance struct

+ Active bool

+ AgentName string

+ ConfigDigest string

+ Digest string

+ Reason string

+ SnapshotID string

+ SourcePath string

+ Valid bool

+ ValidationStatus string

+ WorkspaceID string

+ type AuthoredMutationProvenance struct

+ ActorID string

+ ActorKind string

+ OriginKind string

+ OriginRef string

+ type AutomationFirePatch struct

+ Cancel bool

+ Prompt *string

+ type AutomationJobPostFirePayload struct

+ AgentName string

+ JobID string

+ JobName string

+ RunID string

+ SessionID string

+ WorkspaceID string

+ type AutomationJobPreFirePayload struct

+ AgentName string

+ Attempt int

+ JobID string

+ JobName string

+ Payload map[string]any

+ Prompt string

+ Schedule *AutomationSchedulePayload

+ WorkspaceID string

+ type AutomationObservationPatch struct

+ type AutomationRunCompletedPayload struct

+ AgentName string

+ Attempt int

+ DurationMS int64

+ JobID string

+ RunID string

+ SessionID string

+ TriggerID string

+ WorkspaceID string

+ type AutomationRunFailedPayload struct

+ AgentName string

+ Attempt int

+ Error string

+ JobID string

+ RunID string

+ SessionID string

+ TriggerID string

+ WillRetry bool

+ WorkspaceID string

+ type AutomationSchedulePayload struct

+ Expr string

+ Interval string

+ Mode string

+ Time string

+ type AutomationTriggerPostFirePayload struct

+ AgentName string

+ Event string

+ RunID string

+ SessionID string

+ TriggerID string

+ TriggerName string

+ WorkspaceID string

+ type AutomationTriggerPreFirePayload struct

+ AgentName string

+ Attempt int

+ Event string

+ Payload map[string]any

+ Prompt string

+ TriggerID string

+ TriggerName string

+ WorkspaceID string

+ type AutonomyMatcher struct

+ ChildSessionID string

+ CoordinationChannelID string

+ CoordinatorSessionID string

+ ParentSessionID string

+ ReleaseReason string

+ RootSessionID string

+ RunID string

+ SpawnRole string

+ TaskID string

+ WorkflowID string

+ type AutonomyObservationPatch struct

+ Labels map[string]string

+ type BindingState struct

+ func (s *BindingState) HookCount() int

+ type CatalogEntry struct

+ Event HookEvent

+ ExecutorKind HookExecutorKind

+ Matcher HookMatcher

+ Metadata map[string]string

+ Mode HookMode

+ Name string

+ Order int

+ Priority int32

+ Required bool

+ SkillSource HookSkillSource

+ Source HookSource

+ Timeout time.Duration

+ type CatalogFilter struct

+ AgentName string

+ Event HookEvent

+ Mode HookMode

+ Source *HookSource

+ WorkspaceID string

+ WorkspaceRoot string

+ type CompactionMatcher struct

+ Reason string

+ Strategy string

+ type ContextBlock struct

+ Kind string

+ Metadata map[string]string

+ Text string

+ type ContextCompactPayload struct

+ ContextBlocks []ContextBlock

+ Reason string

+ Strategy string

+ Summary string

+ type ContextCompactionPatch struct

+ ContextBlocks []ContextBlock

+ Reason *string

+ Strategy *string

+ type ContextPostCompactPatch = ContextCompactionPatch

+ type ContextPostCompactPayload = ContextCompactPayload

+ type ContextPreCompactPatch = ContextCompactionPatch

+ type ContextPreCompactPayload = ContextCompactPayload

+ type ControlPatch struct

+ Deny bool

+ DenyReason string

+ type CoordinatorContext struct

+ AgentName string

+ CoordinationChannelID string

+ CoordinatorSessionID string

+ Model string

+ Provider string

+ RunID string

+ TaskID string

+ WorkflowID string

+ Workspace string

+ WorkspaceID string

+ type CoordinatorDecisionPayload = CoordinatorLifecyclePayload

+ type CoordinatorFailedPayload = CoordinatorLifecyclePayload

+ type CoordinatorLifecyclePayload struct

+ Decision string

+ DecisionKind string

+ Error string

+ StopReason string

+ type CoordinatorObservationPatch = AutonomyObservationPatch

+ type CoordinatorPreSpawnPayload struct

+ Denied bool

+ DenyReason string

+ Reason string

+ type CoordinatorSpawnPatch struct

+ AgentName *string

+ Model *string

+ Provider *string

+ type CoordinatorSpawnedPayload = CoordinatorLifecyclePayload

+ type CoordinatorStoppedPayload = CoordinatorLifecyclePayload

+ type DeclarationProvider func(context.Context) ([]HookDecl, error)

+ type DispatchCorrelation struct

+ ActorID string

+ ActorKind string

+ CoordinatorSessionID string

+ ReleaseReason string

+ RunID string

+ TaskID string

+ WorkflowID string

+ func CorrelationFromPayload(payload any) DispatchCorrelation

+ type DispatchEventEmitter interface

+ EmitHookDispatchEvent func(ctx context.Context, payload any, hook RegisteredHook, phase DispatchPhase, ...)

+ func DispatchEventEmitterFromContext(ctx context.Context) DispatchEventEmitter

+ type DispatchPhase string

+ const DispatchPhaseComplete

+ const DispatchPhaseStart

+ type EventDescriptor struct

+ Event HookEvent

+ Family HookEventFamily

+ PatchSchema string

+ PayloadSchema string

+ SyncEligible bool

+ func AllEventDescriptors() []EventDescriptor

+ func FilterEventDescriptors(filter EventFilter) []EventDescriptor

+ type EventFilter struct

+ Family HookEventFamily

+ SyncOnly bool

+ type EventPostRecordPatch = EventRecordPatch

+ type EventPostRecordPayload = EventRecordPayload

+ type EventPreRecordPatch = EventRecordPatch

+ type EventPreRecordPayload = EventRecordPayload

+ type EventRecordPatch struct

+ Labels map[string]string

+ type EventRecordPayload struct

+ Content json.RawMessage

+ RecordType string

+ Sequence int64

+ type Executor interface

+ Execute func(ctx context.Context, hook RegisteredHook, payload []byte) ([]byte, error)

+ Kind func() HookExecutorKind

+ type ExecutorResolver func(HookDecl) (Executor, error)

+ type HookDecl struct

+ Args []string

+ Command string

+ Enabled *bool

+ Env map[string]string

+ Event HookEvent

+ ExecutorKind HookExecutorKind

+ Matcher HookMatcher

+ Metadata map[string]string

+ Mode HookMode

+ Name string

+ Priority int32

+ PrioritySet bool

+ Required bool

+ SecretEnv map[string]string

+ SkillSource HookSkillSource

+ Source HookSource

+ Timeout time.Duration

+ WorkingDir string

+ func CanonicalizeHookDecl(decl HookDecl) (HookDecl, error)

+ func (d HookDecl) EnabledValue() bool

+ type HookEvent string

+ const HookAgentCrashed

+ const HookAgentHeartbeatPolicyResolved

+ const HookAgentHeartbeatWakeAfter

+ const HookAgentHeartbeatWakeBefore

+ const HookAgentPreStart

+ const HookAgentSoulMutationAfter

+ const HookAgentSoulSnapshotResolved

+ const HookAgentSpawned

+ const HookAgentStopped

+ const HookAutomationJobPostFire

+ const HookAutomationJobPreFire

+ const HookAutomationRunCompleted

+ const HookAutomationRunFailed

+ const HookAutomationTriggerPostFire

+ const HookAutomationTriggerPreFire

+ const HookContextPostCompact

+ const HookContextPreCompact

+ const HookCoordinatorDecision

+ const HookCoordinatorFailed

+ const HookCoordinatorPreSpawn

+ const HookCoordinatorSpawned

+ const HookCoordinatorStopped

+ const HookEventPostRecord

+ const HookEventPreRecord

+ const HookInputPreSubmit

+ const HookMessageDelta

+ const HookMessageEnd

+ const HookMessageStart

+ const HookNetworkDirectRoomOpened

+ const HookNetworkMessagePersisted

+ const HookNetworkPeerJoined

+ const HookNetworkPeerLeft

+ const HookNetworkThreadOpened

+ const HookNetworkWorkClosed

+ const HookNetworkWorkOpened

+ const HookNetworkWorkTransitioned

+ const HookPermissionDenied

+ const HookPermissionRequest

+ const HookPermissionResolved

+ const HookPromptPostAssemble

+ const HookSandboxPrepare

+ const HookSandboxReady

+ const HookSandboxStop

+ const HookSandboxSyncAfter

+ const HookSandboxSyncBefore

+ const HookSessionHealthUpdateAfter

+ const HookSessionMessagePersisted

+ const HookSessionPostCreate

+ const HookSessionPostResume

+ const HookSessionPostStop

+ const HookSessionPreCreate

+ const HookSessionPreResume

+ const HookSessionPreStop

+ const HookSpawnCreated

+ const HookSpawnParentStopped

+ const HookSpawnPreCreate

+ const HookSpawnReaped

+ const HookSpawnTTLExpired

+ const HookTaskRunCompleted

+ const HookTaskRunEnqueued

+ const HookTaskRunFailed

+ const HookTaskRunLeaseExpired

+ const HookTaskRunLeaseExtended

+ const HookTaskRunLeaseRecovered

+ const HookTaskRunPostClaim

+ const HookTaskRunPreClaim

+ const HookTaskRunReleased

+ const HookToolPostCall

+ const HookToolPostError

+ const HookToolPreCall

+ const HookTurnEnd

+ const HookTurnStart

+ func AllHookEvents() []HookEvent

+ func (e HookEvent) Family() HookEventFamily

+ func (e HookEvent) String() string

+ func (e HookEvent) SyncEligible() bool

+ func (e HookEvent) Validate() error

+ type HookEventFamily string

+ const HookEventFamilyAgent

+ const HookEventFamilyAutomation

+ const HookEventFamilyContext

+ const HookEventFamilyCoordinator

+ const HookEventFamilyEvent

+ const HookEventFamilyInput

+ const HookEventFamilyMessage

+ const HookEventFamilyNetwork

+ const HookEventFamilyPermission

+ const HookEventFamilyPrompt

+ const HookEventFamilySandbox

+ const HookEventFamilySession

+ const HookEventFamilySpawn

+ const HookEventFamilyTaskRun

+ const HookEventFamilyTool

+ const HookEventFamilyTurn

+ func (f HookEventFamily) Validate() error

+ type HookExecutorKind string

+ const HookExecutorNative

+ const HookExecutorSubprocess

+ const HookExecutorWASM

+ func (k HookExecutorKind) Validate() error

+ type HookMatcher struct

+ ACPEventType string

+ AgentName string

+ AgentType string

+ Autonomy *AutonomyMatcher

+ DecisionClass string

+ InputClass string

+ MessageDeltaType string

+ MessageRole string

+ SandboxBackend string

+ SandboxID string

+ SandboxProfile string

+ SessionType string

+ SyncDirection string

+ ToolID string

+ ToolName string

+ ToolReadOnly *bool

+ TurnID string

+ WorkspaceID string

+ WorkspaceRoot string

+ func (m HookMatcher) MatchesAgentLifecycle(payload AgentLifecyclePayload) bool

+ func (m HookMatcher) MatchesAgentPreStart(payload AgentPreStartPayload) bool

+ func (m HookMatcher) MatchesAutomation(agentName string, workspaceID string) bool

+ func (m HookMatcher) MatchesContextCompact(payload ContextCompactPayload) bool

+ func (m HookMatcher) MatchesCoordinator(payload CoordinatorContext) bool

+ func (m HookMatcher) MatchesEvent(payload EventRecordPayload) bool

+ func (m HookMatcher) MatchesInput(payload InputPreSubmitPayload) bool

+ func (m HookMatcher) MatchesMessage(payload MessagePayload) bool

+ func (m HookMatcher) MatchesNetwork(payload NetworkPayload) bool

+ func (m HookMatcher) MatchesPermissionRequest(payload PermissionRequestPayload) bool

+ func (m HookMatcher) MatchesPermissionResolution(payload PermissionResolutionPayload) bool

+ func (m HookMatcher) MatchesPrompt(payload PromptPayload) bool

+ func (m HookMatcher) MatchesSandboxPrepare(payload SandboxPreparePayload) bool

+ func (m HookMatcher) MatchesSandboxReady(payload SandboxReadyPayload) bool

+ func (m HookMatcher) MatchesSandboxStop(payload SandboxStopPayload) bool

+ func (m HookMatcher) MatchesSandboxSyncAfter(payload SandboxSyncAfterPayload) bool

+ func (m HookMatcher) MatchesSandboxSyncBefore(payload SandboxSyncBeforePayload) bool

+ func (m HookMatcher) MatchesSession(payload SessionContext) bool

+ func (m HookMatcher) MatchesSpawn(payload SpawnContext) bool

+ func (m HookMatcher) MatchesTaskRun(payload TaskRunContext) bool

+ func (m HookMatcher) MatchesToolPostCall(payload ToolPostCallPayload) bool

+ func (m HookMatcher) MatchesToolPostError(payload ToolPostErrorPayload) bool

+ func (m HookMatcher) MatchesToolPreCall(payload ToolPreCallPayload) bool

+ func (m HookMatcher) MatchesTurn(payload TurnPayload) bool

+ type HookMode string

+ const HookModeAsync

+ const HookModeSync

+ func (m HookMode) Validate() error

+ type HookRunOutcome string

+ const HookRunOutcomeApplied

+ const HookRunOutcomeDenied

+ const HookRunOutcomeDropped

+ const HookRunOutcomeFailed

+ const HookRunOutcomeRejected

+ const HookRunOutcomeSkipped

+ func (o HookRunOutcome) Validate() error

+ type HookRunRecord struct

+ DispatchDepth int

+ Duration time.Duration

+ Error string

+ Event HookEvent

+ HookName string

+ Mode HookMode

+ Outcome HookRunOutcome

+ PatchApplied json.RawMessage

+ RecordedAt time.Time

+ Required bool

+ Source HookSource

+ type HookRunWriter interface

+ RecordHookRun func(context.Context, HookRunRecord) error

+ func HookRunWriterFromContext(ctx context.Context) HookRunWriter

+ type HookSkillSource string

+ const HookSkillSourceAdditional

+ const HookSkillSourceBundled

+ const HookSkillSourceMarketplace

+ const HookSkillSourceUser

+ const HookSkillSourceWorkspace

+ func (s HookSkillSource) Validate() error

+ type HookSource uint8

+ const HookSourceAgentDefinition

+ const HookSourceConfig

+ const HookSourceNative

+ const HookSourceSkill

+ func (s *HookSource) UnmarshalText(text []byte) error

+ func (s HookSource) MarshalText() ([]byte, error)

+ func (s HookSource) String() string

+ func (s HookSource) Validate() error

+ type Hooks struct

+ func NewHooks(opts ...Option) *Hooks

+ func (h *Hooks) ApplyBindingState(state *BindingState, resourceRevision int64) error

+ func (h *Hooks) BuildBindingState(decls []HookDecl) (*BindingState, error)

+ func (h *Hooks) Catalog(filter CatalogFilter) ([]CatalogEntry, error)

+ func (h *Hooks) Close()

+ func (h *Hooks) DispatchAgentCrashed(ctx context.Context, payload AgentCrashedPayload) (AgentCrashedPayload, error)

+ func (h *Hooks) DispatchAgentHeartbeatPolicyResolved(ctx context.Context, payload AgentHeartbeatPolicyResolvedPayload) (AgentHeartbeatPolicyResolvedPayload, error)

+ func (h *Hooks) DispatchAgentHeartbeatWakeAfter(ctx context.Context, payload AgentHeartbeatWakeAfterPayload) (AgentHeartbeatWakeAfterPayload, error)

+ func (h *Hooks) DispatchAgentHeartbeatWakeBefore(ctx context.Context, payload AgentHeartbeatWakeBeforePayload) (AgentHeartbeatWakeBeforePayload, error)

+ func (h *Hooks) DispatchAgentPreStart(ctx context.Context, payload AgentPreStartPayload) (AgentPreStartPayload, error)

+ func (h *Hooks) DispatchAgentSoulMutationAfter(ctx context.Context, payload AgentSoulMutationAfterPayload) (AgentSoulMutationAfterPayload, error)

+ func (h *Hooks) DispatchAgentSoulSnapshotResolved(ctx context.Context, payload AgentSoulSnapshotResolvedPayload) (AgentSoulSnapshotResolvedPayload, error)

+ func (h *Hooks) DispatchAgentSpawned(ctx context.Context, payload AgentSpawnedPayload) (AgentSpawnedPayload, error)

+ func (h *Hooks) DispatchAgentStopped(ctx context.Context, payload AgentStoppedPayload) (AgentStoppedPayload, error)

+ func (h *Hooks) DispatchAutomationJobPostFire(ctx context.Context, payload AutomationJobPostFirePayload) (AutomationJobPostFirePayload, error)

+ func (h *Hooks) DispatchAutomationJobPreFire(ctx context.Context, payload AutomationJobPreFirePayload) (AutomationJobPreFirePayload, error)

+ func (h *Hooks) DispatchAutomationRunCompleted(ctx context.Context, payload AutomationRunCompletedPayload) (AutomationRunCompletedPayload, error)

+ func (h *Hooks) DispatchAutomationRunFailed(ctx context.Context, payload AutomationRunFailedPayload) (AutomationRunFailedPayload, error)

+ func (h *Hooks) DispatchAutomationTriggerPostFire(ctx context.Context, payload AutomationTriggerPostFirePayload) (AutomationTriggerPostFirePayload, error)

+ func (h *Hooks) DispatchAutomationTriggerPreFire(ctx context.Context, payload AutomationTriggerPreFirePayload) (AutomationTriggerPreFirePayload, error)

+ func (h *Hooks) DispatchContextPostCompact(ctx context.Context, payload ContextPostCompactPayload) (ContextPostCompactPayload, error)

+ func (h *Hooks) DispatchContextPreCompact(ctx context.Context, payload ContextPreCompactPayload) (ContextPreCompactPayload, error)

+ func (h *Hooks) DispatchCoordinatorDecision(ctx context.Context, payload CoordinatorDecisionPayload) (CoordinatorDecisionPayload, error)

+ func (h *Hooks) DispatchCoordinatorFailed(ctx context.Context, payload CoordinatorFailedPayload) (CoordinatorFailedPayload, error)

+ func (h *Hooks) DispatchCoordinatorPreSpawn(ctx context.Context, payload CoordinatorPreSpawnPayload) (CoordinatorPreSpawnPayload, error)

+ func (h *Hooks) DispatchCoordinatorSpawned(ctx context.Context, payload CoordinatorSpawnedPayload) (CoordinatorSpawnedPayload, error)

+ func (h *Hooks) DispatchCoordinatorStopped(ctx context.Context, payload CoordinatorStoppedPayload) (CoordinatorStoppedPayload, error)

+ func (h *Hooks) DispatchEventPostRecord(ctx context.Context, payload EventPostRecordPayload) (EventPostRecordPayload, error)

+ func (h *Hooks) DispatchEventPreRecord(ctx context.Context, payload EventPreRecordPayload) (EventPreRecordPayload, error)

+ func (h *Hooks) DispatchInputPreSubmit(ctx context.Context, payload InputPreSubmitPayload) (InputPreSubmitPayload, error)

+ func (h *Hooks) DispatchMessageDelta(ctx context.Context, payload MessageDeltaPayload) (MessageDeltaPayload, error)

+ func (h *Hooks) DispatchMessageEnd(ctx context.Context, payload MessageEndPayload) (MessageEndPayload, error)

+ func (h *Hooks) DispatchMessageStart(ctx context.Context, payload MessageStartPayload) (MessageStartPayload, error)

+ func (h *Hooks) DispatchNetworkDirectRoomOpened(ctx context.Context, payload NetworkDirectRoomOpenedPayload) (NetworkDirectRoomOpenedPayload, error)

+ func (h *Hooks) DispatchNetworkMessagePersisted(ctx context.Context, payload NetworkMessagePersistedPayload) (NetworkMessagePersistedPayload, error)

+ func (h *Hooks) DispatchNetworkPeerJoined(ctx context.Context, payload NetworkPeerJoinedPayload) (NetworkPeerJoinedPayload, error)

+ func (h *Hooks) DispatchNetworkPeerLeft(ctx context.Context, payload NetworkPeerLeftPayload) (NetworkPeerLeftPayload, error)

+ func (h *Hooks) DispatchNetworkThreadOpened(ctx context.Context, payload NetworkThreadOpenedPayload) (NetworkThreadOpenedPayload, error)

+ func (h *Hooks) DispatchNetworkWorkClosed(ctx context.Context, payload NetworkWorkClosedPayload) (NetworkWorkClosedPayload, error)

+ func (h *Hooks) DispatchNetworkWorkOpened(ctx context.Context, payload NetworkWorkOpenedPayload) (NetworkWorkOpenedPayload, error)

+ func (h *Hooks) DispatchNetworkWorkTransitioned(ctx context.Context, payload NetworkWorkTransitionedPayload) (NetworkWorkTransitionedPayload, error)

+ func (h *Hooks) DispatchPermissionDenied(ctx context.Context, payload PermissionDeniedPayload) (PermissionDeniedPayload, error)

+ func (h *Hooks) DispatchPermissionRequest(ctx context.Context, payload PermissionRequestPayload) (PermissionRequestPayload, error)

+ func (h *Hooks) DispatchPermissionResolved(ctx context.Context, payload PermissionResolvedPayload) (PermissionResolvedPayload, error)

+ func (h *Hooks) DispatchPromptPostAssemble(ctx context.Context, payload PromptPayload) (PromptPayload, error)

+ func (h *Hooks) DispatchSandboxPrepare(ctx context.Context, payload SandboxPreparePayload) (SandboxPreparePayload, error)

+ func (h *Hooks) DispatchSandboxReady(ctx context.Context, payload SandboxReadyPayload) (SandboxReadyPayload, error)

+ func (h *Hooks) DispatchSandboxStop(ctx context.Context, payload SandboxStopPayload) (SandboxStopPayload, error)

+ func (h *Hooks) DispatchSandboxSyncAfter(ctx context.Context, payload SandboxSyncAfterPayload) (SandboxSyncAfterPayload, error)

+ func (h *Hooks) DispatchSandboxSyncBefore(ctx context.Context, payload SandboxSyncBeforePayload) (SandboxSyncBeforePayload, error)

+ func (h *Hooks) DispatchSessionHealthUpdateAfter(ctx context.Context, payload SessionHealthUpdateAfterPayload) (SessionHealthUpdateAfterPayload, error)

+ func (h *Hooks) DispatchSessionMessagePersisted(ctx context.Context, payload SessionMessagePersistedPayload) (SessionMessagePersistedPayload, error)

+ func (h *Hooks) DispatchSessionPostCreate(ctx context.Context, payload SessionPostCreatePayload) (SessionPostCreatePayload, error)

+ func (h *Hooks) DispatchSessionPostResume(ctx context.Context, payload SessionPostResumePayload) (SessionPostResumePayload, error)

+ func (h *Hooks) DispatchSessionPostStop(ctx context.Context, payload SessionPostStopPayload) (SessionPostStopPayload, error)

+ func (h *Hooks) DispatchSessionPreCreate(ctx context.Context, payload SessionPreCreatePayload) (SessionPreCreatePayload, error)

+ func (h *Hooks) DispatchSessionPreResume(ctx context.Context, payload SessionPreResumePayload) (SessionPreResumePayload, error)

+ func (h *Hooks) DispatchSessionPreStop(ctx context.Context, payload SessionPreStopPayload) (SessionPreStopPayload, error)

+ func (h *Hooks) DispatchSpawnCreated(ctx context.Context, payload SpawnCreatedPayload) (SpawnCreatedPayload, error)

+ func (h *Hooks) DispatchSpawnParentStopped(ctx context.Context, payload SpawnParentStoppedPayload) (SpawnParentStoppedPayload, error)

+ func (h *Hooks) DispatchSpawnPreCreate(ctx context.Context, payload SpawnPreCreatePayload) (SpawnPreCreatePayload, error)

+ func (h *Hooks) DispatchSpawnReaped(ctx context.Context, payload SpawnReapedPayload) (SpawnReapedPayload, error)

+ func (h *Hooks) DispatchSpawnTTLExpired(ctx context.Context, payload SpawnTTLExpiredPayload) (SpawnTTLExpiredPayload, error)

+ func (h *Hooks) DispatchTaskRunCompleted(ctx context.Context, payload TaskRunCompletedPayload) (TaskRunCompletedPayload, error)

+ func (h *Hooks) DispatchTaskRunEnqueued(ctx context.Context, payload TaskRunEnqueuedPayload) (TaskRunEnqueuedPayload, error)

+ func (h *Hooks) DispatchTaskRunFailed(ctx context.Context, payload TaskRunFailedPayload) (TaskRunFailedPayload, error)

+ func (h *Hooks) DispatchTaskRunLeaseExpired(ctx context.Context, payload TaskRunLeaseExpiredPayload) (TaskRunLeaseExpiredPayload, error)

+ func (h *Hooks) DispatchTaskRunLeaseExtended(ctx context.Context, payload TaskRunLeaseExtendedPayload) (TaskRunLeaseExtendedPayload, error)

+ func (h *Hooks) DispatchTaskRunLeaseRecovered(ctx context.Context, payload TaskRunLeaseRecoveredPayload) (TaskRunLeaseRecoveredPayload, error)

+ func (h *Hooks) DispatchTaskRunPostClaim(ctx context.Context, payload TaskRunPostClaimPayload) (TaskRunPostClaimPayload, error)

+ func (h *Hooks) DispatchTaskRunPreClaim(ctx context.Context, payload TaskRunPreClaimPayload) (TaskRunPreClaimPayload, error)

+ func (h *Hooks) DispatchTaskRunReleased(ctx context.Context, payload TaskRunReleasedPayload) (TaskRunReleasedPayload, error)

+ func (h *Hooks) DispatchToolPostCall(ctx context.Context, payload ToolPostCallPayload) (ToolPostCallPayload, error)

+ func (h *Hooks) DispatchToolPostError(ctx context.Context, payload ToolPostErrorPayload) (ToolPostErrorPayload, error)

+ func (h *Hooks) DispatchToolPreCall(ctx context.Context, payload ToolPreCallPayload) (ToolPreCallPayload, error)

+ func (h *Hooks) DispatchTurnEnd(ctx context.Context, payload TurnEndPayload) (TurnEndPayload, error)

+ func (h *Hooks) DispatchTurnStart(ctx context.Context, payload TurnStartPayload) (TurnStartPayload, error)

+ func (h *Hooks) OnAgentEvent(_ context.Context, _ SessionContext, _ any)

+ func (h *Hooks) Rebuild(ctx context.Context) error

+ func (h *Hooks) Version() int64

+ type InputPreSubmitPatch struct

+ ContextBlocks []ContextBlock

+ Message *string

+ type InputPreSubmitPayload struct

+ ContextBlocks []ContextBlock

+ InputClass string

+ Message string

+ type MessageDeltaPatch = MessagePatch

+ type MessageDeltaPayload = MessagePayload

+ type MessageEndPatch = MessagePatch

+ type MessageEndPayload = MessagePayload

+ type MessagePatch struct

+ DeltaType *string

+ Role *string

+ Text *string

+ type MessagePayload struct

+ DeltaType string

+ MessageID string

+ Raw json.RawMessage

+ Role string

+ Text string

+ type MessageStartPatch = MessagePatch

+ type MessageStartPayload = MessagePayload

+ type NativeExecutor struct

+ func NewNativeExecutor(callback NativeHookFunc) *NativeExecutor

+ func (*NativeExecutor) Kind() HookExecutorKind

+ func (e *NativeExecutor) Execute(ctx context.Context, hook RegisteredHook, payload []byte) (result []byte, err error)

+ type NativeHookFunc func(ctx context.Context, hook RegisteredHook, payload []byte) ([]byte, error)

+ type NetworkDirectRoomOpenedPayload = NetworkPayload

+ type NetworkMatcher struct

+ Channel string

+ Direction string

+ Kind string

+ Surface string

+ WorkState string

+ type NetworkMessagePersistedPayload = NetworkPayload

+ type NetworkObservationPatch struct

+ Labels map[string]string

+ type NetworkPayload struct

+ CausationID string

+ Channel string

+ DirectID string

+ Direction string

+ Kind string

+ LastSeenAt *time.Time

+ MessageID string

+ PeerFrom string

+ PeerID string

+ PeerTo string

+ SessionID string

+ Surface string

+ ThreadID string

+ TraceID string

+ WorkID string

+ WorkState string

+ WorkspaceID string

+ type NetworkPeerJoinedPayload = NetworkPayload

+ type NetworkPeerLeftPayload = NetworkPayload

+ type NetworkThreadOpenedPayload = NetworkPayload

+ type NetworkWorkClosedPayload = NetworkPayload

+ type NetworkWorkOpenedPayload = NetworkPayload

+ type NetworkWorkTransitionedPayload = NetworkPayload

+ type Option func(*Hooks)

+ func WithAgentDeclarationProvider(provider DeclarationProvider) Option

+ func WithAgentDeclarations(decls []HookDecl) Option

+ func WithAsyncDrainTimeout(timeout time.Duration) Option

+ func WithAsyncQueueCapacity(capacity int) Option

+ func WithAsyncWorkerCount(count int) Option

+ func WithConfigDeclarationProvider(provider DeclarationProvider) Option

+ func WithConfigDeclarations(decls []HookDecl) Option

+ func WithDebugPatchAudit(enabled bool) Option

+ func WithExecutorResolver(resolve ExecutorResolver) Option

+ func WithLogger(logger *slog.Logger) Option

+ func WithNativeDeclarationProvider(provider DeclarationProvider) Option

+ func WithNativeDeclarations(decls []HookDecl) Option

+ func WithNow(now func() time.Time) Option

+ func WithSkillDeclarationProvider(provider DeclarationProvider) Option

+ func WithSkillDeclarations(decls []HookDecl) Option

+ func WithTelemetrySink(sink TelemetrySink) Option

+ type PayloadBase struct

+ Event HookEvent

+ Timestamp time.Time

+ type PermissionDeniedPatch struct

+ type PermissionDeniedPayload = PermissionResolutionPayload

+ type PermissionOption struct

+ Decision string

+ Kind string

+ Label string

+ OptionID string

+ type PermissionRequestPatch struct

+ Decision *string

+ DecisionClass *string

+ Reason *string

+ type PermissionRequestPayload struct

+ Action string

+ Decision string

+ DecisionClass string

+ Options []PermissionOption

+ RequestID string

+ Resource string

+ ToolCall PermissionToolCall

+ ToolInput json.RawMessage

+ type PermissionResolutionPayload struct

+ Action string

+ Decision string

+ DecisionClass string

+ RequestID string

+ Resource string

+ ToolCall PermissionToolCall

+ ToolInput json.RawMessage

+ type PermissionResolvedPatch struct

+ type PermissionResolvedPayload = PermissionResolutionPayload

+ type PermissionSet struct

+ MCPServers []string

+ NetworkChannels []string

+ SandboxProfiles []string

+ Skills []string

+ Tools []string

+ WorkspacePaths []string

+ type PermissionToolCall struct

+ ID string

+ Kind string

+ Locations []ToolLocation

+ Status string

+ Title string

+ type PromptPatch struct

+ ContextBlocks []ContextBlock

+ Prompt *string

+ type PromptPayload struct

+ ContextBlocks []ContextBlock

+ InputClass string

+ Prompt string

+ type RegisteredHook struct

+ Event HookEvent

+ Executor Executor

+ Matcher HookMatcher

+ Metadata map[string]string

+ Mode HookMode

+ Name string

+ Priority int32

+ Required bool

+ Source HookSource

+ Timeout time.Duration

+ func (h RegisteredHook) Validate() error

+ type ResolvedHook struct

+ Decl HookDecl

+ func NormalizeHookDecl(decl HookDecl, resolve ExecutorResolver) (ResolvedHook, error)

+ func NormalizeHookDecls(decls []HookDecl, resolve ExecutorResolver) ([]ResolvedHook, error)

+ func OrderedResolvedHooks(hooks []*ResolvedHook) []*ResolvedHook

+ func (h *ResolvedHook) Validate() error

+ type SandboxObservationPatch struct

+ type SandboxPreparePatch struct

+ EnvOverrides map[string]string

+ type SandboxPreparePayload struct

+ AgentCommand string

+ AgentEnv []string

+ Backend string

+ Denied bool

+ DenyReason string

+ EnvOverrides map[string]string

+ LocalAdditionalDirs []string

+ LocalRootDir string

+ Permissions string

+ Profile SandboxProfilePayload

+ ResumeACPState string

+ SandboxID string

+ type SandboxProfilePayload struct

+ Backend string

+ DestroyOnStop bool

+ Env map[string]string

+ Persistence string

+ Profile string

+ RuntimeRootDir string

+ SecretEnv map[string]string

+ SyncMode string

+ type SandboxReadyPatch = SandboxObservationPatch

+ type SandboxReadyPayload struct

+ Backend string

+ InstanceID string

+ Profile string

+ RuntimeAdditionalDirs []string

+ RuntimeRootDir string

+ SandboxID string

+ type SandboxStopPatch struct

+ type SandboxStopPayload struct

+ Backend string

+ Denied bool

+ DenyReason string

+ InstanceID string

+ Profile string

+ RuntimeRootDir string

+ SandboxID string

+ StopReason string

+ WillDestroy bool

+ type SandboxSyncAfterPatch = SandboxObservationPatch

+ type SandboxSyncAfterPayload struct

+ Backend string

+ BytesTransferred int64

+ Direction string

+ DurationMS int64

+ Errors []string

+ FilesSynced int

+ InstanceID string

+ Profile string

+ Reason string

+ RuntimeRootDir string

+ SandboxID string

+ type SandboxSyncBeforePatch struct

+ ExcludePatterns []string

+ type SandboxSyncBeforePayload struct

+ Backend string

+ Denied bool

+ DenyReason string

+ Direction string

+ ExcludePatterns []string

+ FileCount int

+ InstanceID string

+ Profile string

+ Reason string

+ RuntimeRootDir string

+ SandboxID string

+ type SecretRefResolver interface

+ ResolveRef func(context.Context, string) (string, error)

+ type SessionContext struct

+ ACPSessionID string

+ AgentName string

+ CreatedAt time.Time

+ SessionID string

+ SessionName string

+ SessionType string

+ State string

+ UpdatedAt time.Time

+ Workspace string

+ WorkspaceID string

+ func SessionContextFromPayload(payload any) SessionContext

+ type SessionCreatePatch struct

+ AgentName *string

+ SessionName *string

+ SessionType *string

+ Workspace *string

+ WorkspaceID *string

+ type SessionHealthUpdateAfterPayload struct

+ ActivePrompt bool

+ Attachable bool

+ EligibleForWake bool

+ Health string

+ IneligibilityReason string

+ LastActivityAt time.Time

+ LastError string

+ LastPresenceAt time.Time

+ type SessionLifecyclePayload struct

+ type SessionMessagePersistedPayload struct

+ ActorID string

+ ActorKind string

+ MessageID string

+ MessageSeq int64

+ ParentSessionID string

+ Persisted json.RawMessage

+ Raw json.RawMessage

+ Role string

+ RootSessionID string

+ Text string

+ type SessionPostCreatePatch = SessionCreatePatch

+ type SessionPostCreatePayload = SessionLifecyclePayload

+ type SessionPostResumePatch = SessionCreatePatch

+ type SessionPostResumePayload = SessionLifecyclePayload

+ type SessionPostStopPatch = SessionCreatePatch

+ type SessionPostStopPayload = SessionLifecyclePayload

+ type SessionPreCreatePayload struct

+ type SessionPreResumePatch = SessionCreatePatch

+ type SessionPreResumePayload = SessionLifecyclePayload

+ type SessionPreStopPatch = SessionCreatePatch

+ type SessionPreStopPayload = SessionLifecyclePayload

+ type SessionSoulContext struct

+ SoulDigest string

+ SoulSnapshotID string

+ type SpawnContext struct

+ AgentName string

+ AutoStopOnParent bool

+ ChildSessionID string

+ CoordinationChannelID string

+ ParentSessionID string

+ ParentSoulDigest string

+ RootSessionID string

+ RunID string

+ SoulDigest string

+ SoulSnapshotID string

+ SpawnDepth int

+ SpawnRole string

+ TTLSeconds int64

+ TaskID string

+ WorkflowID string

+ Workspace string

+ WorkspaceID string

+ type SpawnCreatePatch struct

+ AgentName *string

+ ChildPermissions *PermissionSet

+ SpawnRole *string

+ TTLSeconds *int64

+ type SpawnCreatedPayload = SpawnLifecyclePayload

+ type SpawnLifecyclePayload struct

+ ChildPermissions *PermissionSet

+ Error string

+ ParentPermissions *PermissionSet

+ ReapReason string

+ StopReason string

+ type SpawnObservationPatch = AutonomyObservationPatch

+ type SpawnParentStoppedPayload = SpawnLifecyclePayload

+ type SpawnPreCreatePayload struct

+ ChildPermissions *PermissionSet

+ Denied bool

+ DenyReason string

+ ParentPermissions *PermissionSet

+ type SpawnReapedPayload = SpawnLifecyclePayload

+ type SpawnTTLExpiredPayload = SpawnLifecyclePayload

+ type SubprocessExecutor struct

+ func NewSubprocessExecutor(command string, args []string, opts ...SubprocessExecutorOption) *SubprocessExecutor

+ func (*SubprocessExecutor) Kind() HookExecutorKind

+ func (e *SubprocessExecutor) Execute(ctx context.Context, hook RegisteredHook, payload []byte) ([]byte, error)

+ type SubprocessExecutorOption func(*SubprocessExecutor)

+ func WithSubprocessDir(dir string) SubprocessExecutorOption

+ func WithSubprocessEnv(env map[string]string) SubprocessExecutorOption

+ func WithSubprocessProcessRegistry(registry *toolruntime.Registry) SubprocessExecutorOption

+ func WithSubprocessSecretEnv(env map[string]string, resolver SecretRefResolver) SubprocessExecutorOption

+ type TaskRunClaimCriteria struct

+ AgentName string

+ ClaimerSessionID string

+ CoordinationChannelID string

+ PriorityMin int

+ RequiredCapabilities []string

+ WorkspaceID string

+ type TaskRunCompletedPayload = TaskRunLeasePayload

+ type TaskRunContext struct

+ ActorID string

+ ActorKind string

+ AgentName string

+ Attempt int

+ CoordinationChannelID string

+ Error string

+ LeaseUntil time.Time

+ NetworkChannel string

+ OriginKind string

+ OriginRef string

+ ReleaseReason string

+ RunID string

+ RunStatus string

+ SessionID string

+ SoulDigest string

+ SoulSnapshotID string

+ TaskID string

+ TaskStatus string

+ WorkflowID string

+ WorkspaceID string

+ type TaskRunEnqueuedPayload struct

+ IdempotencyKey string

+ type TaskRunFailedPayload = TaskRunLeasePayload

+ type TaskRunLeaseExpiredPayload = TaskRunLeasePayload

+ type TaskRunLeaseExtendedPayload = TaskRunLeasePayload

+ type TaskRunLeasePayload struct

+ PreviousRunStatus string

+ PreviousSessionID string

+ RecoveryAction string

+ RecoveryReason string

+ type TaskRunLeaseRecoveredPayload = TaskRunLeasePayload

+ type TaskRunObservationPatch = AutonomyObservationPatch

+ type TaskRunPostClaimPayload struct

+ ClaimedAt time.Time

+ type TaskRunPreClaimPatch struct

+ AddRequiredCapabilities []string

+ PriorityMin *int

+ type TaskRunPreClaimPayload struct

+ Criteria TaskRunClaimCriteria

+ Denied bool

+ DenyReason string

+ type TaskRunReleasedPayload = TaskRunLeasePayload

+ type TelemetrySink interface

+ WriteHookRecord func(ctx context.Context, sessionID string, record HookRunRecord) error

+ type ToolCallPatch struct

+ ReadOnly *bool

+ ToolID *string

+ ToolInput json.RawMessage

+ type ToolCallRef struct

+ ReadOnly bool

+ ToolCallID string

+ ToolID string

+ type ToolLocation struct

+ EndLine int

+ Path string

+ StartLine int

+ type ToolPostCallPayload struct

+ Title string

+ ToolInput json.RawMessage

+ ToolResult json.RawMessage

+ type ToolPostErrorPatch = ToolResultPatch

+ type ToolPostErrorPayload struct

+ Error string

+ Title string

+ ToolInput json.RawMessage

+ type ToolPreCallPayload struct

+ ToolInput json.RawMessage

+ type ToolResultPatch struct

+ Error *string

+ Title *string

+ ToolResult json.RawMessage

+ type TurnContext struct

+ TurnID string

+ type TurnEndPatch = TurnPatch

+ type TurnEndPayload = TurnPayload

+ type TurnPatch struct

+ Labels map[string]string

+ type TurnPayload struct

+ InputClass string

+ UserMessage string

+ type TurnStartPatch = TurnPatch

+ type TurnStartPayload = TurnPayload

+ type TypedNativeExecutor struct

+ func NewTypedNativeExecutor[P any, R any](callback TypedNativeHookFunc[P, R]) *TypedNativeExecutor[P, R]

+ func (*TypedNativeExecutor[P, R]) Kind() HookExecutorKind

+ func (e *TypedNativeExecutor[P, R]) Execute(_ context.Context, hook RegisteredHook, _ []byte) ([]byte, error)

+ func (e *TypedNativeExecutor[P, R]) ExecuteTyped(ctx context.Context, hook RegisteredHook, payload P) (result R, err error)

+ type TypedNativeHookFunc func(ctx context.Context, hook RegisteredHook, payload P) (R, error)

+ type WasmExecutor struct

+ func (*WasmExecutor) Execute(_ context.Context, _ RegisteredHook, _ []byte) ([]byte, error)

+ func (*WasmExecutor) Kind() HookExecutorKind

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL