Developer
Log in

Reference

Events

23 events. Each comes while you follow its topic: as its own notification when you subscribe with "typed_events": true, or else as an event notification with its untyped name.

EventTopicWhat happenedUntyped name
scene.changedscenesA scene went on air.scene.changed
chat.messagechatA chat message arrived on any platform, including messages sent from Studio, /me actions, channel notices, bot replies and announcements (kind says which).chat.message
chat.deletedchatA moderator (or a ban or timeout) removed chat messages.chat.deleted
chat.editedchatA chat message was edited.chat.edited
chat.clearedchatA platform's chat was cleared for everyone.chat.cleared
activity.followactivitySomeone followed.activity
activity.subactivitySomeone subscribed.activity
activity.resubactivitySomeone renewed their subscription and said so.activity
activity.gift_subactivitySomeone gifted subscriptions (amount.value is how many, with unit subs).activity
activity.supportactivitySupport with an amount: Velora Volts, Twitch bits, Kick KICKs, YouTube Super Chats. amount says how much and in what unit.activity
activity.redemptionactivityA channel-points (or Kick rewards) redemption. title is the reward's.activity
activity.raidactivityAnother channel raided this one. amount.value is how many viewers came, when the platform says.activity
activity.cardactivityA poll, prediction, giveaway, goal or clip, shown as a card. It may change in place later (activity.updated).activity
activity.updatedactivityAn activity row changed in place, such as a poll's votes; same eid as before.activity.updated
record.pausedrecordThe recording was paused: nothing more goes in until it resumes.record.paused
record.resumedrecordThe recording carries on in the same file, with no gap in its timeline.record.resumed
replay.startedreplayThe replay buffer started keeping the last seconds of what's on air.replay.started
replay.stoppedreplayThe replay buffer stopped; what it held was let go.replay.stopped
replay.savedreplayA replay was saved to a file.replay.saved
media.changedmediaA media source started, paused, stopped, ended, went on or off air, or moved to another playlist item.media.changed
obs.custom_eventactivityAn identified v5 client broadcast a custom event.obs.custom_event
web.changedwebA web source's page failed to load (it's see-through on air and tried again by itself), failed for another reason, or loaded.web.changed
captions.sentstreamClosed caption text went into the stream or recording (captions.send, obs-websocket's SendStreamCaption, or a plugin).captions.sent

scene.changedScene changed

A scene went on air.

topic scenes untyped: scene.changed

Data

SceneChanged

  • namestringalwayscan be null

    Its name.

  • scenestring (uuid)always

    The id of the scene now on air.

In the SDKs

C#
studio.SceneChanged += (_, e) => { /* e is SceneChangedEvent */ };
TypeScript
studio.on("scene.changed", (e) => { /* e is SceneChanged */ });
Python
studio.on(EventType.SCENE_CHANGED, handler)  # handler gets a SceneChangedEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Its name.",
      "type": [
        "string",
        "null"
      ]
    },
    "scene": {
      "description": "The id of the scene now on air.",
      "format": "uuid",
      "type": "string"
    }
  },
  "required": [
    "scene",
    "name"
  ],
  "title": "SceneChanged",
  "type": "object"
}

chat.messageChat message

A chat message arrived on any platform, including messages sent from Studio, /me actions, channel notices, bot replies and announcements (kind says which).

topic chat untyped: chat.message

Data

A ChatRow. See its fields under Shapes.

One row of chat or one activity, as Studio's chat panel shows it.

In the SDKs

C#
studio.ChatMessage += (_, e) => { /* e is ChatMessageEvent */ };
TypeScript
studio.on("chat.message", (e) => { /* e is ChatRow */ });
Python
studio.on(EventType.CHAT_MESSAGE, handler)  # handler gets a ChatMessageEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "description": "One row of chat or one activity, as Studio's chat panel shows it.",
  "properties": {
    "accent": {
      "description": "An accent color the platform gives it, \"#RRGGBB\".",
      "type": [
        "string",
        "null"
      ]
    },
    "amount": {
      "additionalProperties": false,
      "description": "Support with a number, kept as a value and its unit, never as text read as money.",
      "properties": {
        "display": {
          "description": "As the platform shows it, such as \"1,000 bits\" or \"$4.99\".",
          "type": "string"
        },
        "months": {
          "type": [
            "integer",
            "null"
          ]
        },
        "tier": {
          "type": [
            "string",
            "null"
          ]
        },
        "unit": {
          "description": "volts, bits, kicks, points, subs (a gift's count), viewers (a raid's), or a currency code such as USD for real money.",
          "type": "string"
        },
        "value": {
          "type": "number"
        }
      },
      "required": [
        "value",
        "unit",
        "display",
        "tier",
        "months"
      ],
      "title": "ChatAmount",
      "type": [
        "object",
        "null"
      ]
    },
    "art": {
      "description": "The platform's own picture for it (a reward's art).",
      "type": [
        "string",
        "null"
      ]
    },
    "author": {
      "additionalProperties": false,
      "properties": {
        "avatar": {
          "description": "A link to their picture.",
          "type": [
            "string",
            "null"
          ]
        },
        "badges": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "image": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "label": {
                "description": "Shown on hover.",
                "type": "string"
              },
              "rotates": {
                "description": "One of the badges that take turns in one place (Velora's badge strip); absent = false.",
                "type": "boolean"
              }
            },
            "required": [
              "id",
              "label",
              "image"
            ],
            "title": "ChatBadge",
            "type": "object"
          },
          "type": "array"
        },
        "color": {
          "description": "Their name's color, \"#RRGGBB\".",
          "type": [
            "string",
            "null"
          ]
        },
        "display": {
          "description": "Their display name.",
          "type": "string"
        },
        "id": {
          "description": "Their id on the platform.",
          "type": "string"
        },
        "login": {
          "description": "Their login name.",
          "type": "string"
        },
        "pronouns": {
          "type": [
            "string",
            "null"
          ]
        },
        "roles": {
          "additionalProperties": false,
          "properties": {
            "bot": {
              "type": "boolean"
            },
            "broadcaster": {
              "type": "boolean"
            },
            "moderator": {
              "type": "boolean"
            },
            "staff": {
              "type": "boolean"
            },
            "subscriber": {
              "type": "boolean"
            },
            "vip": {
              "type": "boolean"
            }
          },
          "required": [
            "broadcaster",
            "moderator",
            "vip",
            "subscriber",
            "bot",
            "staff"
          ],
          "title": "ChatRoles",
          "type": "object"
        }
      },
      "required": [
        "id",
        "login",
        "display",
        "color",
        "avatar",
        "pronouns",
        "roles",
        "badges"
      ],
      "title": "ChatAuthor",
      "type": [
        "object",
        "null"
      ]
    },
    "channel": {
      "description": "The channel's id on its platform.",
      "type": "string"
    },
    "eid": {
      "description": "Studio's number for this row, for chat.deleted and chat.edited.",
      "type": "integer"
    },
    "flags": {
      "additionalProperties": false,
      "properties": {
        "edited": {
          "type": "boolean"
        },
        "first_message": {
          "type": "boolean"
        },
        "highlighted": {
          "type": "boolean"
        },
        "own": {
          "description": "Sent from this Studio.",
          "type": "boolean"
        },
        "replay": {
          "description": "An alert shown again on stream.",
          "type": "boolean"
        }
      },
      "required": [
        "first_message",
        "highlighted",
        "edited",
        "own",
        "replay"
      ],
      "title": "ChatFlags",
      "type": "object"
    },
    "kind": {
      "enum": [
        "message",
        "action",
        "system",
        "bot",
        "announcement",
        "follow",
        "sub",
        "resub",
        "gift_sub",
        "support",
        "redemption",
        "raid",
        "card"
      ],
      "title": "ChatRowKind",
      "type": "string"
    },
    "meta": {
      "description": "Anything else the platform sent that Studio doesn't describe yet. Any JSON; don't rely on its shape."
    },
    "native_id": {
      "description": "The platform's id for this message.",
      "type": [
        "string",
        "null"
      ]
    },
    "parts": {
      "items": {
        "description": "A piece of a message, told apart by t: text, an emote, a mention, a link, or styled words (Velora chat's **bold** and *italic*).",
        "oneOf": [
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "text"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "animated": {
                "type": "boolean"
              },
              "code": {
                "description": "What was typed.",
                "type": "string"
              },
              "scales": {
                "description": "Its 1x, 2x and 4x pictures, when the service has them.",
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "source": {
                "description": "Where it's from, such as \"7TV · channel\".",
                "type": "string"
              },
              "t": {
                "const": "emote"
              },
              "url": {
                "description": "The emote's picture (2x).",
                "type": "string"
              },
              "zero_width": {
                "description": "Drawn on top of the emote before it.",
                "type": "boolean"
              }
            },
            "required": [
              "t",
              "code",
              "url",
              "animated"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "login": {
                "type": "string"
              },
              "t": {
                "const": "mention"
              }
            },
            "required": [
              "t",
              "login"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "link"
              },
              "url": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "url"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "bold": {
                "type": "boolean"
              },
              "italic": {
                "type": "boolean"
              },
              "t": {
                "const": "styled"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          }
        ],
        "title": "ChatPart"
      },
      "type": "array"
    },
    "platform": {
      "enum": [
        "velora",
        "twitch",
        "kick",
        "youtube",
        "owncast",
        "rumble"
      ],
      "title": "ChatPlatform",
      "type": "string"
    },
    "reply_to": {
      "additionalProperties": false,
      "properties": {
        "author": {
          "type": "string"
        },
        "excerpt": {
          "type": "string"
        },
        "native_id": {
          "type": "string"
        }
      },
      "required": [
        "native_id",
        "author",
        "excerpt"
      ],
      "title": "ChatReplyTo",
      "type": [
        "object",
        "null"
      ]
    },
    "state": {
      "description": "live, or deleted (with who deleted it, when known).",
      "oneOf": [
        {
          "additionalProperties": false,
          "properties": {
            "t": {
              "const": "live"
            }
          },
          "required": [
            "t"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "by": {
              "type": [
                "string",
                "null"
              ]
            },
            "t": {
              "const": "deleted"
            }
          },
          "required": [
            "t",
            "by"
          ],
          "type": "object"
        }
      ],
      "title": "ChatRowState"
    },
    "text": {
      "description": "The plain text.",
      "type": "string"
    },
    "title": {
      "description": "A card's headline: a reward's title, \"Poll ended\"…",
      "type": [
        "string",
        "null"
      ]
    },
    "ts": {
      "description": "When, in Unix milliseconds.",
      "type": "integer"
    }
  },
  "required": [
    "eid",
    "platform",
    "channel",
    "native_id",
    "ts",
    "kind",
    "author",
    "parts",
    "text",
    "reply_to",
    "amount",
    "title",
    "art",
    "accent",
    "flags",
    "state",
    "meta"
  ],
  "title": "ChatRow",
  "type": "object"
}

chat.deletedChat messages deleted

A moderator (or a ban or timeout) removed chat messages.

topic chat untyped: chat.deleted

Data

ChatDeleted

  • bystringalwayscan be null

    Who removed them, when the platform says.

  • eidsarray of integeralways

    The rows removed, by eid (as chat.message gave them).

In the SDKs

C#
studio.ChatDeleted += (_, e) => { /* e is ChatDeletedEvent */ };
TypeScript
studio.on("chat.deleted", (e) => { /* e is ChatDeleted */ });
Python
studio.on(EventType.CHAT_DELETED, handler)  # handler gets a ChatDeletedEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "properties": {
    "by": {
      "description": "Who removed them, when the platform says.",
      "type": [
        "string",
        "null"
      ]
    },
    "eids": {
      "description": "The rows removed, by eid (as chat.message gave them).",
      "items": {
        "type": "integer"
      },
      "type": "array"
    }
  },
  "required": [
    "eids",
    "by"
  ],
  "title": "ChatDeleted",
  "type": "object"
}

chat.editedChat message edited

