Twitch.SharedChatResub

WebSocket event schema, payload, and examples

Properties

text
string
parts
TwitchMessagePartBase[]
user
object 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": -3831037,
  "durationMonths": -63431318,
  "gifter": {
    "id": "adipisicing",
    "login": null,
    "name": null,
    "type": "enim voluptate reprehenderit ut dolor"
  },
  "gifterIsAnonymous": false,
  "isFromSharedChatGuest": false,
  "isGift": false,
  "isInSharedChat": true,
  "isPrime": true,
  "isSharedChatHost": false,
  "isTest": false,
  "messageId": null,
  "parts": [
    {
      "text": null,
      "type": null
    },
    {
      "text": null,
      "type": null
    },
    {
      "text": null,
      "type": "est"
    },
    {
      "text": "nostrud sed mollit amet occaecat",
      "type": null
    },
    {
      "text": null,
      "type": null
    }
  ],
  "source": {},
  "sourceBadges": [
    {
      "imageUrl": null,
      "info": null,
      "name": null,
      "version": null
    },
    {
      "imageUrl": null,
      "info": null,
      "name": null,
      "version": "ipsum magna reprehenderit veniam"
    },
    {
      "imageUrl": null,
      "info": "adipisicing ullamco consectetur aliquip",
      "name": null,
      "version": "ut sed dolore"
    },
    {
      "imageUrl": null,
      "info": null,
      "name": "dolor do enim sed",
      "version": "et aliqua proident ipsum"
    },
    {
      "imageUrl": "ut sed est",
      "info": null,
      "name": "anim",
      "version": null
    }
  ],
  "sourceMessageId": null,
  "streakMonths": -80939475,
  "subTier": "exercitation deserunt non et",
  "systemMessage": null,
  "text": null,
  "user": {
    "badges": null,
    "color": "anim non pariatur id nisi",
    "id": "sed magna quis nisi consectetur",
    "login": null,
    "monthsSubscribed": -50469343,
    "name": null,
    "role": 3,
    "subscribed": true,
    "subscriptionTier": null,
    "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.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);
});