prv domain

Events restricted to the streamer and accounts they have granted access to. Primarily the same as the pub events but with extra information related to costs and revenue.

Subscribe with a prv/<ccUID> topic.

effect-request type

A viewer is attempting to redeem coins for an effect. Contains additional pricing and payment details.

GameSessionEffectPayload

Another VIEWER this effect was aimed at (viewer-to-viewer paybacks). target remains the streamer on these so this is what identifies who the effect was actually played on. Present only on viewer-aimed effects.

›pooled?boolean

›pricenumber

›unitPricenumber

›quantity?number

›requestIDGameSessionRequestID

›example?boolean

›localTimestamp?number

›admin?boolean

Whether the requester is an administrator.

›viaTwitchExtension?boolean

True when the request was sent from the Twitch extension. Paybacks can only reach viewers inside the extension, so the feed uses this to decide whether the payback action is offered as available.

›paybackable?boolean

True when a payback can be offered on this request (extension-sourced and the viewer allowed paybacks at request time). The feed hides the payback action when this is unset on an extension-sourced request; the server re-checks the live setting on click. The raw opt-out preference is never exposed.

›paybackWindowEndsAt?number

Epoch ms deadline for the streamer to send a payback (acceptedAt + PAYBACK_SEND_WINDOW_MS). Server-enforced. Only set on paybackable success payloads.

When set, the refund or retry was performed by someone other than the host (e.g. an editor).

›message?string

›messageID?string

Set on a parent effect's payloads once CHILD effect requests have been linked to it — chance (wheel/cards) winners and attachment-triggered effects. Lets the session event queue render the children nested under the parent entry. Carries only display info (no payment data).

›parentRequestID?GameSessionRequestID

Set on payloads of CHILD effect requests (chance winners / linked attachment effects) — the ID of the parent request. The client uses this to route the child's timed updates into the parent's nested child row.

›refundable?boolean

True when this effect can be refunded (has a transaction and is not pooled). Allows host/editors to show the refund button without exposing payment details in public payloads.

›notifyAfter?number

Delay 'success' notification in the extension by these milliseconds.

›anonymous?boolean

›timestampnumber

timed-effect-update type

Private counterpart of pub timed-effect-update.

GameSessionPrivateTimedEffectUpdatePayload

›statusGameSessionTimedEffectStatus

›timeRemainingnumber

Another VIEWER this effect was aimed at (viewer-to-viewer paybacks). target remains the streamer on these so this is what identifies who the effect was actually played on. Present only on viewer-aimed effects.

›pooled?boolean

›pricenumber

›unitPricenumber

›quantity?number

›requestIDGameSessionRequestID

›example?boolean

›localTimestamp?number

›admin?boolean

Whether the requester is an administrator.

›viaTwitchExtension?boolean

True when the request was sent from the Twitch extension. Paybacks can only reach viewers inside the extension, so the feed uses this to decide whether the payback action is offered as available.

›paybackable?boolean

True when a payback can be offered on this request (extension-sourced and the viewer allowed paybacks at request time). The feed hides the payback action when this is unset on an extension-sourced request; the server re-checks the live setting on click. The raw opt-out preference is never exposed.

›paybackWindowEndsAt?number

Epoch ms deadline for the streamer to send a payback (acceptedAt + PAYBACK_SEND_WINDOW_MS). Server-enforced. Only set on paybackable success payloads.

When set, the refund or retry was performed by someone other than the host (e.g. an editor).

›message?string

›messageID?string

Set on a parent effect's payloads once CHILD effect requests have been linked to it — chance (wheel/cards) winners and attachment-triggered effects. Lets the session event queue render the children nested under the parent entry. Carries only display info (no payment data).

›parentRequestID?GameSessionRequestID

Set on payloads of CHILD effect requests (chance winners / linked attachment effects) — the ID of the parent request. The client uses this to route the child's timed updates into the parent's nested child row.

›refundable?boolean

True when this effect can be refunded (has a transaction and is not pooled). Allows host/editors to show the refund button without exposing payment details in public payloads.

›notifyAfter?number

Delay 'success' notification in the extension by these milliseconds.

›anonymous?boolean

›timestampnumber

effect-success type

Private counterpart of pub effect-success.

GameSessionEffectPayload

Another VIEWER this effect was aimed at (viewer-to-viewer paybacks). target remains the streamer on these so this is what identifies who the effect was actually played on. Present only on viewer-aimed effects.

›pooled?boolean

›pricenumber

›unitPricenumber

›quantity?number

›requestIDGameSessionRequestID

›example?boolean

›localTimestamp?number

›admin?boolean

Whether the requester is an administrator.

›viaTwitchExtension?boolean

True when the request was sent from the Twitch extension. Paybacks can only reach viewers inside the extension, so the feed uses this to decide whether the payback action is offered as available.

›paybackable?boolean

