Custom.Event
WebSocket event schema, payload, and examples
eventName
string
useArgs
boolean required
args
object
Schema
The JSON Schema for the event payload, if available.
schema.json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CustomTrigger",
"type": "object",
"additionalProperties": false,
"properties": {
"eventName": {
"type": [
"null",
"string"
]
},
"useArgs": {
"type": "boolean"
},
"args": {
"type": [
"null",
"object"
],
"additionalProperties": {}
}
}
}
JSON Payload
An example JSON payload for the event, automatically generated using JSONSchemaFaker
example.json
{
"args": {
"adipisicingdf": {},
"dolore779": {},
"esse_e25": {},
"quis0b": {},
"sinte47": {},
"Ut_2c": {}
},
"eventName": null,
"useArgs": false
}
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 "Custom.Event" events and register a callback
client.on('Custom.Event', ({ 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);
});