Cereal docs
TypeScript SDKTypeScript signatures

CerealSandboxHookPayload

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 CerealSandboxHookPayload {
    readonly type: "cereal.hook";
    readonly version: 2;
    readonly phase: "sandbox.prepare";
    readonly connection: string;
    readonly session: CerealHookSession;
    readonly sandbox: {
        readonly id: string;
        readonly event: "provisioning" | "resumed";
        readonly from?: "attach" | "snapshot" | "fresh";
        readonly provider: string;
        readonly imageRef: string;
        readonly envNames: ReadonlyArray<string>;
    };
    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.