True when a payback can be offered on this request (extension-sourced and the viewer allowed paybacks at request time). The feed hides the payback action when this is unset on an extension-sourced request; the server re-checks the live setting on click. The raw opt-out preference is never exposed.

›paybackWindowEndsAt?number

Epoch ms deadline for the streamer to send a payback (acceptedAt + PAYBACK_SEND_WINDOW_MS). Server-enforced. Only set on paybackable success payloads.

When set, the refund or retry was performed by someone other than the host (e.g. an editor).

›message?string

›messageID?string

Set on a parent effect's payloads once CHILD effect requests have been linked to it — chance (wheel/cards) winners and attachment-triggered effects. Lets the session event queue render the children nested under the parent entry. Carries only display info (no payment data).

›parentRequestID?GameSessionRequestID

Set on payloads of CHILD effect requests (chance winners / linked attachment effects) — the ID of the parent request. The client uses this to route the child's timed updates into the parent's nested child row.

›refundable?boolean

True when this effect can be refunded (has a transaction and is not pooled). Allows host/editors to show the refund button without exposing payment details in public payloads.

›notifyAfter?number

Delay 'success' notification in the extension by these milliseconds.

›anonymous?boolean

›timestampnumber

effect-retry type

Private counterpart of pub effect-retry.

GameSessionEffectPayload

Another VIEWER this effect was aimed at (viewer-to-viewer paybacks). target remains the streamer on these so this is what identifies who the effect was actually played on. Present only on viewer-aimed effects.

›pooled?boolean

›pricenumber

›unitPricenumber

›quantity?number

›requestIDGameSessionRequestID

›example?boolean

›localTimestamp?number

›admin?boolean

Whether the requester is an administrator.

›viaTwitchExtension?boolean

True when the request was sent from the Twitch extension. Paybacks can only reach viewers inside the extension, so the feed uses this to decide whether the payback action is offered as available.

›paybackable?boolean

True when a payback can be offered on this request (extension-sourced and the viewer allowed paybacks at request time). The feed hides the payback action when this is unset on an extension-sourced request; the server re-checks the live setting on click. The raw opt-out preference is never exposed.

›paybackWindowEndsAt?number

Epoch ms deadline for the streamer to send a payback (acceptedAt + PAYBACK_SEND_WINDOW_MS). Server-enforced. Only set on paybackable success payloads.

When set, the refund or retry was performed by someone other than the host (e.g. an editor).

›message?string

›messageID?string

Set on a parent effect's payloads once CHILD effect requests have been linked to it — chance (wheel/cards) winners and attachment-triggered effects. Lets the session event queue render the children nested under the parent entry. Carries only display info (no payment data).

›parentRequestID?GameSessionRequestID

Set on payloads of CHILD effect requests (chance winners / linked attachment effects) — the ID of the parent request. The client uses this to route the child's timed updates into the parent's nested child row.

›refundable?boolean

True when this effect can be refunded (has a transaction and is not pooled). Allows host/editors to show the refund button without exposing payment details in public payloads.

›notifyAfter?number

Delay 'success' notification in the extension by these milliseconds.

›anonymous?boolean

›timestampnumber

effect-refund type

Private counterpart of pub effect-refund.

GameSessionEffectPayload

Another VIEWER this effect was aimed at (viewer-to-viewer paybacks). target remains the streamer on these so this is what identifies who the effect was actually played on. Present only on viewer-aimed effects.

›pooled?boolean

›pricenumber

›unitPricenumber

›quantity?number

›requestIDGameSessionRequestID

›example?boolean

›localTimestamp?number

›admin?boolean

Whether the requester is an administrator.

›viaTwitchExtension?boolean

True when the request was sent from the Twitch extension. Paybacks can only reach viewers inside the extension, so the feed uses this to decide whether the payback action is offered as available.

›paybackable?boolean

True when a payback can be offered on this request (extension-sourced and the viewer allowed paybacks at request time). The feed hides the payback action when this is unset on an extension-sourced request; the server re-checks the live setting on click. The raw opt-out preference is never exposed.

›paybackWindowEndsAt?number

Epoch ms deadline for the streamer to send a payback (acceptedAt + PAYBACK_SEND_WINDOW_MS). Server-enforced. Only set on paybackable success payloads.

When set, the refund or retry was performed by someone other than the host (e.g. an editor).

›message?string

›messageID?string

Set on a parent effect's payloads once CHILD effect requests have been linked to it — chance (wheel/cards) winners and attachment-triggered effects. Lets the session event queue render the children nested under the parent entry. Carries only display info (no payment data).

›parentRequestID?GameSessionRequestID

Set on payloads of CHILD effect requests (chance winners / linked attachment effects) — the ID of the parent request. The client uses this to route the child's timed updates into the parent's nested child row.

›refundable?boolean

True when this effect can be refunded (has a transaction and is not pooled). Allows host/editors to show the refund button without exposing payment details in public payloads.

›notifyAfter?number

Delay 'success' notification in the extension by these milliseconds.

›anonymous?boolean

›timestampnumber

