`Twitch.SharedChatResub`

WebSocket event schema, payload, and examples

Properties

text

string

parts

TwitchMessagePartBase[]

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

cumulativeMonths

integer required

durationMonths

integer required

streakMonths

integer required

subTier

string

isPrime

boolean required

isGift

boolean required

gifterIsAnonymous

boolean

gifter

object required

Schema

The JSON Schema for the event payload, if available.

schema.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "TwitchChatNotification_SharedResubEvent",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "text": {
      "type": [
        "null",
        "string"
      ]
    },
    "parts": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/definitions/TwitchMessagePartBase"
      }
    },
    "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"
    },
    "cumulativeMonths": {
      "type": "integer",
      "format": "int32"
    },
    "durationMonths": {
      "type": "integer",
      "format": "int32"
    },
    "streakMonths": {
      "type": "integer",
      "format": "int32"
    },
    "subTier": {
      "type": [
        "null",
        "string"
      ]
    },
    "isPrime": {
      "type": "boolean"
    },
    "isGift": {
      "type": "boolean"
    },
    "gifterIsAnonymous": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "gifter": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/definitions/TwitchBaseUser"
        }
      ]
    }
  },
  "definitions": {
    "TwitchMessagePartBase": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "type": [
            "null",
            "string"
          ]
        },
        "text": {
          "type": [
            "null",
            "string"
          ]
        }
      }
    },
    "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

{
  "cumulativeMonths": 16770426,
  "durationMonths": -50157966,
  "gifter": null,
  "gifterIsAnonymous": true,
  "isFromSharedChatGuest": true,
  "isGift": true,
  "isInSharedChat": true,
  "isPrime": true,
  "isSharedChatHost": true,
  "isTest": false,
  "messageId": null,
  "parts": [
    {
      "text": null,
      "type": null
    },
    {
      "text": "adipisicing laborum",
      "type": "laboris voluptate sint"
    },
    {
      "text": "cillum",
      "type": "ad eu"
    },
    {
      "text": "qui ex",
      "type": null
    },
    {
      "text": null,
      "type": null
    }
  ],
  "source": null,
  "sourceBadges": [
    {
      "imageUrl": null,
      "info": null,
      "name": null,
      "version": null
    },
    {
      "imageUrl": "fugiat",
      "info": "ut sint ipsum do proident",
      "name": "occaecat minim in",
      "version": null
    },
    {
      "imageUrl": "ad cupidatat nisi dolor Ut",
      "info": "aliqua aliquip fugiat sed voluptate",
      "name": null,
      "version": "consectetur in ut exercitation"
    },
    {
      "imageUrl": "exercitation laboris dolore",
      "info": "ea consectetur do",
      "name": null,
      "version": "minim veniam exercitation ea sunt"
    },
    {
      "imageUrl": "velit",
      "info": null,
      "name": null,
      "version": null
    }
  ],
  "sourceMessageId": "ut",
  "streakMonths": 65135623,
  "subTier": null,
  "systemMessage": "dolor",
  "text": "dolor sunt aliquip",
  "user": {
    "badges": [
      {
        "imageUrl": null,
        "info": null,
        "name": null,
        "version": null
      },
      {
        "imageUrl": null,
        "info": "ipsum eu ut",
        "name": "laborum labore ex commodo",
        "version": null
      },
      {
        "imageUrl": "officia",
        "info": null,
        "name": null,
        "version": null
      },
      {
        "imageUrl": null,
        "info": "aute",
        "name": null,
        "version": null
      },
      {
        "imageUrl": "Duis laboris occaecat proident eiusmod",
        "info": null,
        "name": "anim proident sunt voluptate in",
        "version": null
      }
    ],
    "color": "minim",
    "id": "dolor laboris nulla irure",
    "login": null,
    "monthsSubscribed": 81764737,
    "name": null,
    "role": 3,
    "subscribed": false,
    "subscriptionTier": "cupidatat amet",
    "type": "id"
  }
}

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.SharedChatResub" events and register a callback
client.on('Twitch.SharedChatResub', ({ 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);
});