`Kick.MassGiftSubscription`

WebSocket event schema, payload, and examples

Properties

isAnonymous

boolean required

user

object required

Value	Name
0	Unknown
1	Viewer
2	Vip
3	Moderator
4	Broadcaster

recipients

KickBaseUser[]

Value	Name
0	Unknown
1	Viewer
2	Vip
3	Moderator
4	Broadcaster

subscribedAt

string required

expiresAt

string required

isTest

boolean required

Schema

The JSON Schema for the event payload, if available.

schema.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "KickMassGiftSubscriptionEvent",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "isAnonymous": {
      "type": "boolean"
    },
    "user": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/definitions/KickBaseUser"
        }
      ]
    },
    "recipients": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/definitions/KickBaseUser"
      }
    },
    "subscribedAt": {
      "type": "string",
      "format": "date-time"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    },
    "isTest": {
      "type": "boolean"
    }
  },
  "definitions": {
    "KickBaseUser": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": [
            "null",
            "string"
          ]
        },
        "login": {
          "type": [
            "null",
            "string"
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "type": {
          "type": [
            "null",
            "string"
          ]
        },
        "profilePicture": {
          "type": [
            "null",
            "string"
          ]
        },
        "role": {
          "$ref": "#/definitions/ViewerRole"
        },
        "isSubscribed": {
          "type": "boolean"
        }
      }
    },
    "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
      ]
    }
  }
}

JSON Payload

An example JSON payload for the event, automatically generated using JSONSchemaFaker

example.json

{
  "expiresAt": "1922-11-10T07:49:16.0Z",
  "isAnonymous": false,
  "isTest": false,
  "recipients": [
    {
      "id": "irure ut ad aute",
      "isSubscribed": true,
      "login": null,
      "name": null,
      "profilePicture": null,
      "role": 2,
      "type": null
    },
    {
      "id": "qui elit commodo aute",
      "isSubscribed": true,
      "login": null,
      "name": null,
      "profilePicture": "fugiat ut dolore et",
      "role": 3,
      "type": "dolore adipisicing in occaecat ex"
    },
    {
      "id": null,
      "isSubscribed": true,
      "login": null,
      "name": "do Lorem quis",
      "profilePicture": null,
      "role": 4,
      "type": "Excepteur sed esse"
    },
    {
      "id": "in exercitation sunt minim",
      "isSubscribed": false,
      "login": null,
      "name": "Lorem",
      "profilePicture": null,
      "role": 1,
      "type": "sit aute est ut"
    },
    {
      "id": "consequat ullamco amet",
      "isSubscribed": true,
      "login": "tempor culpa eu cupidatat in",
      "name": "nulla",
      "profilePicture": "proident anim",
      "role": 1,
      "type": "officia"
    }
  ],
  "subscribedAt": "1909-09-20T10:25:55.0Z",
  "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 "Kick.MassGiftSubscription" events and register a callback
client.on('Kick.MassGiftSubscription', ({ 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);
});