Cereal docs
TypeScript SDKTypeScript signatures

client.hooks

TypeScript client.hooks signature, generated from CerealClient.

This is the TypeScript interface. See client setup and behavior.

interface ClientSurface {
readonly hooks: {
    deliveries(input?: {
        readonly sessionId?: string;
        readonly connectionId?: string;
        readonly status?: HookDeliveryStatus;
        readonly since?: Date;
        readonly cursor?: string;
        readonly limit?: number;
        readonly includePayload?: boolean;
    }): Promise<HookDeliveryPage>;
    stats(input?: {
        readonly since?: Date;
    }): Promise<HookStats>;
    redeliver(input: {
        readonly id: string;
    }): Promise<HookDelivery>;
    redeliverAll(input?: {
        readonly connectionId?: string;
        readonly sessionId?: string;
        readonly status?: HookDeliveryStatus;
        readonly since?: Date;
    }): Promise<{
        readonly requeued: number;
        readonly more: boolean;
    }>;
    discard(input: {
        readonly id: string;
    }): Promise<HookDelivery>;
};
}

For the wire contract, use HTTP reference. Composite helpers are explained in the API/SDK map.