External Modulation & Stream Deck
vtor.bot provides a secure, API key-based integration layer that allows you to trigger automated stream reactions from external devices like the Elgato Stream Deck.
API Key Setup
Section titled “API Key Setup”To use external modulation, you first need to generate an API key:
- Go to Settings > Integrations and find the External API section.
- Generate a new key and copy it immediately. For security, keys are hashed and cannot be retrieved later.
- In your third-party tool, add a header
x-api-keywith your generated value.
Available Endpoints
Section titled “Available Endpoints”Trigger Redemption
Section titled “Trigger Redemption”Trigger any automated reaction protocol as if a viewer had redeemed it.
- Method:
POST - Path:
/api/external/trigger/redemption - Body:
{"reward_title": "Drink Water","user_input": "Optional custom message"}
Manual Auto-Clip
Section titled “Manual Auto-Clip”Manually trigger the automated clipping engine to save the OBS Replay Buffer.
- Method:
POST - Path:
/api/external/trigger/clip
Stream Deck Integration
Section titled “Stream Deck Integration”You can use the API Requester plugin on Stream Deck to trigger these actions:
- URL:
https://api.vtor.bot/api/external/trigger/redemption - Headers: Add
x-api-key: YOUR_KEY - Body:
{"reward_title": "Hydrate"}