A chat message was edited.

topic chat untyped: chat.edited

Data

ChatEdited

  • eidintegeralways

    The row edited.

  • partsarray of ChatPartoptional

    Its new text in pieces (emotes, links, Velora's bold and italic), as a row's parts. Absent from Studio before 0.1.1-beta.44.

  • textstringalways

    Its new text.

In the SDKs

C#
studio.ChatEdited += (_, e) => { /* e is ChatEditedEvent */ };
TypeScript
studio.on("chat.edited", (e) => { /* e is ChatEdited */ });
Python
studio.on(EventType.CHAT_EDITED, handler)  # handler gets a ChatEditedEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "properties": {
    "eid": {
      "description": "The row edited.",
      "type": "integer"
    },
    "parts": {
      "description": "Its new text in pieces (emotes, links, Velora's bold and italic), as a row's parts. Absent from Studio before 0.1.1-beta.44.",
      "items": {
        "description": "A piece of a message, told apart by t: text, an emote, a mention, a link, or styled words (Velora chat's **bold** and *italic*).",
        "oneOf": [
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "text"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "animated": {
                "type": "boolean"
              },
              "code": {
                "description": "What was typed.",
                "type": "string"
              },
              "scales": {
                "description": "Its 1x, 2x and 4x pictures, when the service has them.",
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "source": {
                "description": "Where it's from, such as \"7TV · channel\".",
                "type": "string"
              },
              "t": {
                "const": "emote"
              },
              "url": {
                "description": "The emote's picture (2x).",
                "type": "string"
              },
              "zero_width": {
                "description": "Drawn on top of the emote before it.",
                "type": "boolean"
              }
            },
            "required": [
              "t",
              "code",
              "url",
              "animated"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "login": {
                "type": "string"
              },
              "t": {
                "const": "mention"
              }
            },
            "required": [
              "t",
              "login"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "link"
              },
              "url": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "url"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "bold": {
                "type": "boolean"
              },
              "italic": {
                "type": "boolean"
              },
              "t": {
                "const": "styled"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          }
        ],
        "title": "ChatPart"
      },
      "type": "array"
    },
    "text": {
      "description": "Its new text.",
      "type": "string"
    }
  },
  "required": [
    "eid",
    "text"
  ],
  "title": "ChatEdited",
  "type": "object"
}

chat.clearedChat cleared

A platform's chat was cleared for everyone.

topic chat untyped: chat.cleared

Data

ChatCleared

  • channelstringalways

    The channel's id on its platform.

  • platformChatPlatform (string)always

    One of "velora" "twitch" "kick" "youtube" "owncast" "rumble"

In the SDKs

C#
studio.ChatCleared += (_, e) => { /* e is ChatClearedEvent */ };
TypeScript
studio.on("chat.cleared", (e) => { /* e is ChatCleared */ });
Python
studio.on(EventType.CHAT_CLEARED, handler)  # handler gets a ChatClearedEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "properties": {
    "channel": {
      "description": "The channel's id on its platform.",
      "type": "string"
    },
    "platform": {
      "enum": [
        "velora",
        "twitch",
        "kick",
        "youtube",
        "owncast",
        "rumble"
      ],
      "title": "ChatPlatform",
      "type": "string"
    }
  },
  "required": [
    "platform",
    "channel"
  ],
  "title": "ChatCleared",
  "type": "object"
}

activity.followFollow

Someone followed.

topic activity untyped: activity

Data

A ChatRow. See its fields under Shapes.

One row of chat or one activity, as Studio's chat panel shows it.

In the SDKs

C#
studio.ActivityFollow += (_, e) => { /* e is ActivityFollowEvent */ };
TypeScript
studio.on("activity.follow", (e) => { /* e is ChatRow */ });
Python
studio.on(EventType.ACTIVITY_FOLLOW, handler)  # handler gets a ActivityFollowEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "description": "One row of chat or one activity, as Studio's chat panel shows it.",
  "properties": {
    "accent": {
      "description": "An accent color the platform gives it, \"#RRGGBB\".",
      "type": [
        "string",
        "null"
      ]
    },
    "amount": {
      "additionalProperties": false,
      "description": "Support with a number, kept as a value and its unit, never as text read as money.",
      "properties": {
        "display": {
          "description": "As the platform shows it, such as \"1,000 bits\" or \"$4.99\".",
          "type": "string"
        },
        "months": {
          "type": [
            "integer",
            "null"
          ]
        },
        "tier": {
          "type": [
            "string",
            "null"
          ]
        },
        "unit": {
          "description": "volts, bits, kicks, points, subs (a gift's count), viewers (a raid's), or a currency code such as USD for real money.",
          "type": "string"
        },
        "value": {
          "type": "number"
        }
      },
      "required": [
        "value",
        "unit",
        "display",
        "tier",
        "months"
      ],
      "title": "ChatAmount",
      "type": [
        "object",
        "null"
      ]
    },
    "art": {
      "description": "The platform's own picture for it (a reward's art).",
      "type": [
        "string",
        "null"
      ]
    },
    "author": {
      "additionalProperties": false,
      "properties": {
        "avatar": {
          "description": "A link to their picture.",
          "type": [
            "string",
            "null"
          ]
        },
        "badges": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "image": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "label": {
                "description": "Shown on hover.",
                "type": "string"
              },
              "rotates": {
                "description": "One of the badges that take turns in one place (Velora's badge strip); absent = false.",
                "type": "boolean"
              }
            },
            "required": [
              "id",
              "label",
              "image"
            ],
            "title": "ChatBadge",
            "type": "object"
          },
          "type": "array"
        },
        "color": {
          "description": "Their name's color, \"#RRGGBB\".",
          "type": [
            "string",
            "null"
          ]
        },
        "display": {
          "description": "Their display name.",
          "type": "string"
        },
        "id": {
          "description": "Their id on the platform.",
          "type": "string"
        },
        "login": {
          "description": "Their login name.",
          "type": "string"
        },
        "pronouns": {
          "type": [
            "string",
            "null"
          ]
        },
        "roles": {
          "additionalProperties": false,
          "properties": {
            "bot": {
              "type": "boolean"
            },
            "broadcaster": {
              "type": "boolean"
            },
            "moderator": {
              "type": "boolean"
            },
            "staff": {
              "type": "boolean"
            },
            "subscriber": {
              "type": "boolean"
            },
            "vip": {
              "type": "boolean"
            }
          },
          "required": [
            "broadcaster",
            "moderator",
            "vip",
            "subscriber",
            "bot",
            "staff"
          ],
          "title": "ChatRoles",
          "type": "object"
        }
      },
      "required": [
        "id",
        "login",
        "display",
        "color",
        "avatar",
        "pronouns",
        "roles",
        "badges"
      ],
      "title": "ChatAuthor",
      "type": [
        "object",
        "null"
      ]
    },
    "channel": {
      "description": "The channel's id on its platform.",
      "type": "string"
    },
    "eid": {
      "description": "Studio's number for this row, for chat.deleted and chat.edited.",
      "type": "integer"
    },
    "flags": {
      "additionalProperties": false,
      "properties": {
        "edited": {
          "type": "boolean"
        },
        "first_message": {
          "type": "boolean"
        },
        "highlighted": {
          "type": "boolean"
        },
        "own": {
          "description": "Sent from this Studio.",
          "type": "boolean"
        },
        "replay": {
          "description": "An alert shown again on stream.",
          "type": "boolean"
        }
      },
      "required": [
        "first_message",
        "highlighted",
        "edited",
        "own",
        "replay"
      ],
      "title": "ChatFlags",
      "type": "object"
    },
    "kind": {
      "enum": [
        "message",
        "action",
        "system",
        "bot",
        "announcement",
        "follow",
        "sub",
        "resub",
        "gift_sub",
        "support",
        "redemption",
        "raid",
        "card"
      ],
      "title": "ChatRowKind",
      "type": "string"
    },
    "meta": {
      "description": "Anything else the platform sent that Studio doesn't describe yet. Any JSON; don't rely on its shape."
    },
    "native_id": {
      "description": "The platform's id for this message.",
      "type": [
        "string",
        "null"
      ]
    },
    "parts": {
      "items": {
        "description": "A piece of a message, told apart by t: text, an emote, a mention, a link, or styled words (Velora chat's **bold** and *italic*).",
        "oneOf": [
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "text"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "animated": {
                "type": "boolean"
              },
              "code": {
                "description": "What was typed.",
                "type": "string"
              },
              "scales": {
                "description": "Its 1x, 2x and 4x pictures, when the service has them.",
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "source": {
                "description": "Where it's from, such as \"7TV · channel\".",
                "type": "string"
              },
              "t": {
                "const": "emote"
              },
              "url": {
                "description": "The emote's picture (2x).",
                "type": "string"
              },
              "zero_width": {
                "description": "Drawn on top of the emote before it.",
                "type": "boolean"
              }
            },
            "required": [
              "t",
              "code",
              "url",
              "animated"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "login": {
                "type": "string"
              },
              "t": {
                "const": "mention"
              }
            },
            "required": [
              "t",
              "login"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "link"
              },
              "url": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "url"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "bold": {
                "type": "boolean"
              },
              "italic": {
                "type": "boolean"
              },
              "t": {
                "const": "styled"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          }
        ],
        "title": "ChatPart"
      },
      "type": "array"
    },
    "platform": {
      "enum": [
        "velora",
        "twitch",
        "kick",
        "youtube",
        "owncast",
        "rumble"
      ],
      "title": "ChatPlatform",
      "type": "string"
    },
    "reply_to": {
      "additionalProperties": false,
      "properties": {
        "author": {
          "type": "string"
        },
        "excerpt": {
          "type": "string"
        },
        "native_id": {
          "type": "string"
        }
      },
      "required": [
        "native_id",
        "author",
        "excerpt"
      ],
      "title": "ChatReplyTo",
      "type": [
        "object",
        "null"
      ]
    },
    "state": {
      "description": "live, or deleted (with who deleted it, when known).",
      "oneOf": [
        {
          "additionalProperties": false,
          "properties": {
            "t": {
              "const": "live"
            }
          },
          "required": [
            "t"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "by": {
              "type": [
                "string",
                "null"
              ]
            },
            "t": {
              "const": "deleted"
            }
          },
          "required": [
            "t",
            "by"
          ],
          "type": "object"
        }
      ],
      "title": "ChatRowState"
    },
    "text": {
      "description": "The plain text.",
      "type": "string"
    },
    "title": {
      "description": "A card's headline: a reward's title, \"Poll ended\"…",
      "type": [
        "string",
        "null"
      ]
    },
    "ts": {
      "description": "When, in Unix milliseconds.",
      "type": "integer"
    }
  },
  "required": [
    "eid",
    "platform",
    "channel",
    "native_id",
    "ts",
    "kind",
    "author",
    "parts",
    "text",
    "reply_to",
    "amount",
    "title",
    "art",
    "accent",
    "flags",
    "state",
    "meta"
  ],
  "title": "ChatRow",
  "type": "object"
}

activity.subSubscription

Someone subscribed.

topic activity untyped: activity

Data

A ChatRow. See its fields under Shapes.

One row of chat or one activity, as Studio's chat panel shows it.

In the SDKs

