Twitch.PyramidBroken
WebSocket event schema, payload, and examples
total
integer required
width
integer required
emote
string
user
object required
display
string
id
string
name
string
role
integer required
Value | Name |
---|---|
0 | Unknown |
1 | Viewer |
2 | Vip |
3 | Moderator |
4 | Broadcaster |
subscribed
boolean required
type
string
ownerId
string
ownerUsername
string
ownerDisplay
string
Schema
The JSON Schema for the event payload, if available.
schema.json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "PyramidBrokenEvent",
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int32"
},
"width": {
"type": "integer",
"format": "int32"
},
"emote": {
"type": [
"null",
"string"
]
},
"user": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/BaseViewer"
}
]
},
"ownerId": {
"type": [
"null",
"string"
]
},
"ownerUsername": {
"type": [
"null",
"string"
]
},
"ownerDisplay": {
"type": [
"null",
"string"
]
}
},
"definitions": {
"BaseViewer": {
"type": "object",
"additionalProperties": false,
"properties": {
"display": {
"type": [
"null",
"string"
]
},
"id": {
"type": [
"null",
"string"
]
},
"name": {
"type": [
"null",
"string"
]
},
"role": {
"$ref": "#/definitions/ViewerRole"
},
"subscribed": {
"type": "boolean"
},
"type": {
"type": [
"null",
"string"
]
}
}
},
"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
{
"emote": "consectetur",
"ownerDisplay": "magna sint",
"ownerId": "commodo",
"ownerUsername": null,
"total": 1934090,
"user": {
"display": "ut sed do",
"id": null,
"name": "sint esse elit deserunt",
"role": 3,
"subscribed": false,
"type": "consectetur"
},
"width": 58293760
}
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.PyramidBroken" events and register a callback
client.on('Twitch.PyramidBroken', ({ 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);
});