Cereal docs
TypeScript SDKTypeScript signatures

CerealToolCallHookPayload

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 CerealToolCallHookPayload {
    readonly type: "cereal.hook";
    readonly version: 2;
    readonly phase: "tool.call.before";
    readonly connection: string;
    readonly session: CerealHookSession;
    readonly call: {
        readonly toolCallId: string;
        readonly name: string;
        readonly connection?: string;
        readonly input: unknown;
        readonly annotations?: Record<string, unknown>;
    };
    readonly deadlineAt: string;
}

See SDK setup, authoring, client behavior, and the API/SDK map for usage. Domain types are described in schema reference.

Related SDK types: CerealHookSession, tool.