Skip to content
StreamElements Docs

Session Reset

Topic
channel.session.reset
Scope
session:read

This event is triggered when your channel session is reset. It delivers the complete new session data in one message, so you can reinitialize every session-related value in your application or overlay at once.

Payload

Section titled “Payload”

data contains the session object itself — a flat map of session keys, with no wrapper property. The keys follow the <type>-latest, <type>-session, <type>-week, <type>-month, <type>-total, <type>-count, and <type>-goal naming pattern, the same keys documented in the Session Data Reference.

Parameter Type Description
data object The complete reset session data: all counters, latest events, and other session values

Example

Section titled “Example”
{
    "id": "01HB0YF39XF16HMHCPDYZYJYFL",
    "ts": "2023-09-23T12:10:25Z",
    "type": "message",
    "topic": "channel.session.reset",
    "data": {
        "follower-latest": {
            "name": "Styler"
        },
        "follower-session": {
            "count": 0
        },
        "tip-session": {
            "amount": 0
        }
    }
}
Section titled “Related”