docs: Document plugin api event

docs/generated/protocol.json

@@ -1171,6 +1171,48 @@
       ],
       "responseFields": []
     },
+    {
+      "description": "Call a request registered to a vendor.\n\nA vendor is a unique name registered by a third-party plugin or script, which allows for custom requests and events to be added to obs-websocket.\nIf a plugin or script implements vendor requests or events, documentation is expected to be provided with them.",
+      "requestType": "CallVendorRequest",
+      "complexity": 3,
+      "rpcVersion": "1",
+      "deprecated": false,
+      "initialVersion": "5.0.0",
+      "category": "general",
+      "requestFields": [
+        {
+          "valueName": "vendorName",
+          "valueType": "String",
+          "valueDescription": "Name of the vendor to use",
+          "valueRestrictions": null,
+          "valueOptional": false,
+          "valueOptionalBehavior": null
+        },
+        {
+          "valueName": "requestType",
+          "valueType": "String",
+          "valueDescription": "The request type to call",
+          "valueRestrictions": null,
+          "valueOptional": false,
+          "valueOptionalBehavior": null
+        },
+        {
+          "valueName": "requestData",
+          "valueType": "Object",
+          "valueDescription": "Object containing appropriate request data",
+          "valueRestrictions": null,
+          "valueOptional": true,
+          "valueOptionalBehavior": "{}"
+        }
+      ],
+      "responseFields": [
+        {
+          "valueName": "responseData",
+          "valueType": "Object",
+          "valueDescription": "Object containing appropriate response data. {} if request does not provide any response data"
+        }
+      ]
+    },
     {
       "description": "Gets an array of all hotkey names in OBS",
       "requestType": "GetHotkeyList",
@@ -2348,6 +2390,33 @@
           "valueDescription": "True == Enabled, False == Disabled"
         }
       ]
+    },
+    {
+      "description": "An event has been emitted from a vendor.\n\nA vendor is a unique name registered by a third-party plugin or script, which allows for custom requests and events to be added to obs-websocket.\nIf a plugin or script implements vendor requests or events, documentation is expected to be provided with them.",
+      "eventType": "VendorEvent",
+      "eventSubscription": "ExternalPlugins",
+      "complexity": 3,
+      "rpcVersion": "1",
+      "deprecated": false,
+      "initialVersion": "5.0.0",
+      "category": "general",
+      "dataFields": [
+        {
+          "valueName": "vendorName",
+          "valueType": "String",
+          "valueDescription": "Name of the vendor emitting the event"
+        },
+        {
+          "valueName": "eventType",
+          "valueType": "String",
+          "valueDescription": "Vendor-provided event typedef"
+        },
+        {
+          "valueName": "eventData",
+          "valueType": "Object",
+          "valueDescription": "Vendor-provided event data. {} if event does not provide any data"
+        }
+      ]
     }
   ]
 }

docs/generated/protocol.md

@@ -1220,6 +1220,7 @@ Subscription value to receive the `SceneItemTransformChanged` high-volume event.
 - [General](#general)
   - [ExitStarted](#exitstarted)
   - [StudioModeStateChanged](#studiomodestatechanged)
+  - [VendorEvent](#vendorevent)
 - [Config](#config)
   - [CurrentSceneCollectionChanging](#currentscenecollectionchanging)
   - [CurrentSceneCollectionChanged](#currentscenecollectionchanged)
@@ -1255,6 +1256,28 @@ Studio mode has been enabled or disabled.
 | Name | Type  | Description |
 | ---- | :---: | ----------- |
 | studioModeEnabled | Boolean | True == Enabled, False == Disabled |
+
+---
+
+### VendorEvent
+
+An event has been emitted from a vendor.
+
+A vendor is a unique name registered by a third-party plugin or script, which allows for custom requests and events to be added to obs-websocket.
+If a plugin or script implements vendor requests or events, documentation is expected to be provided with them.
+
+- Complexity Rating: `3/5`
+- Latest Supported RPC Version: `1`
+- Added in v5.0.0
+
+
+**Data Fields:**
+
+| Name | Type  | Description |
+| ---- | :---: | ----------- |
+| vendorName | String | Name of the vendor emitting the event |
+| eventType | String | Vendor-provided event typedef |
+| eventData | Object | Vendor-provided event data. {} if event does not provide any data |
 ## Config
 
 ### CurrentSceneCollectionChanging
@@ -1370,6 +1393,7 @@ The profile list has changed.
   - [GetVersion](#getversion)
   - [GetStats](#getstats)
   - [BroadcastCustomEvent](#broadcastcustomevent)
+  - [CallVendorRequest](#callvendorrequest)
   - [GetHotkeyList](#gethotkeylist)
   - [TriggerHotkeyByName](#triggerhotkeybyname)
   - [TriggerHotkeyByKeySequence](#triggerhotkeybykeysequence)
@@ -1494,6 +1518,35 @@ Broadcasts a `CustomEvent` to all WebSocket clients. Receivers are clients which
 
 ---
 
+### CallVendorRequest
+
+Call a request registered to a vendor.
+
+A vendor is a unique name registered by a third-party plugin or script, which allows for custom requests and events to be added to obs-websocket.
+If a plugin or script implements vendor requests or events, documentation is expected to be provided with them.
+
+- Complexity Rating: `3/5`
+- Latest Supported RPC Version: `1`
+- Added in v5.0.0
+
+
+**Request Fields:**
+
+| Name | Type  | Description | Value Restrictions | ?Default Behavior |
+| ---- | :---: | ----------- | :----------------: | ----------------- |
+| vendorName | String | Name of the vendor to use | None | N/A |
+| requestType | String | The request type to call | None | N/A |
+| ?requestData | Object | Object containing appropriate request data | None | {} |
+
+
+**Response Fields:**
+
+| Name | Type  | Description |
+| ---- | :---: | ----------- |
+| responseData | Object | Object containing appropriate response data. {} if request does not provide any response data |
+
+---
+
 ### GetHotkeyList
 
 Gets an array of all hotkey names in OBS