TypeScript SDKTypeScript signatures
CerealHooks
Public TypeScript declaration from @trycereal/sdk.
Import from @trycereal/sdk. Generated from the repository SDK declarations (package version 0.0.0); not from HTTP request schemas.
export interface CerealHooks {
readonly onSessionEvent?: (event: SessionEvent, context: HookContext) => Promise<SessionEventHookResult | void> | SessionEventHookResult | void;
readonly onToolCall?: (call: CerealToolCallHookPayload["call"], context: ToolCallHookContext) => Promise<ToolCallHookResult | void> | ToolCallHookResult | void;
readonly onSandboxPrepare?: (sandbox: CerealSandboxHookPayload["sandbox"], context: SandboxHookContext) => Promise<SandboxHookResult | void> | SandboxHookResult | void;
readonly decisions?: {
readonly expiresInSeconds?: number;
readonly onExpire?: "deny" | "cancel_turn";
};
readonly events?: ReadonlyArray<HookableEventType>;
}See SDK setup, authoring, client behavior, and the API/SDK map for usage. Domain types are described in schema reference.
Related SDK types: CerealToolCallHookPayload, CerealSandboxHookPayload, HookContext, ToolCallHookContext, ToolCallHookResult, SandboxHookContext, SandboxHookResult, SessionEventHookResult.