Integration guide

Set up LiveKit in RouteIQ

Create a LiveKit project, copy its WebSocket URL and server credentials, and connect real-time audio and video to your RouteIQ site.

Updated September 3, 2026
Keep the API secret server-side. RouteIQ stores the secret encrypted. Never place the secret in a mobile app, browser, screenshot, or support message.

Before you start

You will need a LiveKit Cloud account or your own LiveKit server that users can reach over the internet, permission to manage API keys, and administrator access to your RouteIQ site.

Cloud or self-hosted

LiveKit Cloud provides the project URL and credentials in its dashboard. If you run your own LiveKit server, use its public secure WebSocket URL and a key pair from the server settings.

1. Create or choose a LiveKit project

  1. Open LiveKit Cloud and sign in.
  2. Create a project for the environment you are connecting, or open an existing project.
  3. Choose the region and project settings for your users before customers start using calls.

2. Copy the server URL and credentials

  1. In the project settings, open the API keys area.
  2. Create a dedicated key for RouteIQ, or reveal an appropriate existing server key.
  3. Copy the project WebSocket URL, API key, and API secret. The URL normally begins with wss://.
RouteIQ fieldLiveKit value
LiveKit Server URLThe project's secure WebSocket URL, including wss://.
API KeyThe public identifier for the server key pair.
API SecretThe secret paired with that API key.

See LiveKit's authentication documentation for how server credentials are used.

3. Connect LiveKit to RouteIQ

  1. Sign in to RouteIQ and open Settings > Integrations.
  2. Find LiveKit and turn it on.
  3. After it shows Connected, select Configure.
  4. Paste the exact server URL, API key, and API secret into their matching fields.
  5. Leave Is Active selected and save.

4. Verify the setup

  1. Return to the integration card and confirm it remains active. A saved card alone does not verify the remote credentials.
  2. Start a non-production audio or video session through a RouteIQ workflow that uses LiveKit.
  3. Confirm both participants can connect and exchange media.
  4. Check the LiveKit project dashboard for the test room or session activity.
  5. Repeat from the real networks users rely on, especially corporate Wi-Fi and cellular connections.

Troubleshooting

The connection fails immediately

Confirm the URL begins with wss://, contains no trailing spaces, and belongs to the same project as the API key and secret.

A room token is rejected

The API key and secret may not be a pair, may have been revoked, or may belong to a different project. Copy both values again from the same LiveKit project.

Users connect but media does not flow

Check the LiveKit project status, network and firewall rules, browser or device permissions, and your self-hosted deployment's TURN configuration if applicable.

Rotate or remove the credentials

  1. Create a replacement key pair in LiveKit.
  2. Replace both the API key and secret in RouteIQ and save.
  3. Verify a new test session.
  4. Revoke the old key only after the replacement works.