C#
studio.ActivitySub += (_, e) => { /* e is ActivitySubEvent */ };
TypeScript
studio.on("activity.sub", (e) => { /* e is ChatRow */ });
Python
studio.on(EventType.ACTIVITY_SUB, handler)  # handler gets a ActivitySubEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "description": "One row of chat or one activity, as Studio's chat panel shows it.",
  "properties": {
    "accent": {
      "description": "An accent color the platform gives it, \"#RRGGBB\".",
      "type": [
        "string",
        "null"
      ]
    },
    "amount": {
      "additionalProperties": false,
      "description": "Support with a number, kept as a value and its unit, never as text read as money.",
      "properties": {
        "display": {
          "description": "As the platform shows it, such as \"1,000 bits\" or \"$4.99\".",
          "type": "string"
        },
        "months": {
          "type": [
            "integer",
            "null"
          ]
        },
        "tier": {
          "type": [
            "string",
            "null"
          ]
        },
        "unit": {
          "description": "volts, bits, kicks, points, subs (a gift's count), viewers (a raid's), or a currency code such as USD for real money.",
          "type": "string"
        },
        "value": {
          "type": "number"
        }
      },
      "required": [
        "value",
        "unit",
        "display",
        "tier",
        "months"
      ],
      "title": "ChatAmount",
      "type": [
        "object",
        "null"
      ]
    },
    "art": {
      "description": "The platform's own picture for it (a reward's art).",
      "type": [
        "string",
        "null"
      ]
    },
    "author": {
      "additionalProperties": false,
      "properties": {
        "avatar": {
          "description": "A link to their picture.",
          "type": [
            "string",
            "null"
          ]
        },
        "badges": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "image": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "label": {
                "description": "Shown on hover.",
                "type": "string"
              },
              "rotates": {
                "description": "One of the badges that take turns in one place (Velora's badge strip); absent = false.",
                "type": "boolean"
              }
            },
            "required": [
              "id",
              "label",
              "image"
            ],
            "title": "ChatBadge",
            "type": "object"
          },
          "type": "array"
        },
        "color": {
          "description": "Their name's color, \"#RRGGBB\".",
          "type": [
            "string",
            "null"
          ]
        },
        "display": {
          "description": "Their display name.",
          "type": "string"
        },
        "id": {
          "description": "Their id on the platform.",
          "type": "string"
        },
        "login": {
          "description": "Their login name.",
          "type": "string"
        },
        "pronouns": {
          "type": [
            "string",
            "null"
          ]
        },
        "roles": {
          "additionalProperties": false,
          "properties": {
            "bot": {
              "type": "boolean"
            },
            "broadcaster": {
              "type": "boolean"
            },
            "moderator": {
              "type": "boolean"
            },
            "staff": {
              "type": "boolean"
            },
            "subscriber": {
              "type": "boolean"
            },
            "vip": {
              "type": "boolean"
            }
          },
          "required": [
            "broadcaster",
            "moderator",
            "vip",
            "subscriber",
            "bot",
            "staff"
          ],
          "title": "ChatRoles",
          "type": "object"
        }
      },
      "required": [
        "id",
        "login",
        "display",
        "color",
        "avatar",
        "pronouns",
        "roles",
        "badges"
      ],
      "title": "ChatAuthor",
      "type": [
        "object",
        "null"
      ]
    },
    "channel": {
      "description": "The channel's id on its platform.",
      "type": "string"
    },
    "eid": {
      "description": "Studio's number for this row, for chat.deleted and chat.edited.",
      "type": "integer"
    },
    "flags": {
      "additionalProperties": false,
      "properties": {
        "edited": {
          "type": "boolean"
        },
        "first_message": {
          "type": "boolean"
        },
        "highlighted": {
          "type": "boolean"
        },
        "own": {
          "description": "Sent from this Studio.",
          "type": "boolean"
        },
        "replay": {
          "description": "An alert shown again on stream.",
          "type": "boolean"
        }
      },
      "required": [
        "first_message",
        "highlighted",
        "edited",
        "own",
        "replay"
      ],
      "title": "ChatFlags",
      "type": "object"
    },
    "kind": {
      "enum": [
        "message",
        "action",
        "system",
        "bot",
        "announcement",
        "follow",
        "sub",
        "resub",
        "gift_sub",
        "support",
        "redemption",
        "raid",
        "card"
      ],
      "title": "ChatRowKind",
      "type": "string"
    },
    "meta": {
      "description": "Anything else the platform sent that Studio doesn't describe yet. Any JSON; don't rely on its shape."
    },
    "native_id": {
      "description": "The platform's id for this message.",
      "type": [
        "string",
        "null"
      ]
    },
    "parts": {
      "items": {
        "description": "A piece of a message, told apart by t: text, an emote, a mention, a link, or styled words (Velora chat's **bold** and *italic*).",
        "oneOf": [
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "text"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "animated": {
                "type": "boolean"
              },
              "code": {
                "description": "What was typed.",
                "type": "string"
              },
              "scales": {
                "description": "Its 1x, 2x and 4x pictures, when the service has them.",
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "source": {
                "description": "Where it's from, such as \"7TV · channel\".",
                "type": "string"
              },
              "t": {
                "const": "emote"
              },
              "url": {
                "description": "The emote's picture (2x).",
                "type": "string"
              },
              "zero_width": {
                "description": "Drawn on top of the emote before it.",
                "type": "boolean"
              }
            },
            "required": [
              "t",
              "code",
              "url",
              "animated"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "login": {
                "type": "string"
              },
              "t": {
                "const": "mention"
              }
            },
            "required": [
              "t",
              "login"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "link"
              },
              "url": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "url"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "bold": {
                "type": "boolean"
              },
              "italic": {
                "type": "boolean"
              },
              "t": {
                "const": "styled"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          }
        ],
        "title": "ChatPart"
      },
      "type": "array"
    },
    "platform": {
      "enum": [
        "velora",
        "twitch",
        "kick",
        "youtube",
        "owncast",
        "rumble"
      ],
      "title": "ChatPlatform",
      "type": "string"
    },
    "reply_to": {
      "additionalProperties": false,
      "properties": {
        "author": {
          "type": "string"
        },
        "excerpt": {
          "type": "string"
        },
        "native_id": {
          "type": "string"
        }
      },
      "required": [
        "native_id",
        "author",
        "excerpt"
      ],
      "title": "ChatReplyTo",
      "type": [
        "object",
        "null"
      ]
    },
    "state": {
      "description": "live, or deleted (with who deleted it, when known).",
      "oneOf": [
        {
          "additionalProperties": false,
          "properties": {
            "t": {
              "const": "live"
            }
          },
          "required": [
            "t"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "by": {
              "type": [
                "string",
                "null"
              ]
            },
            "t": {
              "const": "deleted"
            }
          },
          "required": [
            "t",
            "by"
          ],
          "type": "object"
        }
      ],
      "title": "ChatRowState"
    },
    "text": {
      "description": "The plain text.",
      "type": "string"
    },
    "title": {
      "description": "A card's headline: a reward's title, \"Poll ended\"…",
      "type": [
        "string",
        "null"
      ]
    },
    "ts": {
      "description": "When, in Unix milliseconds.",
      "type": "integer"
    }
  },
  "required": [
    "eid",
    "platform",
    "channel",
    "native_id",
    "ts",
    "kind",
    "author",
    "parts",
    "text",
    "reply_to",
    "amount",
    "title",
    "art",
    "accent",
    "flags",
    "state",
    "meta"
  ],
  "title": "ChatRow",
  "type": "object"
}

activity.resubResubscription

Someone renewed their subscription and said so.

topic activity untyped: activity

Data

A ChatRow. See its fields under Shapes.

One row of chat or one activity, as Studio's chat panel shows it.

In the SDKs

C#
studio.ActivityResub += (_, e) => { /* e is ActivityResubEvent */ };
TypeScript
studio.on("activity.resub", (e) => { /* e is ChatRow */ });
Python
studio.on(EventType.ACTIVITY_RESUB, handler)  # handler gets a ActivityResubEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "description": "One row of chat or one activity, as Studio's chat panel shows it.",
  "properties": {
    "accent": {
      "description": "An accent color the platform gives it, \"#RRGGBB\".",
      "type": [
        "string",
        "null"
      ]
    },
    "amount": {
      "additionalProperties": false,
      "description": "Support with a number, kept as a value and its unit, never as text read as money.",
      "properties": {
        "display": {
          "description": "As the platform shows it, such as \"1,000 bits\" or \"$4.99\".",
          "type": "string"
        },
        "months": {
          "type": [
            "integer",
            "null"
          ]
        },
        "tier": {
          "type": [
            "string",
            "null"
          ]
        },
        "unit": {
          "description": "volts, bits, kicks, points, subs (a gift's count), viewers (a raid's), or a currency code such as USD for real money.",
          "type": "string"
        },
        "value": {
          "type": "number"
        }
      },
      "required": [
        "value",
        "unit",
        "display",
        "tier",
        "months"
      ],
      "title": "ChatAmount",
      "type": [
        "object",
        "null"
      ]
    },
    "art": {
      "description": "The platform's own picture for it (a reward's art).",
      "type": [
        "string",
        "null"
      ]
    },
    "author": {
      "additionalProperties": false,
      "properties": {
        "avatar": {
          "description": "A link to their picture.",
          "type": [
            "string",
            "null"
          ]
        },
        "badges": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "image": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "label": {
                "description": "Shown on hover.",
                "type": "string"
              },
              "rotates": {
                "description": "One of the badges that take turns in one place (Velora's badge strip); absent = false.",
                "type": "boolean"
              }
            },
            "required": [
              "id",
              "label",
              "image"
            ],
            "title": "ChatBadge",
            "type": "object"
          },
          "type": "array"
        },
        "color": {
          "description": "Their name's color, \"#RRGGBB\".",
          "type": [
            "string",
            "null"
          ]
        },
        "display": {
          "description": "Their display name.",
          "type": "string"
        },
        "id": {
          "description": "Their id on the platform.",
          "type": "string"
        },
        "login": {
          "description": "Their login name.",
          "type": "string"
        },
        "pronouns": {
          "type": [
            "string",
            "null"
          ]
        },
        "roles": {
          "additionalProperties": false,
          "properties": {
            "bot": {
              "type": "boolean"
            },
            "broadcaster": {
              "type": "boolean"
            },
            "moderator": {
              "type": "boolean"
            },
            "staff": {
              "type": "boolean"
            },
            "subscriber": {
              "type": "boolean"
            },
            "vip": {
              "type": "boolean"
            }
          },
          "required": [
            "broadcaster",
            "moderator",
            "vip",
            "subscriber",
            "bot",
            "staff"
          ],
          "title": "ChatRoles",
          "type": "object"
        }
      },
      "required": [
        "id",
        "login",
        "display",
        "color",
        "avatar",
        "pronouns",
        "roles",
        "badges"
      ],
      "title": "ChatAuthor",
      "type": [
        "object",
        "null"
      ]
    },
    "channel": {
      "description": "The channel's id on its platform.",
      "type": "string"
    },
    "eid": {
      "description": "Studio's number for this row, for chat.deleted and chat.edited.",
      "type": "integer"
    },
    "flags": {
      "additionalProperties": false,
      "properties": {
        "edited": {
          "type": "boolean"
        },
        "first_message": {
          "type": "boolean"
        },
        "highlighted": {
          "type": "boolean"
        },
        "own": {
          "description": "Sent from this Studio.",
          "type": "boolean"
        },
        "replay": {
          "description": "An alert shown again on stream.",
          "type": "boolean"
        }
      },
      "required": [
        "first_message",
        "highlighted",
        "edited",
        "own",
        "replay"
      ],
      "title": "ChatFlags",
      "type": "object"
    },
    "kind": {
      "enum": [
        "message",
        "action",
        "system",
        "bot",
        "announcement",
        "follow",
        "sub",
        "resub",
        "gift_sub",
        "support",
        "redemption",
        "raid",
        "card"
      ],
      "title": "ChatRowKind",
      "type": "string"
    },
    "meta": {
      "description": "Anything else the platform sent that Studio doesn't describe yet. Any JSON; don't rely on its shape."
    },
    "native_id": {
      "description": "The platform's id for this message.",
      "type": [
        "string",
        "null"
      ]
    },
    "parts": {
      "items": {
        "description": "A piece of a message, told apart by t: text, an emote, a mention, a link, or styled words (Velora chat's **bold** and *italic*).",
        "oneOf": [
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "text"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "animated": {
                "type": "boolean"
              },
              "code": {
                "description": "What was typed.",
                "type": "string"
              },
              "scales": {
                "description": "Its 1x, 2x and 4x pictures, when the service has them.",
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "source": {
                "description": "Where it's from, such as \"7TV · channel\".",
                "type": "string"
              },
              "t": {
                "const": "emote"
              },
              "url": {
                "description": "The emote's picture (2x).",
                "type": "string"
              },
              "zero_width": {
                "description": "Drawn on top of the emote before it.",
                "type": "boolean"
              }
            },
            "required": [
              "t",
              "code",
              "url",
              "animated"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "login": {
                "type": "string"
              },
              "t": {
                "const": "mention"
              }
            },
            "required": [
              "t",
              "login"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "link"
              },
              "url": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "url"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "bold": {
                "type": "boolean"
              },
              "italic": {
                "type": "boolean"
              },
              "t": {
                "const": "styled"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          }
        ],
        "title": "ChatPart"
      },
      "type": "array"
    },
    "platform": {
      "enum": [
        "velora",
        "twitch",
        "kick",
        "youtube",
        "owncast",
        "rumble"
      ],
      "title": "ChatPlatform",
      "type": "string"
    },
    "reply_to": {
      "additionalProperties": false,
      "properties": {
        "author": {
          "type": "string"
        },
        "excerpt": {
          "type": "string"
        },
        "native_id": {
          "type": "string"
        }
      },
      "required": [
        "native_id",
        "author",
        "excerpt"
      ],
      "title": "ChatReplyTo",
      "type": [
        "object",
        "null"
      ]
    },
    "state": {
      "description": "live, or deleted (with who deleted it, when known).",
      "oneOf": [
        {
          "additionalProperties": false,
          "properties": {
            "t": {
              "const": "live"
            }
          },
          "required": [
            "t"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "by": {
              "type": [
                "string",
                "null"
              ]
            },
            "t": {
              "const": "deleted"
            }
          },
          "required": [
            "t",
            "by"
          ],
          "type": "object"
        }
      ],
      "title": "ChatRowState"
    },
    "text": {
      "description": "The plain text.",
      "type": "string"
    },
    "title": {
      "description": "A card's headline: a reward's title, \"Poll ended\"…",
      "type": [
        "string",
        "null"
      ]
    },
    "ts": {
      "description": "When, in Unix milliseconds.",
      "type": "integer"
    }
  },
  "required": [
    "eid",
    "platform",
    "channel",
    "native_id",
    "ts",
    "kind",
    "author",
    "parts",
    "text",
    "reply_to",
    "amount",
    "title",
    "art",
    "accent",
    "flags",
    "state",
    "meta"
  ],
  "title": "ChatRow",
  "type": "object"
}

