Stream Kit Docs
Guide

Collections

Session and persistent key-value stores for action handlers and dashboard widgets.

Collections

Collections are named key-value stores you can read and write from action handlers. Use them for leaderboards, counters, state shared across actions, or any structured data that does not fit a single variable string.

Lifetimes

LifetimePersists
SessionUntil the app restarts
PersistentAcross restarts (stored in the database)

Collection names are globally unique across both lifetimes.

Handlers

Core provides collection handlers under Core → Collection:

HandlerPurpose
Create collectionCreate a new collection with a lifetime
Set valueAdd or replace a key
Update valueChange an existing key
Delete keyRemove one key
Clear collectionRemove all keys
Delete collectionRemove the entire collection
Get valueRead a key into an action variable

Browse IDs and fields in the API Reference.

Triggers

React to collection changes:

TriggerWhen
Collection createdA new collection is created
Collection value changedA key is set, updated, or deleted

See Core triggers.

Dashboard widget

Add the Collections widget on the Dashboard to view and edit entries without opening the action editor. Plugins can register their own widgets; Core ships Collections and Log entries.

Collections vs variables

  • Variables — string values for \{interpolation\} in handler text fields (action, user, global scopes).
  • Collections — named stores with multiple keys, lifetimes, and dedicated handlers.

See Variables.

On this page