`Twitch.SharedChatCommunitySubGift`

WebSocket event schema, payload, and examples

Properties

user

TwitchUser required

source

TwitchBaseUser required

sourceMessageId

string

sourceBadges

TwitchBadge[]

messageId

string

systemMessage

string

isTest

boolean required

isInSharedChat

boolean required

isSharedChatHost

boolean required

isFromSharedChatGuest

boolean required

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": "#/$defs/TwitchUser"
        }
      ]
    },
    "source": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/$defs/TwitchBaseUser"
        }
      ]
    },
    "sourceMessageId": {
      "type": [
        "null",
        "string"
      ]
    },
    "sourceBadges": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/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"
    },
    "cumulative_total": {
      "type": [
        "integer",
        "null"
      ]
    },
    "sub_tier": {
      "type": [
        "null",
        "string"
      ]
    },
    "recipients": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/TwitchBaseUser"
      }
    }
  },
  "$defs": {
    "TwitchUser": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": [
            "null",
            "string"
          ]
        },
        "login": {
          "type": [
            "null",
            "string"
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "type": {
          "type": [
            "null",
            "string"
          ]
        },
        "role": {
          "$ref": "#/$defs/ViewerRole"
        },
        "badges": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/TwitchBadge"
          }
        },
        "color": {
          "type": [
            "null",
            "string"
          ]
        },
        "subscribed": {
          "type": "boolean"
        },
        "subscriptionTier": {
          "type": [
            "null",
            "string"
          ]
        },
        "monthsSubscribed": {
          "type": "integer"
        }
      }
    },
    "ViewerRole": {
      "type": "integer",
      "description": "",
      "x-enum-names": [
        "Unknown",
        "Viewer",
        "Vip",
        "Moderator",
        "Broadcaster"
      ],
      "x-enum-descriptions": [
        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

{
  "user": null,
  "source": null,
  "sourceMessageId": "E4BdRZuv7",
  "sourceBadges": [
    {
      "name": "tqHnxjDs",
      "version": "b",
      "imageUrl": null,
      "info": "SC"
    },
    {
      "name": null,
      "version": "q2Soc",
      "imageUrl": null,
      "info": null
    },
    {
      "name": null,
      "version": "yZfmI44L",
      "imageUrl": null,
      "info": null
    },
    {
      "name": null,
      "version": "rm7wTj",
      "imageUrl": "ZQL",
      "info": null
    },
    {
      "name": null,
      "version": null,
      "imageUrl": "Jr",
      "info": "q"
    }
  ],
  "messageId": null,
  "systemMessage": "2XDTk",
  "isTest": true,
  "isInSharedChat": true,
  "isSharedChatHost": false,
  "isFromSharedChatGuest": false,
  "id": null,
  "total": 74,
  "cumulative_total": null,
  "sub_tier": null,
  "recipients": [
    {
      "id": null,
      "login": "uYNO2Lfg0Y",
      "name": "S",
      "type": "56"
    },
    {
      "id": null,
      "login": null,
      "name": null,
      "type": "0JURM"
    },
    {
      "id": "",
      "login": null,
      "name": null,
      "type": null
    },
    {
      "id": null,
      "login": "pOczVSg1E",
      "name": "O",
      "type": "xrzKRv"
    },
    {
      "id": null,
      "login": null,
      "name": "m3VkO",
      "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.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);
});