activity.gift_subGifted subscriptions

Someone gifted subscriptions (amount.value is how many, with unit subs).

topic activity untyped: activity

Data

A ChatRow. See its fields under Shapes.

One row of chat or one activity, as Studio's chat panel shows it.

In the SDKs

C#
studio.ActivityGiftSub += (_, e) => { /* e is ActivityGiftSubEvent */ };
TypeScript
studio.on("activity.gift_sub", (e) => { /* e is ChatRow */ });
Python
studio.on(EventType.ACTIVITY_GIFT_SUB, handler)  # handler gets a ActivityGiftSubEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "description": "One row of chat or one activity, as Studio's chat panel shows it.",
  "properties": {
    "accent": {
      "description": "An accent color the platform gives it, \"#RRGGBB\".",
      "type": [
        "string",
        "null"
      ]
    },
    "amount": {
      "additionalProperties": false,
      "description": "Support with a number, kept as a value and its unit, never as text read as money.",
      "properties": {
        "display": {
          "description": "As the platform shows it, such as \"1,000 bits\" or \"$4.99\".",
          "type": "string"
        },
        "months": {
          "type": [
            "integer",
            "null"
          ]
        },
        "tier": {
          "type": [
            "string",
            "null"
          ]
        },
        "unit": {
          "description": "volts, bits, kicks, points, subs (a gift's count), viewers (a raid's), or a currency code such as USD for real money.",
          "type": "string"
        },
        "value": {
          "type": "number"
        }
      },
      "required": [
        "value",
        "unit",
        "display",
        "tier",
        "months"
      ],
      "title": "ChatAmount",
      "type": [
        "object",
        "null"
      ]
    },
    "art": {
      "description": "The platform's own picture for it (a reward's art).",
      "type": [
        "string",
        "null"
      ]
    },
    "author": {
      "additionalProperties": false,
      "properties": {
        "avatar": {
          "description": "A link to their picture.",
          "type": [
            "string",
            "null"
          ]
        },
        "badges": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "image": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "label": {
                "description": "Shown on hover.",
                "type": "string"
              },
              "rotates": {
                "description": "One of the badges that take turns in one place (Velora's badge strip); absent = false.",
                "type": "boolean"
              }
            },
            "required": [
              "id",
              "label",
              "image"
            ],
            "title": "ChatBadge",
            "type": "object"
          },
          "type": "array"
        },
        "color": {
          "description": "Their name's color, \"#RRGGBB\".",
          "type": [
            "string",
            "null"
          ]
        },
        "display": {
          "description": "Their display name.",
          "type": "string"
        },
        "id": {
          "description": "Their id on the platform.",
          "type": "string"
        },
        "login": {
          "description": "Their login name.",
          "type": "string"
        },
        "pronouns": {
          "type": [
            "string",
            "null"
          ]
        },
        "roles": {
          "additionalProperties": false,
          "properties": {
            "bot": {
              "type": "boolean"
            },
            "broadcaster": {
              "type": "boolean"
            },
            "moderator": {
              "type": "boolean"
            },
            "staff": {
              "type": "boolean"
            },
            "subscriber": {
              "type": "boolean"
            },
            "vip": {
              "type": "boolean"
            }
          },
          "required": [
            "broadcaster",
            "moderator",
            "vip",
            "subscriber",
            "bot",
            "staff"
          ],
          "title": "ChatRoles",
          "type": "object"
        }
      },
      "required": [
        "id",
        "login",
        "display",
        "color",
        "avatar",
        "pronouns",
        "roles",
        "badges"
      ],
      "title": "ChatAuthor",
      "type": [
        "object",
        "null"
      ]
    },
    "channel": {
      "description": "The channel's id on its platform.",
      "type": "string"
    },
    "eid": {
      "description": "Studio's number for this row, for chat.deleted and chat.edited.",
      "type": "integer"
    },
    "flags": {
      "additionalProperties": false,
      "properties": {
        "edited": {
          "type": "boolean"
        },
        "first_message": {
          "type": "boolean"
        },
        "highlighted": {
          "type": "boolean"
        },
        "own": {
          "description": "Sent from this Studio.",
          "type": "boolean"
        },
        "replay": {
          "description": "An alert shown again on stream.",
          "type": "boolean"
        }
      },
      "required": [
        "first_message",
        "highlighted",
        "edited",
        "own",
        "replay"
      ],
      "title": "ChatFlags",
      "type": "object"
    },
    "kind": {
      "enum": [
        "message",
        "action",
        "system",
        "bot",
        "announcement",
        "follow",
        "sub",
        "resub",
        "gift_sub",
        "support",
        "redemption",
        "raid",
        "card"
      ],
      "title": "ChatRowKind",
      "type": "string"
    },
    "meta": {
      "description": "Anything else the platform sent that Studio doesn't describe yet. Any JSON; don't rely on its shape."
    },
    "native_id": {
      "description": "The platform's id for this message.",
      "type": [
        "string",
        "null"
      ]
    },
    "parts": {
      "items": {
        "description": "A piece of a message, told apart by t: text, an emote, a mention, a link, or styled words (Velora chat's **bold** and *italic*).",
        "oneOf": [
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "text"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "animated": {
                "type": "boolean"
              },
              "code": {
                "description": "What was typed.",
                "type": "string"
              },
              "scales": {
                "description": "Its 1x, 2x and 4x pictures, when the service has them.",
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "source": {
                "description": "Where it's from, such as \"7TV · channel\".",
                "type": "string"
              },
              "t": {
                "const": "emote"
              },
              "url": {
                "description": "The emote's picture (2x).",
                "type": "string"
              },
              "zero_width": {
                "description": "Drawn on top of the emote before it.",
                "type": "boolean"
              }
            },
            "required": [
              "t",
              "code",
              "url",
              "animated"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "login": {
                "type": "string"
              },
              "t": {
                "const": "mention"
              }
            },
            "required": [
              "t",
              "login"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "link"
              },
              "url": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "url"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "bold": {
                "type": "boolean"
              },
              "italic": {
                "type": "boolean"
              },
              "t": {
                "const": "styled"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          }
        ],
        "title": "ChatPart"
      },
      "type": "array"
    },
    "platform": {
      "enum": [
        "velora",
        "twitch",
        "kick",
        "youtube",
        "owncast",
        "rumble"
      ],
      "title": "ChatPlatform",
      "type": "string"
    },
    "reply_to": {
      "additionalProperties": false,
      "properties": {
        "author": {
          "type": "string"
        },
        "excerpt": {
          "type": "string"
        },
        "native_id": {
          "type": "string"
        }
      },
      "required": [
        "native_id",
        "author",
        "excerpt"
      ],
      "title": "ChatReplyTo",
      "type": [
        "object",
        "null"
      ]
    },
    "state": {
      "description": "live, or deleted (with who deleted it, when known).",
      "oneOf": [
        {
          "additionalProperties": false,
          "properties": {
            "t": {
              "const": "live"
            }
          },
          "required": [
            "t"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "by": {
              "type": [
                "string",
                "null"
              ]
            },
            "t": {
              "const": "deleted"
            }
          },
          "required": [
            "t",
            "by"
          ],
          "type": "object"
        }
      ],
      "title": "ChatRowState"
    },
    "text": {
      "description": "The plain text.",
      "type": "string"
    },
    "title": {
      "description": "A card's headline: a reward's title, \"Poll ended\"…",
      "type": [
        "string",
        "null"
      ]
    },
    "ts": {
      "description": "When, in Unix milliseconds.",
      "type": "integer"
    }
  },
  "required": [
    "eid",
    "platform",
    "channel",
    "native_id",
    "ts",
    "kind",
    "author",
    "parts",
    "text",
    "reply_to",
    "amount",
    "title",
    "art",
    "accent",
    "flags",
    "state",
    "meta"
  ],
  "title": "ChatRow",
  "type": "object"
}

activity.supportSupport

Support with an amount: Velora Volts, Twitch bits, Kick KICKs, YouTube Super Chats. amount says how much and in what unit.

topic activity untyped: activity

Data

A ChatRow. See its fields under Shapes.

One row of chat or one activity, as Studio's chat panel shows it.

In the SDKs

