LogoLogo
WherebyStatusCommunity
  • 📹Whereby 101
    • Create Your Video Experience
      • Get started in 3 steps
      • Embedding Whereby in a web app
        • Using Whereby's Web Component & Pre-built UI
          • Script Tags
          • With Low Code
            • Embedding in Squarespace or Wordpress
            • No code video conferencing in Bubble
        • Using Whereby's Browser SDK with React Hooks for a fully custom UI
      • Embedding Whereby in a mobile app
        • Embedding Whereby in iOS
          • Using Whereby's Native iOS SDK
        • Embedding Whereby in Android
          • Using Whereby's Native SDK
        • Using Flutter
        • Using React Native
      • Github SDK Examples
      • Meeting scheduling with Cronofy
    • Generating Room URLs
      • Name prefixes
      • Using “Create a room”
      • Using Postman
    • Customize Your Video Experience
      • During room creation
      • Using Attributes/URL Params
      • Global preferences
      • Branding elements
      • Dial-In
      • File sharing
      • Breakout Groups with Embedded
      • Waiting Rooms
    • User roles & Meeting Permissions
    • FAQ
      • Accessibility
      • Whereby Words
      • Firewall & Security
      • HIPAA compliant setup
      • Allowed Domains & Localhost
      • Whereby Embedded Feature Comparison
  • 🔍Meeting Content & Quality
    • Recording
      • Cloud Recording
      • Local Recording
    • Transcribing
      • Session Transcription
      • Recording Transcription
    • Live Captions
    • Session summaries
    • Live streaming RTMP
    • Quality Insights
      • Real-time troubleshooting
      • Using the Insights dashboard
      • Improving call quality
      • Tracking room events with Webhooks
  • 🤷End User
    • End User Support Guides
      • Supported Browsers & Devices
      • Screen Sharing Setup & Usage
      • Using Breakout Groups
      • Troubleshooting & Basics
  • 🚚Developer Guides
    • Quickly deploy Whereby to your domain
    • Tracking Customer Usage
    • Migrating from Twilio
      • Twilio JS SDK Quick Migration
      • Twilio JS SDK Direct Migration
  • 🖥️Reference
    • REST API Reference
      • /meetings
      • /insights
      • /recordings
      • /transcriptions
      • /summaries
      • /rooms
    • Web Component Reference
    • React Hooks Reference
      • Quick Start
        • Getting started with the Browser SDK
      • Guides & Tutorials
        • Migrate from version 2.x to 3
        • Grid logic
        • Custom Video Tiles with React
        • Usage with Next.js
        • How to customize the toolbar
      • API Reference
        • WherebyProvider
        • VideoView
        • VideoGrid
        • useLocalMedia
        • useRoomConnection
      • Types
    • React Native Reference
      • Quick Start
      • WherebyEmbed
    • Webhooks Reference
Powered by GitBook
On this page
  • Summary
  • Deploy the tool

Was this helpful?

Edit on GitHub
  1. Developer Guides

Quickly deploy Whereby to your domain

Last updated 5 months ago

Was this helpful?

Summary

We've put together a simple tool to make deploying Whereby's Pre-built experience on your site even easier. It's recommended that you use a dedicated domain or subdomain. You'll then be able to use the unique roomName's that are returned from our API.

Example API response:

{
    "startDate": "2024-11-15T16:11:33.568Z",
    "endDate": "2024-11-29T16:11:33.044Z",
    "roomName": "/your-url-c4jx6g",
    "roomUrl": "https://your-account.whereby.com/your-url-c4jx6g",
    "meetingId": "93259794"
}

You can then use the roomName from above as a path on the domain you've deployed our webapp to:

https://video.yoursite.com/your-url-c4jx6g

Deploy the tool

  1. Go to our webapp repo and fork for your own customizations and website

  2. Deploy the app to your favourite hosting provider (e.g. , etc)

  3. In assets/index.js the roomUrl variable to include your Whereby subdomain

const roomUrl = new URL("https://your-account.whereby.com")
whereby.setAttribute("minimal", true)
whereby.setAttribute("screenshare", false)
whereby.setAttribute("background", false)

In the same file, you can choose to manage the room features by using the method

🚚
https://github.com/whereby/embed-wrapper
Netlify
Vercel
available as attributes
setAttribute