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": -89993857,
  "durationMonths": -39266744,
  "gifter": null,
  "gifterIsAnonymous": true,
  "isFromSharedChatGuest": false,
  "isGift": false,
  "isInSharedChat": false,
  "isPrime": true,
  "isSharedChatHost": true,
  "isTest": true,
  "messageId": "quis deserunt nulla veniam Lorem",
  "parts": [
    {
      "text": "id exercitation occaecat",
      "type": "ut ipsum"
    },
    {
      "text": "eiusmod laborum magna esse",
      "type": "in"
    },
    {
      "text": "amet sed esse dolore",
      "type": "sit cillum anim eiusmod"
    },
    {
      "text": null,
      "type": null
    },
    {
      "text": "Ut",
      "type": "mollit elit"
    }
  ],
  "source": null,
  "sourceBadges": [
    {
      "imageUrl": "quis velit",
      "info": null,
      "name": "eu",
      "version": "officia Lorem nostrud cupidatat Ut"
    },
    {
      "imageUrl": "dolor nisi velit deserunt ad",
      "info": null,
      "name": null,
      "version": null
    },
    {
      "imageUrl": null,
      "info": "ut Ut Lorem ea",
      "name": null,
      "version": null
    },
    {
      "imageUrl": null,
      "info": "ex sint dolor",
      "name": "ipsum adipisicing irure",
      "version": "exercitation"
    },
    {
      "imageUrl": "culpa adipisicing laborum",
      "info": "incididunt laborum ad ex elit",
      "name": null,
      "version": "ex nostrud minim"
    }
  ],
  "sourceMessageId": "occaecat anim ea dolor elit",
  "streakMonths": 56618807,
  "subTier": null,
  "systemMessage": null,
  "text": "aliqua est dolor tempor",
  "user": {
    "badges": [
      {
        "imageUrl": null,
        "info": "qui aliqua dolor",
        "name": null,
        "version": "velit qui"
      },
      {
        "imageUrl": "ut commodo ea",
        "info": "labore esse non",
        "name": "nostrud",
        "version": null
      },
      {
        "imageUrl": "adipisicing proident",
        "info": "dolore officia mollit pariatur id",
        "name": "ea velit Duis tempor",
        "version": "et"
      },
      {
        "imageUrl": null,
        "info": "id sit laborum sed elit",
        "name": "laborum pariatur nulla Ut",
        "version": "dolore quis laboris reprehenderit officia"
      },
      {
        "imageUrl": null,
        "info": null,
        "name": "officia et",
        "version": null
      }
    ],
    "color": "occaecat",
    "id": "consectetur nisi eiusmod sed reprehenderit",
    "login": "in elit sit magna",
    "monthsSubscribed": -64478892,
    "name": "incididunt id magna in",
    "role": 0,
    "subscribed": false,
    "subscriptionTier": "Duis",
    "type": "voluptate dolore do adipisicing"
  }
}

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);
});