Skip to main content

Channel Session Reset

Topic​

channel.session.reset

Description​

This event is triggered when your channel session is completely reset. It delivers the full reset session data, allowing you to update all session-related information in your applications or overlays at once.

Usage​

Subscribe to this topic to receive a complete snapshot of your channel session data whenever a reset occurs. This is useful for maintaining synchronization with the latest channel state or initializing your application with current session data.

Payload​

{
    "id": "01HB0YF39XF16HMHCPDYZYJYFL",
    "ts": "2023-09-23T12:10:25Z",
    "type": "message",
    "topic": "channel.session.reset",
    "data": {
        "latest-follower": {
            "name": "Styler"
        },
        // ... other session data
    }
}

Parameters​

ParameterTypeDescription
data.sessionobjectContains the complete reset session data including all counters, latest events, and other session-related information