direct domain

Events sent directly to a WebSocket connection. These are mostly responses to requests. Cannot be subscribed to; you are automatically subscribed.

whoami type

Sent in response to a whoami request.

›connectionIDstring

login-success type

[Deprecated] Sent when a user finishes signing in to a Crowd Control account using the connectionID from the whoami event. The token it carries authenticates subsequent requests.

›tokenCrowdControlAuthToken

login-failure type

[Deprecated] Sent when a sign-in attempt against your connectionID could not be completed.

›title?string

›message?string

link-success type

This event carries no payload.

link-failure type

This event carries no payload.

subscription-result type

Sent in response to a subscribe request. Topics you were not permitted to join are listed under failure.

›successPubSubEventTopic[]

›failurePubSubEventTopic[]

bad-request type

Sent when the server could not process a request you sent.

›messagestring

application-auth-code type

Sent in response to an application requesting a device-style auth code. Show code/qrCode/url to the user depending on the device.

›codestring

›urlstring

›qrCode?string

application-auth-code-redeemed type

Sent once a user has redeemed the auth code you issued.

›codestring

application-auth-code-error type

Sent when an auth code could not be issued or redeemed.

›messagestring

game-session-checksum-update type

A new free-coin claim checksum. Clients tracking free coin claims should replace their stored checksum with this value.

›checksumstring

goal-update type

Current state of a streamer's goal, sent when you subscribe to it. Further updates are sent via goal domain.

›type'effects' | 'usd' | 'coins' | 'uniqueUsers'

›targetnumber

›title?string

›updatedAtstring

›goalIDstring

›ccUIDstring

›raisednumber

›freeCoins?boolean

›localCoins?boolean

›globalCoins?boolean

›twitchBits?boolean

›twitchSubs?boolean

›twitchChannelPoints?boolean

›tikTokCoins?boolean

›tikTokFree?boolean

›tikTokPaid?boolean

›autoReset?boolean

›status'active' | 'ended'

›endedAt?string

›createdAtstring

›viewedAtstring