Twitch.SharedChatCommunitySubGift

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
id
string
total
integer required
cumulative_total
integer
sub_tier
string
recipients
TwitchBaseUser[]

Schema

The JSON Schema for the event payload, if available.
schema.json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "TwitchChatNotification_SharedCommunitySubGiftEvent",
  "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"
    },
    "id": {
      "type": [
        "null",
        "string"
      ]
    },
    "total": {
      "type": "integer",
      "format": "int32"
    },
    "cumulative_total": {
      "type": [
        "integer",
        "null"
      ],
      "format": "int32"
    },
    "sub_tier": {
      "type": [
        "null",
        "string"
      ]
    },
    "recipients": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/definitions/TwitchBaseUser"
      }
    }
  },
  "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
{
  "cumulative_total": 19864558,
  "id": "sed irure",
  "isFromSharedChatGuest": false,
  "isInSharedChat": true,
  "isSharedChatHost": true,
  "isTest": false,
  "messageId": null,
  "recipients": [
    {
      "id": "irure reprehenderit labore laborum",
      "login": null,
      "name": null,
      "type": "cillum nostrud eu aliqua"
    },
    {
      "id": null,
      "login": null,
      "name": null,
      "type": null
    },
    {
      "id": "laborum in",
      "login": "ea",
      "name": "sit ullamco mollit Excepteur",
      "type": "sit anim"
    },
    {
      "id": null,
      "login": "ipsum",
      "name": "sunt fugiat aliquip officia",
      "type": "eiusmod proident consectetur irure"
    },
    {
      "id": "dolor veniam commodo est Excepteur",
      "login": "in proident labore",
      "name": "aute Excepteur",
      "type": null
    }
  ],
  "source": {
    "id": "id enim adipisicing dolore",
    "login": "dolor nulla cillum",
    "name": "non dolore ipsum",
    "type": null
  },
  "sourceBadges": [
    {
      "imageUrl": "id proident",
      "info": "culpa",
      "name": "et dolore consequat cupidatat",
      "version": "culpa ut"
    },
    {
      "imageUrl": "quis",
      "info": null,
      "name": null,
      "version": "consectetur laboris minim"
    },
    {
      "imageUrl": null,
      "info": null,
      "name": null,
      "version": "eiusmod qui officia nulla"
    },
    {
      "imageUrl": "reprehenderit incididunt enim et",
      "info": null,
      "name": "do irure deserunt",
      "version": null
    },
    {
      "imageUrl": "sint Lorem culpa id labore",
      "info": "ullamco veniam anim reprehenderit",
      "name": "amet",
      "version": null
    }
  ],
  "sourceMessageId": "pariatur ipsum aliquip",
  "sub_tier": null,
  "systemMessage": null,
  "total": 74308218,
  "user": 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.SharedChatCommunitySubGift" events and register a callback
client.on('Twitch.SharedChatCommunitySubGift', ({ 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);
});