SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias WatchBotEventsRequest

    WatchBotEventsRequest: Message<"soulfire.v1.WatchBotEventsRequest"> & {
        afterSequence: bigint;
        botId: string;
        filter?: BotEventFilter;
        heartbeatIntervalSeconds: number;
        instanceId: string;
        streamEpoch?: string;
    }

    Request to subscribe to a bot's live event stream.

    Type Declaration

    • afterSequence: bigint

      Last sequence confirmed by the caller. When the requested event is no longer resumable the server emits a resync_required event followed by a fresh snapshot.

      from field: uint64 after_sequence = 4;

    • botId: string

      Target bot profile UUID.

      from field: string bot_id = 2;

    • Optionalfilter?: BotEventFilter

      Which event categories to include in the stream.

      from field: soulfire.v1.BotEventFilter filter = 3;

    • heartbeatIntervalSeconds: number

      Requested heartbeat interval. The server clamps this to its supported range. Zero selects the server default.

      from field: uint32 heartbeat_interval_seconds = 6;

    • instanceId: string

      Owning instance UUID.

      from field: string instance_id = 1;

    • OptionalstreamEpoch?: string

      Stream epoch associated with after_sequence.

      from field: optional string stream_epoch = 5;

    from message soulfire.v1.WatchBotEventsRequest