`Twitch.SharedChatPrimePaidUpgrade`

WebSocket event schema, payload, and examples

Properties

user

object required

string

name

string

type

string

role

integer required

Value	Name
0	Unknown
1	Viewer
2	Vip
3	Moderator
4	Broadcaster

badges

TwitchBadge[]

color

string

subscribed

boolean required

subscriptionTier

string

monthsSubscribed

integer required

source

object required

sourceMessageId

string

sourceBadges

TwitchBadge[]

messageId

string

systemMessage

string

isTest

boolean required

isInSharedChat

boolean required

isSharedChatHost

boolean required

isFromSharedChatGuest

boolean required

upgradeTier

string

upgradeTierString

string

Schema

The JSON Schema for the event payload, if available.

schema.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "TwitchChatNotification_SharedPrimePaidUpgradeEvent",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "user": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/definitions/TwitchUser"
        }
      ]
    },
    "source": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/definitions/TwitchBaseUser"
        }
      ]
    },
    "sourceMessageId": {
      "type": [
        "null",
        "string"
      ]
    },
    "sourceBadges": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/definitions/TwitchBadge"
      }
    },
    "messageId": {
      "type": [
        "null",
        "string"
      ]
    },
    "systemMessage": {
      "type": [
        "null",
        "string"
      ]
    },
    "isTest": {
      "type": "boolean"
    },
    "isInSharedChat": {
      "type": "boolean"
    },
    "isSharedChatHost": {
      "type": "boolean"
    },
    "isFromSharedChatGuest": {
      "type": "boolean"
    },
    "upgradeTier": {
      "type": [
        "null",
        "string"
      ]
    },
    "upgradeTierString": {
      "type": [
        "null",
        "string"
      ]
    }
  },
  "definitions": {
    "TwitchUser": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": [
            "null",
            "string"
          ]
        },
        "login": {
          "type": [
            "null",
            "string"
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "type": {
          "type": [
            "null",
            "string"
          ]
        },
        "role": {
          "$ref": "#/definitions/ViewerRole"
        },
        "badges": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/definitions/TwitchBadge"
          }
        },
        "color": {
          "type": [
            "null",
            "string"
          ]
        },
        "subscribed": {
          "type": "boolean"
        },
        "subscriptionTier": {
          "type": [
            "null",
            "string"
          ]
        },
        "monthsSubscribed": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "ViewerRole": {
      "type": "integer",
      "description": "",
      "x-enum-names": [
        "Unknown",
        "Viewer",
        "Vip",
        "Moderator",
        "Broadcaster"
      ],
      "x-enum-varnames": [
        "Unknown",
        "Viewer",
        "Vip",
        "Moderator",
        "Broadcaster"
      ],
      "x-enumNames": [
        "Unknown",
        "Viewer",
        "Vip",
        "Moderator",
        "Broadcaster"
      ],
      "x-enum-descriptions": [
        null,
        null,
        null,
        null,
        null
      ],
      "x-enumDescriptions": [
        null,
        null,
        null,
        null,
        null
      ],
      "enum": [
        0,
        1,
        2,
        3,
        4
      ]
    },
    "TwitchBadge": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "version": {
          "type": [
            "null",
            "string"
          ]
        },
        "imageUrl": {
          "type": [
            "null",
            "string"
          ]
        },
        "info": {
          "type": [
            "null",
            "string"
          ]
        }
      }
    },
    "TwitchBaseUser": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": [
            "null",
            "string"
          ]
        },
        "login": {
          "type": [
            "null",
            "string"
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "type": {
          "type": [
            "null",
            "string"
          ]
        }
      }
    }
  }
}

JSON Payload

An example JSON payload for the event, automatically generated using JSONSchemaFaker

example.json

{
  "isFromSharedChatGuest": false,
  "isInSharedChat": true,
  "isSharedChatHost": true,
  "isTest": true,
  "messageId": null,
  "source": {
    "id": "occaecat laboris qui in",
    "login": "velit sunt ullamco minim",
    "name": null,
    "type": "pariatur"
  },
  "sourceBadges": [
    {
      "imageUrl": null,
      "info": null,
      "name": "minim et ad officia",
      "version": null
    },
    {
      "imageUrl": "exercitation do eiusmod anim",
      "info": null,
      "name": "magna",
      "version": "commodo amet"
    },
    {
      "imageUrl": null,
      "info": "ut sit velit",
      "name": "nulla amet minim in aliquip",
      "version": null
    },
    {
      "imageUrl": null,
      "info": "sunt quis mollit tempor ad",
      "name": "in",
      "version": "mollit"
    },
    {
      "imageUrl": null,
      "info": "Ut deserunt nostrud",
      "name": "ut sint dolor ad occaecat",
      "version": "id reprehenderit ipsum ea quis"
    }
  ],
  "sourceMessageId": "aliquip adipisicing tempor",
  "systemMessage": null,
  "upgradeTier": "irure dolor velit qui id",
  "upgradeTierString": null,
  "user": {
    "badges": [],
    "color": null,
    "id": null,
    "login": null,
    "monthsSubscribed": 71541875,
    "name": null,
    "role": 3,
    "subscribed": false,
    "subscriptionTier": "qui minim aliquip exercitation",
    "type": null
  }
}

Client Example

Example code showing how to subscribe to this event using the Streamer.bot WebSocket Client

index.js

// Initialize the Streamer.bot WebSocket Client
const client = new StreamerbotClient();

// Subscribe to "Twitch.SharedChatPrimePaidUpgrade" events and register a callback
client.on('Twitch.SharedChatPrimePaidUpgrade', ({ event, data }) => {
  // Code here will run every time the event is received!
  console.log('Received event:', event.source, event.type);
  console.log('Event data:', data);
});