C#
studio.ActivitySupport += (_, e) => { /* e is ActivitySupportEvent */ };
TypeScript
studio.on("activity.support", (e) => { /* e is ChatRow */ });
Python
studio.on(EventType.ACTIVITY_SUPPORT, handler)  # handler gets a ActivitySupportEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "description": "One row of chat or one activity, as Studio's chat panel shows it.",
  "properties": {
    "accent": {
      "description": "An accent color the platform gives it, \"#RRGGBB\".",
      "type": [
        "string",
        "null"
      ]
    },
    "amount": {
      "additionalProperties": false,
      "description": "Support with a number, kept as a value and its unit, never as text read as money.",
      "properties": {
        "display": {
          "description": "As the platform shows it, such as \"1,000 bits\" or \"$4.99\".",
          "type": "string"
        },
        "months": {
          "type": [
            "integer",
            "null"
          ]
        },
        "tier": {
          "type": [
            "string",
            "null"
          ]
        },
        "unit": {
          "description": "volts, bits, kicks, points, subs (a gift's count), viewers (a raid's), or a currency code such as USD for real money.",
          "type": "string"
        },
        "value": {
          "type": "number"
        }
      },
      "required": [
        "value",
        "unit",
        "display",
        "tier",
        "months"
      ],
      "title": "ChatAmount",
      "type": [
        "object",
        "null"
      ]
    },
    "art": {
      "description": "The platform's own picture for it (a reward's art).",
      "type": [
        "string",
        "null"
      ]
    },
    "author": {
      "additionalProperties": false,
      "properties": {
        "avatar": {
          "description": "A link to their picture.",
          "type": [
            "string",
            "null"
          ]
        },
        "badges": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "image": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "label": {
                "description": "Shown on hover.",
                "type": "string"
              },
              "rotates": {
                "description": "One of the badges that take turns in one place (Velora's badge strip); absent = false.",
                "type": "boolean"
              }
            },
            "required": [
              "id",
              "label",
              "image"
            ],
            "title": "ChatBadge",
            "type": "object"
          },
          "type": "array"
        },
        "color": {
          "description": "Their name's color, \"#RRGGBB\".",
          "type": [
            "string",
            "null"
          ]
        },
        "display": {
          "description": "Their display name.",
          "type": "string"
        },
        "id": {
          "description": "Their id on the platform.",
          "type": "string"
        },
        "login": {
          "description": "Their login name.",
          "type": "string"
        },
        "pronouns": {
          "type": [
            "string",
            "null"
          ]
        },
        "roles": {
          "additionalProperties": false,
          "properties": {
            "bot": {
              "type": "boolean"
            },
            "broadcaster": {
              "type": "boolean"
            },
            "moderator": {
              "type": "boolean"
            },
            "staff": {
              "type": "boolean"
            },
            "subscriber": {
              "type": "boolean"
            },
            "vip": {
              "type": "boolean"
            }
          },
          "required": [
            "broadcaster",
            "moderator",
            "vip",
            "subscriber",
            "bot",
            "staff"
          ],
          "title": "ChatRoles",
          "type": "object"
        }
      },
      "required": [
        "id",
        "login",
        "display",
        "color",
        "avatar",
        "pronouns",
        "roles",
        "badges"
      ],
      "title": "ChatAuthor",
      "type": [
        "object",
        "null"
      ]
    },
    "channel": {
      "description": "The channel's id on its platform.",
      "type": "string"
    },
    "eid": {
      "description": "Studio's number for this row, for chat.deleted and chat.edited.",
      "type": "integer"
    },
    "flags": {
      "additionalProperties": false,
      "properties": {
        "edited": {
          "type": "boolean"
        },
        "first_message": {
          "type": "boolean"
        },
        "highlighted": {
          "type": "boolean"
        },
        "own": {
          "description": "Sent from this Studio.",
          "type": "boolean"
        },
        "replay": {
          "description": "An alert shown again on stream.",
          "type": "boolean"
        }
      },
      "required": [
        "first_message",
        "highlighted",
        "edited",
        "own",
        "replay"
      ],
      "title": "ChatFlags",
      "type": "object"
    },
    "kind": {
      "enum": [
        "message",
        "action",
        "system",
        "bot",
        "announcement",
        "follow",
        "sub",
        "resub",
        "gift_sub",
        "support",
        "redemption",
        "raid",
        "card"
      ],
      "title": "ChatRowKind",
      "type": "string"
    },
    "meta": {
      "description": "Anything else the platform sent that Studio doesn't describe yet. Any JSON; don't rely on its shape."
    },
    "native_id": {
      "description": "The platform's id for this message.",
      "type": [
        "string",
        "null"
      ]
    },
    "parts": {
      "items": {
        "description": "A piece of a message, told apart by t: text, an emote, a mention, a link, or styled words (Velora chat's **bold** and *italic*).",
        "oneOf": [
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "text"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "animated": {
                "type": "boolean"
              },
              "code": {
                "description": "What was typed.",
                "type": "string"
              },
              "scales": {
                "description": "Its 1x, 2x and 4x pictures, when the service has them.",
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "source": {
                "description": "Where it's from, such as \"7TV · channel\".",
                "type": "string"
              },
              "t": {
                "const": "emote"
              },
              "url": {
                "description": "The emote's picture (2x).",
                "type": "string"
              },
              "zero_width": {
                "description": "Drawn on top of the emote before it.",
                "type": "boolean"
              }
            },
            "required": [
              "t",
              "code",
              "url",
              "animated"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "login": {
                "type": "string"
              },
              "t": {
                "const": "mention"
              }
            },
            "required": [
              "t",
              "login"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "link"
              },
              "url": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "url"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "bold": {
                "type": "boolean"
              },
              "italic": {
                "type": "boolean"
              },
              "t": {
                "const": "styled"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          }
        ],
        "title": "ChatPart"
      },
      "type": "array"
    },
    "platform": {
      "enum": [
        "velora",
        "twitch",
        "kick",
        "youtube",
        "owncast",
        "rumble"
      ],
      "title": "ChatPlatform",
      "type": "string"
    },
    "reply_to": {
      "additionalProperties": false,
      "properties": {
        "author": {
          "type": "string"
        },
        "excerpt": {
          "type": "string"
        },
        "native_id": {
          "type": "string"
        }
      },
      "required": [
        "native_id",
        "author",
        "excerpt"
      ],
      "title": "ChatReplyTo",
      "type": [
        "object",
        "null"
      ]
    },
    "state": {
      "description": "live, or deleted (with who deleted it, when known).",
      "oneOf": [
        {
          "additionalProperties": false,
          "properties": {
            "t": {
              "const": "live"
            }
          },
          "required": [
            "t"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "by": {
              "type": [
                "string",
                "null"
              ]
            },
            "t": {
              "const": "deleted"
            }
          },
          "required": [
            "t",
            "by"
          ],
          "type": "object"
        }
      ],
      "title": "ChatRowState"
    },
    "text": {
      "description": "The plain text.",
      "type": "string"
    },
    "title": {
      "description": "A card's headline: a reward's title, \"Poll ended\"…",
      "type": [
        "string",
        "null"
      ]
    },
    "ts": {
      "description": "When, in Unix milliseconds.",
      "type": "integer"
    }
  },
  "required": [
    "eid",
    "platform",
    "channel",
    "native_id",
    "ts",
    "kind",
    "author",
    "parts",
    "text",
    "reply_to",
    "amount",
    "title",
    "art",
    "accent",
    "flags",
    "state",
    "meta"
  ],
  "title": "ChatRow",
  "type": "object"
}

activity.redemptionRedemption

A channel-points (or Kick rewards) redemption. title is the reward's.

topic activity untyped: activity

Data

A ChatRow. See its fields under Shapes.

One row of chat or one activity, as Studio's chat panel shows it.

In the SDKs

C#
studio.ActivityRedemption += (_, e) => { /* e is ActivityRedemptionEvent */ };
TypeScript
studio.on("activity.redemption", (e) => { /* e is ChatRow */ });
Python
studio.on(EventType.ACTIVITY_REDEMPTION, handler)  # handler gets a ActivityRedemptionEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "description": "One row of chat or one activity, as Studio's chat panel shows it.",
  "properties": {
    "accent": {
      "description": "An accent color the platform gives it, \"#RRGGBB\".",
      "type": [
        "string",
        "null"
      ]
    },
    "amount": {
      "additionalProperties": false,
      "description": "Support with a number, kept as a value and its unit, never as text read as money.",
      "properties": {
        "display": {
          "description": "As the platform shows it, such as \"1,000 bits\" or \"$4.99\".",
          "type": "string"
        },
        "months": {
          "type": [
            "integer",
            "null"
          ]
        },
        "tier": {
          "type": [
            "string",
            "null"
          ]
        },
        "unit": {
          "description": "volts, bits, kicks, points, subs (a gift's count), viewers (a raid's), or a currency code such as USD for real money.",
          "type": "string"
        },
        "value": {
          "type": "number"
        }
      },
      "required": [
        "value",
        "unit",
        "display",
        "tier",
        "months"
      ],
      "title": "ChatAmount",
      "type": [
        "object",
        "null"
      ]
    },
    "art": {
      "description": "The platform's own picture for it (a reward's art).",
      "type": [
        "string",
        "null"
      ]
    },
    "author": {
      "additionalProperties": false,
      "properties": {
        "avatar": {
          "description": "A link to their picture.",
          "type": [
            "string",
            "null"
          ]
        },
        "badges": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "image": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "label": {
                "description": "Shown on hover.",
                "type": "string"
              },
              "rotates": {
                "description": "One of the badges that take turns in one place (Velora's badge strip); absent = false.",
                "type": "boolean"
              }
            },
            "required": [
              "id",
              "label",
              "image"
            ],
            "title": "ChatBadge",
            "type": "object"
          },
          "type": "array"
        },
        "color": {
          "description": "Their name's color, \"#RRGGBB\".",
          "type": [
            "string",
            "null"
          ]
        },
        "display": {
          "description": "Their display name.",
          "type": "string"
        },
        "id": {
          "description": "Their id on the platform.",
          "type": "string"
        },
        "login": {
          "description": "Their login name.",
          "type": "string"
        },
        "pronouns": {
          "type": [
            "string",
            "null"
          ]
        },
        "roles": {
          "additionalProperties": false,
          "properties": {
            "bot": {
              "type": "boolean"
            },
            "broadcaster": {
              "type": "boolean"
            },
            "moderator": {
              "type": "boolean"
            },
            "staff": {
              "type": "boolean"
            },
            "subscriber": {
              "type": "boolean"
            },
            "vip": {
              "type": "boolean"
            }
          },
          "required": [
            "broadcaster",
            "moderator",
            "vip",
            "subscriber",
            "bot",
            "staff"
          ],
          "title": "ChatRoles",
          "type": "object"
        }
      },
      "required": [
        "id",
        "login",
        "display",
        "color",
        "avatar",
        "pronouns",
        "roles",
        "badges"
      ],
      "title": "ChatAuthor",
      "type": [
        "object",
        "null"
      ]
    },
    "channel": {
      "description": "The channel's id on its platform.",
      "type": "string"
    },
    "eid": {
      "description": "Studio's number for this row, for chat.deleted and chat.edited.",
      "type": "integer"
    },
    "flags": {
      "additionalProperties": false,
      "properties": {
        "edited": {
          "type": "boolean"
        },
        "first_message": {
          "type": "boolean"
        },
        "highlighted": {
          "type": "boolean"
        },
        "own": {
          "description": "Sent from this Studio.",
          "type": "boolean"
        },
        "replay": {
          "description": "An alert shown again on stream.",
          "type": "boolean"
        }
      },
      "required": [
        "first_message",
        "highlighted",
        "edited",
        "own",
        "replay"
      ],
      "title": "ChatFlags",
      "type": "object"
    },
    "kind": {
      "enum": [
        "message",
        "action",
        "system",
        "bot",
        "announcement",
        "follow",
        "sub",
        "resub",
        "gift_sub",
        "support",
        "redemption",
        "raid",
        "card"
      ],
      "title": "ChatRowKind",
      "type": "string"
    },
    "meta": {
      "description": "Anything else the platform sent that Studio doesn't describe yet. Any JSON; don't rely on its shape."
    },
    "native_id": {
      "description": "The platform's id for this message.",
      "type": [
        "string",
        "null"
      ]
    },
    "parts": {
      "items": {
        "description": "A piece of a message, told apart by t: text, an emote, a mention, a link, or styled words (Velora chat's **bold** and *italic*).",
        "oneOf": [
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "text"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "animated": {
                "type": "boolean"
              },
              "code": {
                "description": "What was typed.",
                "type": "string"
              },
              "scales": {
                "description": "Its 1x, 2x and 4x pictures, when the service has them.",
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "source": {
                "description": "Where it's from, such as \"7TV · channel\".",
                "type": "string"
              },
              "t": {
                "const": "emote"
              },
              "url": {
                "description": "The emote's picture (2x).",
                "type": "string"
              },
              "zero_width": {
                "description": "Drawn on top of the emote before it.",
                "type": "boolean"
              }
            },
            "required": [
              "t",
              "code",
              "url",
              "animated"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "login": {
                "type": "string"
              },
              "t": {
                "const": "mention"
              }
            },
            "required": [
              "t",
              "login"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "link"
              },
              "url": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "url"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "bold": {
                "type": "boolean"
              },
              "italic": {
                "type": "boolean"
              },
              "t": {
                "const": "styled"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          }
        ],
        "title": "ChatPart"
      },
      "type": "array"
    },
    "platform": {
      "enum": [
        "velora",
        "twitch",
        "kick",
        "youtube",
        "owncast",
        "rumble"
      ],
      "title": "ChatPlatform",
      "type": "string"
    },
    "reply_to": {
      "additionalProperties": false,
      "properties": {
        "author": {
          "type": "string"
        },
        "excerpt": {
          "type": "string"
        },
        "native_id": {
          "type": "string"
        }
      },
      "required": [
        "native_id",
        "author",
        "excerpt"
      ],
      "title": "ChatReplyTo",
      "type": [
        "object",
        "null"
      ]
    },
    "state": {
      "description": "live, or deleted (with who deleted it, when known).",
      "oneOf": [
        {
          "additionalProperties": false,
          "properties": {
            "t": {
              "const": "live"
            }
          },
          "required": [
            "t"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "by": {
              "type": [
                "string",
                "null"
              ]
            },
            "t": {
              "const": "deleted"
            }
          },
          "required": [
            "t",
            "by"
          ],
          "type": "object"
        }
      ],
      "title": "ChatRowState"
    },
    "text": {
      "description": "The plain text.",
      "type": "string"
    },
    "title": {
      "description": "A card's headline: a reward's title, \"Poll ended\"…",
      "type": [
        "string",
        "null"
      ]
    },
    "ts": {
      "description": "When, in Unix milliseconds.",
      "type": "integer"
    }
  },
  "required": [
    "eid",
    "platform",
    "channel",
    "native_id",
    "ts",
    "kind",
    "author",
    "parts",
    "text",
    "reply_to",
    "amount",
    "title",
    "art",
    "accent",
    "flags",
    "state",
    "meta"
  ],
  "title": "ChatRow",
  "type": "object"
}

