Skip to main content

OBS Studio

TipLink can connect to OBS Studio over its built-in WebSocket server. Once connected, TipLink receives events like scene changes, stream start/stop, and recording start/stop. These can be used as alert triggers.

Requirements​

  • OBS Studio 28 or newer (the WebSocket server is built in)
  • TipLink V2 desktop app

Enable the WebSocket Server in OBS​

  1. Open OBS Studio.
  2. In the menu bar, go to Tools → WebSocket Server Settings.
  3. Check Enable WebSocket Server.
  4. Note down the Server Port (default is 4455).
  5. If you want password protection, check Enable Authentication and set a password.
  6. Click OK.
Leave OBS open

TipLink connects to OBS's WebSocket server while OBS is running. If OBS is closed, the connection will drop. TipLink will automatically retry up to 5 times with increasing delays.

  1. Open TipLink and go to Connect Your Platforms.
  2. Find OBS Studio and click Add Account.
  3. Fill in your connection details:
FieldDescriptionDefault
HostThe computer OBS is running on. Use localhost if it's the same machine.localhost
PortThe WebSocket server port from OBS settings.4455
PasswordThe authentication password, if you enabled it in OBS. Leave blank if you did not.(none)
  1. Click Save.

Connect​

Click the Connect button next to your OBS Studio account.

If the connection is successful, the button will change to Disconnect and the account will show as active.

Auto Connect

Enable Auto Connect on the account to have TipLink connect to OBS automatically every time TipLink starts.

Supported Events​

Once connected, TipLink can receive the following events from OBS:

EventDescriptionEvent Data
Scene ChangedFired when you switch to a different scene{{ sceneName }} — the name of the new scene
Stream StartedFired when your stream goes live(no extra data)
Stream StoppedFired when your stream ends(no extra data)
Recording StartedFired when recording begins{{ outputPath }} — the file path being recorded to
Recording StoppedFired when recording ends(no extra data)
Source Visibility ChangedFired when a source is shown or hidden in a scene{{ sceneName }}, {{ sourceId }}, {{ enabled }}

Using OBS Events in Alerts​

You can use these events as Triggers in any alert.

Example: Send a Discord message when you go live

  1. Create a new alert.
  2. Set the trigger to OBS Studio → Stream Started.
  3. Add a Send to Discord action with the message Stream is now live!
  4. Save.

Example: Change an overlay widget when a scene changes

  1. Create a new alert.
  2. Set the trigger to OBS Studio → Scene Changed.
  3. Optionally, use {{ sceneName }} in an action to display the current scene name.
  4. Save.

Troubleshooting​

TipLink can't connect to OBS

  • Make sure OBS is open and the WebSocket server is enabled (Tools → WebSocket Server Settings).
  • Check that the Host, Port, and Password in TipLink match the OBS settings exactly.
  • If OBS is on the same computer, Host should be localhost.
  • Check that your firewall isn't blocking port 4455.

Connection keeps dropping

  • TipLink will automatically try to reconnect up to 5 times. After that, reconnect manually.
  • Make sure OBS hasn't crashed or been restarted without TipLink noticing.

Remove the Account​

  1. Go to Connect Your Platforms → OBS Studio.
  2. Click Disconnect if the account is connected.
  3. Click Remove Account.