Auctions Event

Auctions Event - Example

{
  "channel": {
    "_id": 40657,
    "id": 19889057,
    "name": "TheElm"
  },
  "data": {
    "auctions": {
      "options": []
    }
  },
  "platform": "twitch"
}


Audio Event

Audio Event - Example

{
  "channel": {
    "_id": 40657,
    "id": 19889057,
    "name": "TheElm"
  },
  "data": {
    "audio": {}
  },
  "platform": "twitch"
}

Authorize Event

Authorize Event - Example

{
  "data": {
    "authorize": {}
  }
}

Bets Event

Bets Event - Example

{
  "channel": {
    "_id": 40657,
    "id": 19889057,
    "name": "TheElm"
  },
  "data": {
    "bets": {
      "options": [
        "Red",
        "Blue",
        "Green"
      ]
    }
  },
  "platform": "twitch"
}

Bits Event

Bits Event - Example

{
  "channel": {
    "_id": 40657,
    "id": 19889057,
    "name": "TheElm"
  },
  "data": {
    "bits": {
      "sender": {
        "id": 19889057,
        "name": "TheElm"
      },
      "bits": {
        "amount": 100
      }
    }
  },
  "platform": "twitch"
}

Channel Event

Channel Event - Example

{
  "channel": {
    "_id": 40657,
    "id": 19889057,
    "name": "TheElm"
  },
  "data": {
    "channel": {
      "action": "join",
      "game": "Programming",
      "images": {
        "stream": "",
        "game": ""
      },
      "title": "Come and watch!"
    }
  },
  "platform": "twitch"
}

The channel event is sent when an entity instructs the bot to JOIN or PART a channel.


Command Event

Command Create/Update Event - Example

{
  "channel": {
    "_id": 40657,
    "id": 19889057,
    "name": "TheElm"
  },
  "data": {
    "command": [
      {
        "cost": 0,
        "createdAt": 1512241560,
        "currency": 0,
        "enabled": true,
        "hidden": false,
        "name": "!command",
        "parameters": {},
        "permission": "PUBLIC",
        "states": {},
        "scope": "account",
        "text": "Custom text output goes here!",
        "type": "text"
      }
    ]
  },
  "platform": "twitch"
}

Command Delete Event - Example

{
  "channel": {
    "_id": 40657,
    "id": 19889057,
    "name": "TheElm"
  },
  "data": {
    "command": [
      {
        "name": "!deleteme",
        "scope": "account",
        "type": null
      }
    ]
  },
  "platform": "twitch"
}

Command Execute Event - Example

{
  "channel": {
    "_id": 40657,
    "id": 19889057,
    "name": "TheElm"
  },
  "data": {
    "command": [
      {
        "name": "!executedcommand",
        "scope": "account",
        "execute": ""
      }
    ]
  },
  "platform": "twitch"
}

The command event is sent when a command, or group of commands, is updated. The "command" field will contain an array of updated commands.


Donation Event

Donation Event - Example

{
  "channel": {
    "_id": 40657,
    "id": 19889057,
    "name": "TheElm"
  },
  "data": {
    "donation": {
      "sender": {
        "name": "Greg"
      },
      "donation": {
        "message": "",
        "amount": 21.5,
        "currency": "USD"
      }
    }
  },
  "platform": "twitch"
}

Follower Event

Follower Event - Example

{
  "channel": {
    "_id": 40657,
    "id": 19889057,
    "name": "TheElm"
  },
  "data": {
    "follower": {
      "user": {
        "id": 19889057,
        "name": "TheElm"
      }
    }
  },
  "platform": "twitch"
}

Host Event

Host Event - Example

{
  "channel": {
    "_id": 40657,
    "id": 19889057,
    "name": "TheElm"
  },
  "data": {
    "host": {
      "sender": {
        "id": 19889057,
        "name": "TheElm"
      }
    }
  },
  "platform": "twitch"
}

Listen Event

Listen Event - Example

{
  "method": "listen",
  "data": [
    {
      "channel": 1,
      "events": [
        "event"
      ]
    },
    {
      "channel": 2,
      "events": [
        "event"
      ]
    }
  ]
}

Raid Event

Raid Event - Example

{
  "channel": {
    "_id": 40657,
    "id": 19889057,
    "name": "TheElm"
  },
  "data": {
    "raid": {
      "sender": {
        "id": 19889057,
        "name": "TheElm"
      },
      "viewers": {
        "count": 40
      }
    }
  },
  "platform": "twitch"
}

Raffles Event

Raffles Event - Example

{
  "channel": {
    "_id": 40657,
    "id": 19889057,
    "name": "TheElm"
  },
  "data": {
    "raffles": {}
  },
  "platform": "twitch"
}

Remote Event

Remote Event - Example

{
  "channel": {
    "_id": 40657,
    "id": 19889057,
    "name": "TheElm"
  },
  "data": {
    "remote": {}
  },
  "platform": "twitch"
}

Stream Event

Stream Event - Example

{
  "channel": {
    "_id": 40657,
    "id": 19889057,
    "name": "TheElm"
  },
  "data": {
    "stream": {
      "viewers": 0,
      "live": "STREAM-ID-OR-NULL",
      "uptime": 0
    }
  },
  "platform": "twitch"
}

Subscriber Event

Subscriber Event - Example

{
  "channel": {
    "_id": 40657,
    "id": 19889057,
    "name": "TheElm"
  },
  "data": {
    "subscriber": {
      "sender": {
        "id": 19889057,
        "name": "TheElm"
      },
      "subscription": {
        "tier": "",
        "name": "",
        "span": 8
      },
      "message": ""
    }
  },
  "platform": "twitch"
}

Unlisten Event

Unlisten Event - Example

{
  "method": "unlisten",
  "data": [
    {
      "channel": 1,
      "events": [
        "event"
      ]
    },
    {
      "channel": 2,
      "events": [
        "event"
      ]
    }
  ]
}

Boss Nation, LLC © 2015 - 2019 | All rights reserved.