activity.raidRaid

Another channel raided this one. amount.value is how many viewers came, when the platform says.

topic activity untyped: activity

Data

A ChatRow. See its fields under Shapes.

One row of chat or one activity, as Studio's chat panel shows it.

In the SDKs

C#
studio.ActivityRaid += (_, e) => { /* e is ActivityRaidEvent */ };
TypeScript
studio.on("activity.raid", (e) => { /* e is ChatRow */ });
Python
studio.on(EventType.ACTIVITY_RAID, handler)  # handler gets a ActivityRaidEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "description": "One row of chat or one activity, as Studio's chat panel shows it.",
  "properties": {
    "accent": {
      "description": "An accent color the platform gives it, \"#RRGGBB\".",
      "type": [
        "string",
        "null"
      ]
    },
    "amount": {
      "additionalProperties": false,
      "description": "Support with a number, kept as a value and its unit, never as text read as money.",
      "properties": {
        "display": {
          "description": "As the platform shows it, such as \"1,000 bits\" or \"$4.99\".",
          "type": "string"
        },
        "months": {
          "type": [
            "integer",
            "null"
          ]
        },
        "tier": {
          "type": [
            "string",
            "null"
          ]
        },
        "unit": {
          "description": "volts, bits, kicks, points, subs (a gift's count), viewers (a raid's), or a currency code such as USD for real money.",
          "type": "string"
        },
        "value": {
          "type": "number"
        }
      },
      "required": [
        "value",
        "unit",
        "display",
        "tier",
        "months"
      ],
      "title": "ChatAmount",
      "type": [
        "object",
        "null"
      ]
    },
    "art": {
      "description": "The platform's own picture for it (a reward's art).",
      "type": [
        "string",
        "null"
      ]
    },
    "author": {
      "additionalProperties": false,
      "properties": {
        "avatar": {
          "description": "A link to their picture.",
          "type": [
            "string",
            "null"
          ]
        },
        "badges": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "image": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "label": {
                "description": "Shown on hover.",
                "type": "string"
              },
              "rotates": {
                "description": "One of the badges that take turns in one place (Velora's badge strip); absent = false.",
                "type": "boolean"
              }
            },
            "required": [
              "id",
              "label",
              "image"
            ],
            "title": "ChatBadge",
            "type": "object"
          },
          "type": "array"
        },
        "color": {
          "description": "Their name's color, \"#RRGGBB\".",
          "type": [
            "string",
            "null"
          ]
        },
        "display": {
          "description": "Their display name.",
          "type": "string"
        },
        "id": {
          "description": "Their id on the platform.",
          "type": "string"
        },
        "login": {
          "description": "Their login name.",
          "type": "string"
        },
        "pronouns": {
          "type": [
            "string",
            "null"
          ]
        },
        "roles": {
          "additionalProperties": false,
          "properties": {
            "bot": {
              "type": "boolean"
            },
            "broadcaster": {
              "type": "boolean"
            },
            "moderator": {
              "type": "boolean"
            },
            "staff": {
              "type": "boolean"
            },
            "subscriber": {
              "type": "boolean"
            },
            "vip": {
              "type": "boolean"
            }
          },
          "required": [
            "broadcaster",
            "moderator",
            "vip",
            "subscriber",
            "bot",
            "staff"
          ],
          "title": "ChatRoles",
          "type": "object"
        }
      },
      "required": [
        "id",
        "login",
        "display",
        "color",
        "avatar",
        "pronouns",
        "roles",
        "badges"
      ],
      "title": "ChatAuthor",
      "type": [
        "object",
        "null"
      ]
    },
    "channel": {
      "description": "The channel's id on its platform.",
      "type": "string"
    },
    "eid": {
      "description": "Studio's number for this row, for chat.deleted and chat.edited.",
      "type": "integer"
    },
    "flags": {
      "additionalProperties": false,
      "properties": {
        "edited": {
          "type": "boolean"
        },
        "first_message": {
          "type": "boolean"
        },
        "highlighted": {
          "type": "boolean"
        },
        "own": {
          "description": "Sent from this Studio.",
          "type": "boolean"
        },
        "replay": {
          "description": "An alert shown again on stream.",
          "type": "boolean"
        }
      },
      "required": [
        "first_message",
        "highlighted",
        "edited",
        "own",
        "replay"
      ],
      "title": "ChatFlags",
      "type": "object"
    },
    "kind": {
      "enum": [
        "message",
        "action",
        "system",
        "bot",
        "announcement",
        "follow",
        "sub",
        "resub",
        "gift_sub",
        "support",
        "redemption",
        "raid",
        "card"
      ],
      "title": "ChatRowKind",
      "type": "string"
    },
    "meta": {
      "description": "Anything else the platform sent that Studio doesn't describe yet. Any JSON; don't rely on its shape."
    },
    "native_id": {
      "description": "The platform's id for this message.",
      "type": [
        "string",
        "null"
      ]
    },
    "parts": {
      "items": {
        "description": "A piece of a message, told apart by t: text, an emote, a mention, a link, or styled words (Velora chat's **bold** and *italic*).",
        "oneOf": [
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "text"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "animated": {
                "type": "boolean"
              },
              "code": {
                "description": "What was typed.",
                "type": "string"
              },
              "scales": {
                "description": "Its 1x, 2x and 4x pictures, when the service has them.",
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "source": {
                "description": "Where it's from, such as \"7TV · channel\".",
                "type": "string"
              },
              "t": {
                "const": "emote"
              },
              "url": {
                "description": "The emote's picture (2x).",
                "type": "string"
              },
              "zero_width": {
                "description": "Drawn on top of the emote before it.",
                "type": "boolean"
              }
            },
            "required": [
              "t",
              "code",
              "url",
              "animated"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "login": {
                "type": "string"
              },
              "t": {
                "const": "mention"
              }
            },
            "required": [
              "t",
              "login"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "link"
              },
              "url": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "url"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "bold": {
                "type": "boolean"
              },
              "italic": {
                "type": "boolean"
              },
              "t": {
                "const": "styled"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          }
        ],
        "title": "ChatPart"
      },
      "type": "array"
    },
    "platform": {
      "enum": [
        "velora",
        "twitch",
        "kick",
        "youtube",
        "owncast",
        "rumble"
      ],
      "title": "ChatPlatform",
      "type": "string"
    },
    "reply_to": {
      "additionalProperties": false,
      "properties": {
        "author": {
          "type": "string"
        },
        "excerpt": {
          "type": "string"
        },
        "native_id": {
          "type": "string"
        }
      },
      "required": [
        "native_id",
        "author",
        "excerpt"
      ],
      "title": "ChatReplyTo",
      "type": [
        "object",
        "null"
      ]
    },
    "state": {
      "description": "live, or deleted (with who deleted it, when known).",
      "oneOf": [
        {
          "additionalProperties": false,
          "properties": {
            "t": {
              "const": "live"
            }
          },
          "required": [
            "t"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "by": {
              "type": [
                "string",
                "null"
              ]
            },
            "t": {
              "const": "deleted"
            }
          },
          "required": [
            "t",
            "by"
          ],
          "type": "object"
        }
      ],
      "title": "ChatRowState"
    },
    "text": {
      "description": "The plain text.",
      "type": "string"
    },
    "title": {
      "description": "A card's headline: a reward's title, \"Poll ended\"…",
      "type": [
        "string",
        "null"
      ]
    },
    "ts": {
      "description": "When, in Unix milliseconds.",
      "type": "integer"
    }
  },
  "required": [
    "eid",
    "platform",
    "channel",
    "native_id",
    "ts",
    "kind",
    "author",
    "parts",
    "text",
    "reply_to",
    "amount",
    "title",
    "art",
    "accent",
    "flags",
    "state",
    "meta"
  ],
  "title": "ChatRow",
  "type": "object"
}

activity.cardCard

A poll, prediction, giveaway, goal or clip, shown as a card. It may change in place later (activity.updated).

topic activity untyped: activity

Data

A ChatRow. See its fields under Shapes.

One row of chat or one activity, as Studio's chat panel shows it.

In the SDKs

