Kick.MassGiftSubscription

WebSocket event schema, payload, and examples

Properties

isAnonymous
boolean required
user
object required
recipients
KickBaseUser[]
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": "1939-12-11T04:41:01.0Z",
  "isAnonymous": true,
  "isTest": false,
  "recipients": [
    {
      "id": "dolor esse pariatur non",
      "isSubscribed": false,
      "login": "consequat in sit magna",
      "name": "nisi magna et",
      "profilePicture": "consectetur cillum ea aliquip",
      "role": 3,
      "type": null
    },
    {
      "id": null,
      "isSubscribed": false,
      "login": null,
      "name": null,
      "profilePicture": null,
      "role": 3,
      "type": "et sit minim"
    },
    {
      "id": null,
      "isSubscribed": false,
      "login": "ea consequat",
      "name": null,
      "profilePicture": "Excepteur cillum",
      "role": 2,
      "type": null
    },
    {
      "id": "deserunt sint laboris",
      "isSubscribed": true,
      "login": null,
      "name": null,
      "profilePicture": null,
      "role": 1,
      "type": "Duis sunt Ut anim"
    },
    {
      "id": null,
      "isSubscribed": true,
      "login": null,
      "name": null,
      "profilePicture": null,
      "role": 3,
      "type": null
    }
  ],
  "subscribedAt": "1912-12-19T12:44:59.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);
});