Hooks

Allowlist of environment variable names a header may read via `{{ env.NAME }}`. Empty (the default) means no env vars may be interpolated into headers.

Whether the hook must complete before execution continues. Defaults vary by event.

Shell command shorthand — implies `type = "command"`.

The lifecycle event to listen for (required).

Optional HTTP headers. Values support `{{ env.NAME }}` interpolation, scoped to the names in `allowed_env_vars`. A token for any other env var fails to resolve and the hook blocks (fail-closed).

Regex pattern to filter which stages trigger this hook.

Maximum tool call rounds before the agent gives up. Default: `50`.

Model alias or ID. Defaults to `haiku`.

Optional display name. Auto-generated from event and type if omitted.

Instructions for the LLM evaluator.

Run inside the sandbox (`true`, default) or on the host (`false`).

Hook timeout in milliseconds. Default: `60000` (60s) for most types, `30000` (30s) for prompt hooks.

TLS mode: `"verify"` (default), `"no_verify"`, or `"off"`.

Explicit hook type: `"command"`, `"http"`, `"prompt"`, or `"agent"`.

The endpoint to POST to. Must use `https://` unless `tls = "off"`. Supports `{{ env.NAME }}` interpolation.