C#
studio.ActivityCard += (_, e) => { /* e is ActivityCardEvent */ };
TypeScript
studio.on("activity.card", (e) => { /* e is ChatRow */ });
Python
studio.on(EventType.ACTIVITY_CARD, handler)  # handler gets a ActivityCardEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "description": "One row of chat or one activity, as Studio's chat panel shows it.",
  "properties": {
    "accent": {
      "description": "An accent color the platform gives it, \"#RRGGBB\".",
      "type": [
        "string",
        "null"
      ]
    },
    "amount": {
      "additionalProperties": false,
      "description": "Support with a number, kept as a value and its unit, never as text read as money.",
      "properties": {
        "display": {
          "description": "As the platform shows it, such as \"1,000 bits\" or \"$4.99\".",
          "type": "string"
        },
        "months": {
          "type": [
            "integer",
            "null"
          ]
        },
        "tier": {
          "type": [
            "string",
            "null"
          ]
        },
        "unit": {
          "description": "volts, bits, kicks, points, subs (a gift's count), viewers (a raid's), or a currency code such as USD for real money.",
          "type": "string"
        },
        "value": {
          "type": "number"
        }
      },
      "required": [
        "value",
        "unit",
        "display",
        "tier",
        "months"
      ],
      "title": "ChatAmount",
      "type": [
        "object",
        "null"
      ]
    },
    "art": {
      "description": "The platform's own picture for it (a reward's art).",
      "type": [
        "string",
        "null"
      ]
    },
    "author": {
      "additionalProperties": false,
      "properties": {
        "avatar": {
          "description": "A link to their picture.",
          "type": [
            "string",
            "null"
          ]
        },
        "badges": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "image": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "label": {
                "description": "Shown on hover.",
                "type": "string"
              },
              "rotates": {
                "description": "One of the badges that take turns in one place (Velora's badge strip); absent = false.",
                "type": "boolean"
              }
            },
            "required": [
              "id",
              "label",
              "image"
            ],
            "title": "ChatBadge",
            "type": "object"
          },
          "type": "array"
        },
        "color": {
          "description": "Their name's color, \"#RRGGBB\".",
          "type": [
            "string",
            "null"
          ]
        },
        "display": {
          "description": "Their display name.",
          "type": "string"
        },
        "id": {
          "description": "Their id on the platform.",
          "type": "string"
        },
        "login": {
          "description": "Their login name.",
          "type": "string"
        },
        "pronouns": {
          "type": [
            "string",
            "null"
          ]
        },
        "roles": {
          "additionalProperties": false,
          "properties": {
            "bot": {
              "type": "boolean"
            },
            "broadcaster": {
              "type": "boolean"
            },
            "moderator": {
              "type": "boolean"
            },
            "staff": {
              "type": "boolean"
            },
            "subscriber": {
              "type": "boolean"
            },
            "vip": {
              "type": "boolean"
            }
          },
          "required": [
            "broadcaster",
            "moderator",
            "vip",
            "subscriber",
            "bot",
            "staff"
          ],
          "title": "ChatRoles",
          "type": "object"
        }
      },
      "required": [
        "id",
        "login",
        "display",
        "color",
        "avatar",
        "pronouns",
        "roles",
        "badges"
      ],
      "title": "ChatAuthor",
      "type": [
        "object",
        "null"
      ]
    },
    "channel": {
      "description": "The channel's id on its platform.",
      "type": "string"
    },
    "eid": {
      "description": "Studio's number for this row, for chat.deleted and chat.edited.",
      "type": "integer"
    },
    "flags": {
      "additionalProperties": false,
      "properties": {
        "edited": {
          "type": "boolean"
        },
        "first_message": {
          "type": "boolean"
        },
        "highlighted": {
          "type": "boolean"
        },
        "own": {
          "description": "Sent from this Studio.",
          "type": "boolean"
        },
        "replay": {
          "description": "An alert shown again on stream.",
          "type": "boolean"
        }
      },
      "required": [
        "first_message",
        "highlighted",
        "edited",
        "own",
        "replay"
      ],
      "title": "ChatFlags",
      "type": "object"
    },
    "kind": {
      "enum": [
        "message",
        "action",
        "system",
        "bot",
        "announcement",
        "follow",
        "sub",
        "resub",
        "gift_sub",
        "support",
        "redemption",
        "raid",
        "card"
      ],
      "title": "ChatRowKind",
      "type": "string"
    },
    "meta": {
      "description": "Anything else the platform sent that Studio doesn't describe yet. Any JSON; don't rely on its shape."
    },
    "native_id": {
      "description": "The platform's id for this message.",
      "type": [
        "string",
        "null"
      ]
    },
    "parts": {
      "items": {
        "description": "A piece of a message, told apart by t: text, an emote, a mention, a link, or styled words (Velora chat's **bold** and *italic*).",
        "oneOf": [
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "text"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "animated": {
                "type": "boolean"
              },
              "code": {
                "description": "What was typed.",
                "type": "string"
              },
              "scales": {
                "description": "Its 1x, 2x and 4x pictures, when the service has them.",
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "source": {
                "description": "Where it's from, such as \"7TV · channel\".",
                "type": "string"
              },
              "t": {
                "const": "emote"
              },
              "url": {
                "description": "The emote's picture (2x).",
                "type": "string"
              },
              "zero_width": {
                "description": "Drawn on top of the emote before it.",
                "type": "boolean"
              }
            },
            "required": [
              "t",
              "code",
              "url",
              "animated"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "login": {
                "type": "string"
              },
              "t": {
                "const": "mention"
              }
            },
            "required": [
              "t",
              "login"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "link"
              },
              "url": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "url"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "bold": {
                "type": "boolean"
              },
              "italic": {
                "type": "boolean"
              },
              "t": {
                "const": "styled"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          }
        ],
        "title": "ChatPart"
      },
      "type": "array"
    },
    "platform": {
      "enum": [
        "velora",
        "twitch",
        "kick",
        "youtube",
        "owncast",
        "rumble"
      ],
      "title": "ChatPlatform",
      "type": "string"
    },
    "reply_to": {
      "additionalProperties": false,
      "properties": {
        "author": {
          "type": "string"
        },
        "excerpt": {
          "type": "string"
        },
        "native_id": {
          "type": "string"
        }
      },
      "required": [
        "native_id",
        "author",
        "excerpt"
      ],
      "title": "ChatReplyTo",
      "type": [
        "object",
        "null"
      ]
    },
    "state": {
      "description": "live, or deleted (with who deleted it, when known).",
      "oneOf": [
        {
          "additionalProperties": false,
          "properties": {
            "t": {
              "const": "live"
            }
          },
          "required": [
            "t"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "by": {
              "type": [
                "string",
                "null"
              ]
            },
            "t": {
              "const": "deleted"
            }
          },
          "required": [
            "t",
            "by"
          ],
          "type": "object"
        }
      ],
      "title": "ChatRowState"
    },
    "text": {
      "description": "The plain text.",
      "type": "string"
    },
    "title": {
      "description": "A card's headline: a reward's title, \"Poll ended\"…",
      "type": [
        "string",
        "null"
      ]
    },
    "ts": {
      "description": "When, in Unix milliseconds.",
      "type": "integer"
    }
  },
  "required": [
    "eid",
    "platform",
    "channel",
    "native_id",
    "ts",
    "kind",
    "author",
    "parts",
    "text",
    "reply_to",
    "amount",
    "title",
    "art",
    "accent",
    "flags",
    "state",
    "meta"
  ],
  "title": "ChatRow",
  "type": "object"
}

activity.updatedActivity updated

An activity row changed in place, such as a poll's votes; same eid as before.

topic activity untyped: activity.updated

Data

A ChatRow. See its fields under Shapes.

One row of chat or one activity, as Studio's chat panel shows it.

In the SDKs

C#
studio.ActivityUpdated += (_, e) => { /* e is ActivityUpdatedEvent */ };
TypeScript
studio.on("activity.updated", (e) => { /* e is ChatRow */ });
Python
studio.on(EventType.ACTIVITY_UPDATED, handler)  # handler gets a ActivityUpdatedEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "description": "One row of chat or one activity, as Studio's chat panel shows it.",
  "properties": {
    "accent": {
      "description": "An accent color the platform gives it, \"#RRGGBB\".",
      "type": [
        "string",
        "null"
      ]
    },
    "amount": {
      "additionalProperties": false,
      "description": "Support with a number, kept as a value and its unit, never as text read as money.",
      "properties": {
        "display": {
          "description": "As the platform shows it, such as \"1,000 bits\" or \"$4.99\".",
          "type": "string"
        },
        "months": {
          "type": [
            "integer",
            "null"
          ]
        },
        "tier": {
          "type": [
            "string",
            "null"
          ]
        },
        "unit": {
          "description": "volts, bits, kicks, points, subs (a gift's count), viewers (a raid's), or a currency code such as USD for real money.",
          "type": "string"
        },
        "value": {
          "type": "number"
        }
      },
      "required": [
        "value",
        "unit",
        "display",
        "tier",
        "months"
      ],
      "title": "ChatAmount",
      "type": [
        "object",
        "null"
      ]
    },
    "art": {
      "description": "The platform's own picture for it (a reward's art).",
      "type": [
        "string",
        "null"
      ]
    },
    "author": {
      "additionalProperties": false,
      "properties": {
        "avatar": {
          "description": "A link to their picture.",
          "type": [
            "string",
            "null"
          ]
        },
        "badges": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "image": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "label": {
                "description": "Shown on hover.",
                "type": "string"
              },
              "rotates": {
                "description": "One of the badges that take turns in one place (Velora's badge strip); absent = false.",
                "type": "boolean"
              }
            },
            "required": [
              "id",
              "label",
              "image"
            ],
            "title": "ChatBadge",
            "type": "object"
          },
          "type": "array"
        },
        "color": {
          "description": "Their name's color, \"#RRGGBB\".",
          "type": [
            "string",
            "null"
          ]
        },
        "display": {
          "description": "Their display name.",
          "type": "string"
        },
        "id": {
          "description": "Their id on the platform.",
          "type": "string"
        },
        "login": {
          "description": "Their login name.",
          "type": "string"
        },
        "pronouns": {
          "type": [
            "string",
            "null"
          ]
        },
        "roles": {
          "additionalProperties": false,
          "properties": {
            "bot": {
              "type": "boolean"
            },
            "broadcaster": {
              "type": "boolean"
            },
            "moderator": {
              "type": "boolean"
            },
            "staff": {
              "type": "boolean"
            },
            "subscriber": {
              "type": "boolean"
            },
            "vip": {
              "type": "boolean"
            }
          },
          "required": [
            "broadcaster",
            "moderator",
            "vip",
            "subscriber",
            "bot",
            "staff"
          ],
          "title": "ChatRoles",
          "type": "object"
        }
      },
      "required": [
        "id",
        "login",
        "display",
        "color",
        "avatar",
        "pronouns",
        "roles",
        "badges"
      ],
      "title": "ChatAuthor",
      "type": [
        "object",
        "null"
      ]
    },
    "channel": {
      "description": "The channel's id on its platform.",
      "type": "string"
    },
    "eid": {
      "description": "Studio's number for this row, for chat.deleted and chat.edited.",
      "type": "integer"
    },
    "flags": {
      "additionalProperties": false,
      "properties": {
        "edited": {
          "type": "boolean"
        },
        "first_message": {
          "type": "boolean"
        },
        "highlighted": {
          "type": "boolean"
        },
        "own": {
          "description": "Sent from this Studio.",
          "type": "boolean"
        },
        "replay": {
          "description": "An alert shown again on stream.",
          "type": "boolean"
        }
      },
      "required": [
        "first_message",
        "highlighted",
        "edited",
        "own",
        "replay"
      ],
      "title": "ChatFlags",
      "type": "object"
    },
    "kind": {
      "enum": [
        "message",
        "action",
        "system",
        "bot",
        "announcement",
        "follow",
        "sub",
        "resub",
        "gift_sub",
        "support",
        "redemption",
        "raid",
        "card"
      ],
      "title": "ChatRowKind",
      "type": "string"
    },
    "meta": {
      "description": "Anything else the platform sent that Studio doesn't describe yet. Any JSON; don't rely on its shape."
    },
    "native_id": {
      "description": "The platform's id for this message.",
      "type": [
        "string",
        "null"
      ]
    },
    "parts": {
      "items": {
        "description": "A piece of a message, told apart by t: text, an emote, a mention, a link, or styled words (Velora chat's **bold** and *italic*).",
        "oneOf": [
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "text"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "animated": {
                "type": "boolean"
              },
              "code": {
                "description": "What was typed.",
                "type": "string"
              },
              "scales": {
                "description": "Its 1x, 2x and 4x pictures, when the service has them.",
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "source": {
                "description": "Where it's from, such as \"7TV · channel\".",
                "type": "string"
              },
              "t": {
                "const": "emote"
              },
              "url": {
                "description": "The emote's picture (2x).",
                "type": "string"
              },
              "zero_width": {
                "description": "Drawn on top of the emote before it.",
                "type": "boolean"
              }
            },
            "required": [
              "t",
              "code",
              "url",
              "animated"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "login": {
                "type": "string"
              },
              "t": {
                "const": "mention"
              }
            },
            "required": [
              "t",
              "login"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "t": {
                "const": "link"
              },
              "url": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "url"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "bold": {
                "type": "boolean"
              },
              "italic": {
                "type": "boolean"
              },
              "t": {
                "const": "styled"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "t",
              "text"
            ],
            "type": "object"
          }
        ],
        "title": "ChatPart"
      },
      "type": "array"
    },
    "platform": {
      "enum": [
        "velora",
        "twitch",
        "kick",
        "youtube",
        "owncast",
        "rumble"
      ],
      "title": "ChatPlatform",
      "type": "string"
    },
    "reply_to": {
      "additionalProperties": false,
      "properties": {
        "author": {
          "type": "string"
        },
        "excerpt": {
          "type": "string"
        },
        "native_id": {
          "type": "string"
        }
      },
      "required": [
        "native_id",
        "author",
        "excerpt"
      ],
      "title": "ChatReplyTo",
      "type": [
        "object",
        "null"
      ]
    },
    "state": {
      "description": "live, or deleted (with who deleted it, when known).",
      "oneOf": [
        {
          "additionalProperties": false,
          "properties": {
            "t": {
              "const": "live"
            }
          },
          "required": [
            "t"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "by": {
              "type": [
                "string",
                "null"
              ]
            },
            "t": {
              "const": "deleted"
            }
          },
          "required": [
            "t",
            "by"
          ],
          "type": "object"
        }
      ],
      "title": "ChatRowState"
    },
    "text": {
      "description": "The plain text.",
      "type": "string"
    },
    "title": {
      "description": "A card's headline: a reward's title, \"Poll ended\"…",
      "type": [
        "string",
        "null"
      ]
    },
    "ts": {
      "description": "When, in Unix milliseconds.",
      "type": "integer"
    }
  },
  "required": [
    "eid",
    "platform",
    "channel",
    "native_id",
    "ts",
    "kind",
    "author",
    "parts",
    "text",
    "reply_to",
    "amount",
    "title",
    "art",
    "accent",
    "flags",
    "state",
    "meta"
  ],
  "title": "ChatRow",
  "type": "object"
}

