`Kick.ChannelUpdate`

WebSocket event schema, payload, and examples

Properties

channelId

string

channel

string

title

string

categoryId

integer required

categoryName

string

categoryThumbnail

string

oldTitle

string

oldCategoryId

integer required

oldCategoryName

string

oldCategoryThumbnail

string

is_test

boolean required

Schema

The JSON Schema for the event payload, if available.

schema.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "KickChannelUpdateEvent",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "channelId": {
      "type": [
        "null",
        "string"
      ]
    },
    "channel": {
      "type": [
        "null",
        "string"
      ]
    },
    "title": {
      "type": [
        "null",
        "string"
      ]
    },
    "categoryId": {
      "type": "integer",
      "format": "int32"
    },
    "categoryName": {
      "type": [
        "null",
        "string"
      ]
    },
    "categoryThumbnail": {
      "type": [
        "null",
        "string"
      ]
    },
    "oldTitle": {
      "type": [
        "null",
        "string"
      ]
    },
    "oldCategoryId": {
      "type": "integer",
      "format": "int32"
    },
    "oldCategoryName": {
      "type": [
        "null",
        "string"
      ]
    },
    "oldCategoryThumbnail": {
      "type": [
        "null",
        "string"
      ]
    },
    "is_test": {
      "type": "boolean"
    }
  }
}

JSON Payload

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

example.json

{
  "categoryId": -57723238,
  "categoryName": null,
  "categoryThumbnail": "Excepteur",
  "channel": "dolore ipsum pariatur in",
  "channelId": null,
  "is_test": true,
  "oldCategoryId": 95184716,
  "oldCategoryName": "esse occaecat labore nulla",
  "oldCategoryThumbnail": null,
  "oldTitle": null,
  "title": "incididunt cupidatat consectetur"
}

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