codex/codex-rs/app-server-protocol/schema/json/v2/HooksListResponse.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
    "AbsolutePathBuf": {
      "description": "A path that is guaranteed to be absolute and normalized (though it is not guaranteed to be canonicalized or exist on the filesystem).\n\nIMPORTANT: When deserializing an `AbsolutePathBuf`, a base path must be set using [AbsolutePathBufGuard::new]. If no base path is set, the deserialization will fail unless the path being deserialized is already absolute.",
      "type": "string"
    },
    "HookErrorInfo": {
      "properties": {
        "message": {
          "type": "string"
        },
        "path": {
          "type": "string"
        }
      },
      "required": [
        "message",
        "path"
      ],
      "type": "object"
    },
    "HookEventName": {
      "enum": [
        "preToolUse",
        "permissionRequest",
        "postToolUse",
        "preCompact",
        "postCompact",
        "sessionStart",
        "sessionEnd",
        "userPromptSubmit",
        "subagentStart",
        "subagentStop",
        "stop"
      ],
      "type": "string"
    },
    "HookExecutionMode": {
      "enum": [
        "sync",
        "async"
      ],
      "type": "string"
    },
    "HookHandlerType": {
      "enum": [
        "command",
        "prompt",
        "agent"
      ],
      "type": "string"
    },
    "HookMetadata": {
      "properties": {
        "additionalContextLimit": {
          "description": "Configured `additionalContext` spill threshold. `null` uses 2,500 tokens; `0` disables spilling.",
          "format": "uint",
          "minimum": 0.0,
          "type": [
            "integer",
            "null"
          ]
        },
        "command": {
          "type": [
            "string",
            "null"
          ]
        },
        "currentHash": {
          "type": "string"
        },
        "displayOrder": {
          "format": "int64",
          "type": "integer"
        },
        "enabled": {
          "type": "boolean"
        },
        "eventName": {
          "$ref": "#/definitions/HookEventName"
        },
        "executionMode": {
          "allOf": [
            {
              "$ref": "#/definitions/HookExecutionMode"
            }
          ],
          "default": "sync"
        },
        "handlerType": {
          "$ref": "#/definitions/HookHandlerType"
        },
        "isManaged": {
          "type": "boolean"
        },
        "key": {
          "type": "string"
        },
        "matcher": {
          "type": [
            "string",
            "null"
          ]
        },
        "pluginId": {
          "type": [
            "string",
            "null"
          ]
        },
        "source": {
          "$ref": "#/definitions/HookSource"
        },
        "sourcePath": {
          "$ref": "#/definitions/AbsolutePathBuf"
        },
        "statusMessage": {
          "type": [
            "string",
            "null"
          ]
        },
        "timeoutSec": {
          "format": "uint64",
          "minimum": 0.0,
          "type": "integer"
        },
        "trustStatus": {
          "$ref": "#/definitions/HookTrustStatus"
        }
      },
      "required": [
        "currentHash",
        "displayOrder",
        "enabled",
        "eventName",
        "handlerType",
        "isManaged",
        "key",
        "source",
        "sourcePath",
        "timeoutSec",
        "trustStatus"
      ],
      "type": "object"
    },
    "HookSource": {
      "enum": [
        "system",
        "user",
        "project",
        "mdm",
        "sessionFlags",
        "plugin",
        "cloudRequirements",
        "cloudManagedConfig",
        "legacyManagedConfigFile",
        "legacyManagedConfigMdm",
        "unknown"
      ],
      "type": "string"
    },
    "HookTrustStatus": {
      "enum": [
        "managed",
        "untrusted",
        "trusted",
        "modified"
      ],
      "type": "string"
    },
    "HooksListEntry": {
      "properties": {
        "cwd": {
          "type": "string"
        },
        "errors": {
          "items": {
            "$ref": "#/definitions/HookErrorInfo"
          },
          "type": "array"
        },
        "hooks": {
          "items": {
            "$ref": "#/definitions/HookMetadata"
          },
          "type": "array"
        },
        "warnings": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "cwd",
        "errors",
        "hooks",
        "warnings"
      ],
      "type": "object"
    }
  },
  "properties": {
    "data": {
      "items": {
        "$ref": "#/definitions/HooksListEntry"
      },
      "type": "array"
    }
  },
  "required": [
    "data"
  ],
  "title": "HooksListResponse",
  "type": "object"
}