record.pausedRecording paused

The recording was paused: nothing more goes in until it resumes.

topic record untyped: record.paused

Data

RecordPaused

  • secondsintegeralways

    The file's length so far (paused time isn't counted).

In the SDKs

C#
studio.RecordPaused += (_, e) => { /* e is RecordPausedEvent */ };
TypeScript
studio.on("record.paused", (e) => { /* e is RecordPaused */ });
Python
studio.on(EventType.RECORD_PAUSED, handler)  # handler gets a RecordPausedEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "properties": {
    "seconds": {
      "description": "The file's length so far (paused time isn't counted).",
      "type": "integer"
    }
  },
  "required": [
    "seconds"
  ],
  "title": "RecordPaused",
  "type": "object"
}

record.resumedRecording resumed

The recording carries on in the same file, with no gap in its timeline.

topic record untyped: record.resumed

Data

RecordResumed

  • secondsintegeralways

    The file's length so far (paused time isn't counted).

In the SDKs

C#
studio.RecordResumed += (_, e) => { /* e is RecordResumedEvent */ };
TypeScript
studio.on("record.resumed", (e) => { /* e is RecordResumed */ });
Python
studio.on(EventType.RECORD_RESUMED, handler)  # handler gets a RecordResumedEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "properties": {
    "seconds": {
      "description": "The file's length so far (paused time isn't counted).",
      "type": "integer"
    }
  },
  "required": [
    "seconds"
  ],
  "title": "RecordResumed",
  "type": "object"
}

replay.startedReplay buffer started

The replay buffer started keeping the last seconds of what's on air.

topic replay untyped: replay.started

Data

ReplayStarted

  • ridesReplayRides (string)always

    The encode it shares: the recording's, the stream's, or its own.

    One of "recording" "stream" "own"

  • secondsintegeralways

    How many seconds it keeps.

In the SDKs

C#
studio.ReplayStarted += (_, e) => { /* e is ReplayStartedEvent */ };
TypeScript
studio.on("replay.started", (e) => { /* e is ReplayStarted */ });
Python
studio.on(EventType.REPLAY_STARTED, handler)  # handler gets a ReplayStartedEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "properties": {
    "rides": {
      "description": "The encode it shares: the recording's, the stream's, or its own.",
      "enum": [
        "recording",
        "stream",
        "own"
      ],
      "title": "ReplayRides",
      "type": "string"
    },
    "seconds": {
      "description": "How many seconds it keeps.",
      "type": "integer"
    }
  },
  "required": [
    "seconds",
    "rides"
  ],
  "title": "ReplayStarted",
  "type": "object"
}

replay.stoppedReplay buffer stopped

The replay buffer stopped; what it held was let go.

topic replay untyped: replay.stopped

Data

ReplayStopped

  • buffered_secondsnumberalways

    How many seconds it held when it stopped (let go now).

  • last_savedstringalwayscan be null

    Where its newest replay went, if it saved one.

In the SDKs

C#
studio.ReplayStopped += (_, e) => { /* e is ReplayStoppedEvent */ };
TypeScript
studio.on("replay.stopped", (e) => { /* e is ReplayStopped */ });
Python
studio.on(EventType.REPLAY_STOPPED, handler)  # handler gets a ReplayStoppedEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "properties": {
    "buffered_seconds": {
      "description": "How many seconds it held when it stopped (let go now).",
      "type": "number"
    },
    "last_saved": {
      "description": "Where its newest replay went, if it saved one.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "buffered_seconds",
    "last_saved"
  ],
  "title": "ReplayStopped",
  "type": "object"
}

replay.savedReplay saved

A replay was saved to a file.

topic replay untyped: replay.saved

Data

ReplaySaved

  • at_msintegeralways

    When (Unix ms).

  • pathstringalways

    Where the replay went.

In the SDKs

C#
studio.ReplaySaved += (_, e) => { /* e is ReplaySavedEvent */ };
TypeScript
studio.on("replay.saved", (e) => { /* e is ReplaySaved */ });
Python
studio.on(EventType.REPLAY_SAVED, handler)  # handler gets a ReplaySavedEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "properties": {
    "at_ms": {
      "description": "When (Unix ms).",
      "type": "integer"
    },
    "path": {
      "description": "Where the replay went.",
      "type": "string"
    }
  },
  "required": [
    "path",
    "at_ms"
  ],
  "title": "ReplaySaved",
  "type": "object"
}

media.changedMedia changed

A media source started, paused, stopped, ended, went on or off air, or moved to another playlist item.

topic media untyped: media.changed

Data

MediaChanged

  • at_msintegeralwayscan be null
  • itemintegeralways

    The playing item's place in the playlist (0 is the first).

  • item_namestringalwayscan be null
  • namestringalways
  • on_airbooleanalways
  • position_msintegeralways

    Milliseconds into the item at at_ms.

  • sourcestring (uuid)always

    The media source's id.

  • stateMediaPlayState (string)always

    One of "idle" "opening" "playing" "paused" "stopped" "ended"

  • wasMediaPlayState (string)always

    Its state before.

    One of "idle" "opening" "playing" "paused" "stopped" "ended"

In the SDKs

C#
studio.MediaChanged += (_, e) => { /* e is MediaChangedEvent */ };
TypeScript
studio.on("media.changed", (e) => { /* e is MediaChanged */ });
Python
studio.on(EventType.MEDIA_CHANGED, handler)  # handler gets a MediaChangedEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "properties": {
    "at_ms": {
      "type": [
        "integer",
        "null"
      ]
    },
    "item": {
      "description": "The playing item's place in the playlist (0 is the first).",
      "type": "integer"
    },
    "item_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "name": {
      "type": "string"
    },
    "on_air": {
      "type": "boolean"
    },
    "position_ms": {
      "description": "Milliseconds into the item at at_ms.",
      "type": "integer"
    },
    "source": {
      "description": "The media source's id.",
      "format": "uuid",
      "type": "string"
    },
    "state": {
      "enum": [
        "idle",
        "opening",
        "playing",
        "paused",
        "stopped",
        "ended"
      ],
      "title": "MediaPlayState",
      "type": "string"
    },
    "was": {
      "description": "Its state before.",
      "enum": [
        "idle",
        "opening",
        "playing",
        "paused",
        "stopped",
        "ended"
      ],
      "title": "MediaPlayState",
      "type": "string"
    }
  },
  "required": [
    "source",
    "name",
    "state",
    "was",
    "on_air",
    "item",
    "item_name",
    "position_ms",
    "at_ms"
  ],
  "title": "MediaChanged",
  "type": "object"
}

obs.custom_eventCustom event

An identified v5 client broadcast a custom event.

topic activity untyped: obs.custom_event

Data

object

In the SDKs

C#
studio.ObsCustomEvent += (_, e) => { /* e is ObsCustomEventEvent */ };
TypeScript
studio.on("obs.custom_event", (e) => { /* e is ObsCustomEvent */ });
Python
studio.on(EventType.OBS_CUSTOM_EVENT, handler)  # handler gets a ObsCustomEventEvent
JSON Schema
JSON
{
  "additionalProperties": true,
  "title": "ObsCustomEvent",
  "type": "object"
}

web.changedWeb page changed

A web source's page failed to load (it's see-through on air and tried again by itself), failed for another reason, or loaded.

topic web untyped: web.changed

Data

WebChanged

  • codestringalwayscan be null

    Why it failed (see the web topic); null unless failed.

  • messagestringalwayscan be null

    Why it failed, in plain words; null unless failed.

  • namestringalways
  • sourcestring (uuid)always

    The web source's id.

  • stateWebPageState (string)always

    One of "idle" "loading" "ok" "failed"

  • urlstringalwayscan be null
  • wasWebPageState (string)always

    Its state before.

    One of "idle" "loading" "ok" "failed"

In the SDKs

C#
studio.WebChanged += (_, e) => { /* e is WebChangedEvent */ };
TypeScript
studio.on("web.changed", (e) => { /* e is WebChanged */ });
Python
studio.on(EventType.WEB_CHANGED, handler)  # handler gets a WebChangedEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "properties": {
    "code": {
      "description": "Why it failed (see the web topic); null unless failed.",
      "type": [
        "string",
        "null"
      ]
    },
    "message": {
      "description": "Why it failed, in plain words; null unless failed.",
      "type": [
        "string",
        "null"
      ]
    },
    "name": {
      "type": "string"
    },
    "source": {
      "description": "The web source's id.",
      "format": "uuid",
      "type": "string"
    },
    "state": {
      "enum": [
        "idle",
        "loading",
        "ok",
        "failed"
      ],
      "title": "WebPageState",
      "type": "string"
    },
    "url": {
      "type": [
        "string",
        "null"
      ]
    },
    "was": {
      "description": "Its state before.",
      "enum": [
        "idle",
        "loading",
        "ok",
        "failed"
      ],
      "title": "WebPageState",
      "type": "string"
    }
  },
  "required": [
    "source",
    "name",
    "state",
    "was",
    "code",
    "message",
    "url"
  ],
  "title": "WebChanged",
  "type": "object"
}

captions.sentCaptions sent

Closed caption text went into the stream or recording (captions.send, obs-websocket's SendStreamCaption, or a plugin).

topic stream untyped: captions.sent

Data

CaptionsSent

  • bystringalways

    Who sent it: the control client's, obs-websocket client's or plugin's name.

  • clearedbooleanalways

    The captions were cleared.

  • rowsintegeralways

    Caption lines it made.

  • textstringalways

    The text as sent (empty for a clear).

In the SDKs

C#
studio.CaptionsSent += (_, e) => { /* e is CaptionsSentEvent */ };
TypeScript
studio.on("captions.sent", (e) => { /* e is CaptionsSent */ });
Python
studio.on(EventType.CAPTIONS_SENT, handler)  # handler gets a CaptionsSentEvent
JSON Schema
JSON
{
  "additionalProperties": false,
  "properties": {
    "by": {
      "description": "Who sent it: the control client's, obs-websocket client's or plugin's name.",
      "type": "string"
    },
    "cleared": {
      "description": "The captions were cleared.",
      "type": "boolean"
    },
    "rows": {
      "description": "Caption lines it made.",
      "type": "integer"
    },
    "text": {
      "description": "The text as sent (empty for a clear).",
      "type": "string"
    }
  },
  "required": [
    "text",
    "rows",
    "cleared",
    "by"
  ],
  "title": "CaptionsSent",
  "type": "object"
}

to open · ↑ ↓ to move · Esc to close