effect-failure type

Private counterpart of pub effect-failure.

PrivateEffectFailurePayload

›temporary?boolean

Another VIEWER this effect was aimed at (viewer-to-viewer paybacks). target remains the streamer on these so this is what identifies who the effect was actually played on. Present only on viewer-aimed effects.

›pooled?boolean

›pricenumber

›unitPricenumber

›quantity?number

›requestIDGameSessionRequestID

›example?boolean

›localTimestamp?number

›admin?boolean

Whether the requester is an administrator.

›viaTwitchExtension?boolean

True when the request was sent from the Twitch extension. Paybacks can only reach viewers inside the extension, so the feed uses this to decide whether the payback action is offered as available.

›paybackable?boolean

True when a payback can be offered on this request (extension-sourced and the viewer allowed paybacks at request time). The feed hides the payback action when this is unset on an extension-sourced request; the server re-checks the live setting on click. The raw opt-out preference is never exposed.

›paybackWindowEndsAt?number

Epoch ms deadline for the streamer to send a payback (acceptedAt + PAYBACK_SEND_WINDOW_MS). Server-enforced. Only set on paybackable success payloads.

When set, the refund or retry was performed by someone other than the host (e.g. an editor).

›message?string

›messageID?string

Set on a parent effect's payloads once CHILD effect requests have been linked to it — chance (wheel/cards) winners and attachment-triggered effects. Lets the session event queue render the children nested under the parent entry. Carries only display info (no payment data).

›parentRequestID?GameSessionRequestID

Set on payloads of CHILD effect requests (chance winners / linked attachment effects) — the ID of the parent request. The client uses this to route the child's timed updates into the parent's nested child row.

›refundable?boolean

True when this effect can be refunded (has a transaction and is not pooled). Allows host/editors to show the refund button without exposing payment details in public payloads.

›notifyAfter?number

Delay 'success' notification in the extension by these milliseconds.

›anonymous?boolean

›timestampnumber

effect-payback type

Private counterpart of pub effect-payback.

GameSessionPrivateEffectPaybackPayload

Another VIEWER this effect was aimed at (viewer-to-viewer paybacks). target remains the streamer on these so this is what identifies who the effect was actually played on. Present only on viewer-aimed effects.

›pooled?boolean

›pricenumber

›unitPricenumber

›quantity?number

›requestIDGameSessionRequestID

›example?boolean

›localTimestamp?number

›admin?boolean

Whether the requester is an administrator.

›viaTwitchExtension?boolean

True when the request was sent from the Twitch extension. Paybacks can only reach viewers inside the extension, so the feed uses this to decide whether the payback action is offered as available.

›paybackable?boolean

True when a payback can be offered on this request (extension-sourced and the viewer allowed paybacks at request time). The feed hides the payback action when this is unset on an extension-sourced request; the server re-checks the live setting on click. The raw opt-out preference is never exposed.

›paybackWindowEndsAt?number

Epoch ms deadline for the streamer to send a payback (acceptedAt + PAYBACK_SEND_WINDOW_MS). Server-enforced. Only set on paybackable success payloads.

When set, the refund or retry was performed by someone other than the host (e.g. an editor).

›message?string

›messageID?string

Set on a parent effect's payloads once CHILD effect requests have been linked to it — chance (wheel/cards) winners and attachment-triggered effects. Lets the session event queue render the children nested under the parent entry. Carries only display info (no payment data).

›parentRequestID?GameSessionRequestID

Set on payloads of CHILD effect requests (chance winners / linked attachment effects) — the ID of the parent request. The client uses this to route the child's timed updates into the parent's nested child row.

›refundable?boolean

True when this effect can be refunded (has a transaction and is not pooled). Allows host/editors to show the refund button without exposing payment details in public payloads.

›notifyAfter?number

Delay 'success' notification in the extension by these milliseconds.

›anonymous?boolean

›timestampnumber

›paybackStatusGameSessionEffectPaybackStatus

›coinReward?number

Coins credited to the viewer when the payback lands.

›paybackEffectName?string

Display name of the disrupt played against the viewer.

›paybackEffectID?string

Identity of the disrupt played against the viewer — lets the targeted viewer report custom disrupts straight from their activity feed.

›paybackPackID?string

›paybackPackType?'user' | 'crowd-control'

›paybackExpiresAt?number

Epoch ms when a sent payback expires without an ack.

coin-exchange type

A viewer bought or was granted coins, including the amount and any bonus.

CoinExchangePayload

›amountnumber

›bonus?number

›coinType'paid' | 'free'

›source?ExchangeSource

›transactionIDTransactionID

›example?boolean

›anonymous?boolean

›timestampnumber

overlay-update type

The streamer's browser-source overlay connected or disconnected.

›status'connected' | 'disconnected'

native-command-response type

NativeClientCommandResponsePayload

›requestIdstring

›methodstring

›args?unknown

›rpcRecord<string, unknown>

›packMessages?Record<string, unknown>[]