Application.ActionAdded

WebSocket event schema, payload, and examples

Properties

id
string required
name
string
group
string
enabled
boolean required
random
boolean required
concurrent
boolean required
alwaysRun
boolean required
excludeFromHistory
boolean required
excludeFromPending
boolean required

Schema

The JSON Schema for the event payload, if available.
schema.json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ApplicationActionEvent",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "format": "guid"
    },
    "name": {
      "type": [
        "null",
        "string"
      ]
    },
    "group": {
      "type": [
        "null",
        "string"
      ]
    },
    "enabled": {
      "type": "boolean"
    },
    "random": {
      "type": "boolean"
    },
    "concurrent": {
      "type": "boolean"
    },
    "alwaysRun": {
      "type": "boolean"
    },
    "excludeFromHistory": {
      "type": "boolean"
    },
    "excludeFromPending": {
      "type": "boolean"
    }
  }
}

JSON Payload

An example JSON payload for the event, automatically generated using JSONSchemaFaker
example.json
{
  "alwaysRun": true,
  "concurrent": false,
  "enabled": false,
  "excludeFromHistory": true,
  "excludeFromPending": true,
  "group": "id dolor Ut incididunt",
  "id": "7bde9d31-f9a0-44c8-9c76-8f03f91baa1e",
  "name": "proident",
  "random": 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 "Application.ActionAdded" events and register a callback
client.on('Application.ActionAdded', ({ 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);
});