Twitch.SharedChatSubGift

WebSocket event schema, payload, and examples

Properties

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
durationMonths
integer required
cumlativeTotal
integer required
recipient
object required
subTier
string
communityGiftId
string
fromCommunitySubGift
boolean required
randomCommunitySubGift
boolean required
communitySubGiftCount
integer required
communitySubGiftCumulativeTotal
integer required

Schema

The JSON Schema for the event payload, if available.
schema.json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "TwitchChatNotification_SharedSubGiftEvent",
  "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"
    },
    "durationMonths": {
      "type": "integer",
      "format": "int32"
    },
    "cumlativeTotal": {
      "type": "integer",
      "format": "int32"
    },
    "recipient": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/definitions/TwitchBaseUser"
        }
      ]
    },
    "subTier": {
      "type": [
        "null",
        "string"
      ]
    },
    "communityGiftId": {
      "type": [
        "null",
        "string"
      ]
    },
    "fromCommunitySubGift": {
      "type": "boolean"
    },
    "randomCommunitySubGift": {
      "type": "boolean"
    },
    "communitySubGiftCount": {
      "type": "integer",
      "format": "int32"
    },
    "communitySubGiftCumulativeTotal": {
      "type": "integer",
      "format": "int32"
    }
  },
  "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
{
  "communityGiftId": null,
  "communitySubGiftCount": 90373025,
  "communitySubGiftCumulativeTotal": -28314068,
  "cumlativeTotal": 57875833,
  "durationMonths": -44809751,
  "fromCommunitySubGift": false,
  "isFromSharedChatGuest": true,
  "isInSharedChat": false,
  "isSharedChatHost": true,
  "isTest": false,
  "messageId": null,
  "randomCommunitySubGift": false,
  "recipient": {
    "id": null,
    "login": "Excepteur dolor",
    "name": null,
    "type": "dolore reprehenderit proident voluptate"
  },
  "source": null,
  "sourceBadges": [
    {
      "imageUrl": "sit laborum deserunt dolore consequat",
      "info": "tempor",
      "name": "pariatur nisi laborum non",
      "version": "nostrud proident labore commodo"
    },
    {
      "imageUrl": null,
      "info": "minim",
      "name": "anim elit",
      "version": "id culpa Ut sint voluptate"
    },
    {
      "imageUrl": null,
      "info": null,
      "name": "sed Duis est",
      "version": "in irure mollit veniam"
    },
    {
      "imageUrl": null,
      "info": null,
      "name": null,
      "version": null
    },
    {
      "imageUrl": null,
      "info": null,
      "name": null,
      "version": null
    }
  ],
  "sourceMessageId": "ex officia non est",
  "subTier": "fugiat commodo aute ipsum",
  "systemMessage": null,
  "user": {
    "badges": [
      {
        "imageUrl": "ullamco elit est",
        "info": "ea officia qui",
        "name": null,
        "version": null
      },
      {
        "imageUrl": "voluptate incididunt in",
        "info": null,
        "name": "sed amet",
        "version": "nostrud sunt"
      },
      {
        "imageUrl": null,
        "info": null,
        "name": null,
        "version": "ex voluptate aliquip reprehenderit quis"
      },
      {
        "imageUrl": null,
        "info": null,
        "name": null,
        "version": "ut proident sed Lorem"
      },
      {
        "imageUrl": "sed nisi",
        "info": "esse dolore cillum ipsum",
        "name": "consectetur dolor sunt sit",
        "version": "in sunt amet sit"
      }
    ],
    "color": "incididunt veniam amet",
    "id": "officia cupidatat ut reprehenderit",
    "login": null,
    "monthsSubscribed": 34157430,
    "name": null,
    "role": 2,
    "subscribed": true,
    "subscriptionTier": null,
    "type": "et ex"
  }
}

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