Whereby

Embedded developer resources

• Welcome to Whereby Embedded: Whereby Embedded is the easiest way to add video calls to your web page or mobile app. Get up and running in minutes, not months, so you're free to focus on what you do best — your business.
• Overview of Whereby Embedded: With Whereby Embedded, you can add video calls and conferencing to your website quickly and easily.
• Initial setup: Follow these steps below to set up your Whereby Embedded account!
• Pre-built UI vs. React-based Browser SDK: Choosing the right integration path
• Web component & pre-built UI: The quick way to get up and running with Whereby is using our web component & pre-built UI
• Web app quickstart
• Configuring with attributes
• Using commands
• Using Whereby events
• Quickly deploy Whereby to your domain
• Embed with low code: If you want to embed video rooms in a website using HTML or a framework that supports HTML elements like React.js, a great option for doing this is by using a simple iframe.
• React-based Browser SDK: The React-based Browser SDK is a flexible toolkit that lets you build a fully custom video calling experience using Whereby’s APIs, components, and event system using React.
• Browser SDK quickstart
• Grid logic
• Customizing the toolbar
• Customizing video tiles: Discover how to customize the video tiles in a Whereby call using the Browser SDK with React hooks.
• Migrating from version 2.x to 3
• Whereby in Next.js: Next.js is a popular framework for React and is rendered server-side. The Whereby browser-sdk relies on browser specific API’s to work so due to this, usage with Next.js has some challenges.
• Whereby for iOS: You can add Whereby to your iOS app with a native SDK or a WebView approach, depending on how much control you need.
• Whereby Native iOS SDK
• Using a WKWebView
• Whereby for Android: Bring video calling to your Android app using Whereby’s native SDK or a WebView-based setup.
• Whereby Android SDK
• Using a WebView
• Whereby in React Native: If you're building with React Native, you can integrate Whereby using either our SDK or a WebView-based approach, depending on your needs.
• Whereby React Native SDK
• Using a WebView: If you’re using React Native CLI, you can embed Whereby rooms with just a few simple steps as laid out in this guide.
• Whereby with Flutter: Flutter is Google's free and open-source UI framework for creating natively compiled cross-platform mobile apps.
• Embedding in Squarespace or Wordpress: Most website builders offer some way of adding blocks containing content hosted elsewhere. Here we look at two popular options, SquareSpace and WordPress.
• No code video conferencing in Bubble: Planet No Code has built a tutorial to help create the video conferencing app of your dreams!
• Meeting scheduling with Cronofy: Integrate Whereby Embedded with Cronofy for robust scheduling capabilities
• Room creation: Rooms are where video calls (sessions) take place. Create or delete Whereby rooms programmatically using a simple API request. Rooms can be created on demand, or ahead of time for scheduled meetings.
• Name prefixes: When creating rooms using the REST API, you can send an extra identifier as part of your API request. This identifier will become part of the room URL, acting as a tag to enable further analysis.
• Using “Create a room”: Easily create Whereby rooms using a straightforward 4-step UI flow without the need to generate an API key.
• Customizing rooms during creation: Some key properties of your rooms should be set when the room is created using the API or Create a room flow.
• Assistants: Whereby Assistants let you connect AI agents to video rooms, stream and process audio, and automate real-time interactions.
• Branding elements: Make your Whereby rooms truly yours by setting a custom logo, background and other branding elements. You can do this using the branding tools in the Embedded dashboard, or via the API.
• Breakout groups: More than ever, workshops, lectures, and conferences are happening online. So it's never been more important to combine bigger (often one-way) meetings with smaller, collaborative sessions.
• Dial-In: The Dial-in option allows meeting participants to join via a phone call. This is particularly useful if they have internet issues, are traveling, or cannot use video for other reasons.
• File sharing: File sharing allows meeting participants to exchange small files with each other, during the session, through the chat.
• Live Captions: Live Captions (or closed captions) provide AI-powered, real-time text representation of spoken content during events within a meeting room, such as presentations, meetings, or videos.
• Live Streaming via RTMP: Our Live Streaming feature allows for you to share your meeting feed to an external service, like YouTube or Twitch via RTMP.
• Quality Insights: The Insights suite is available from the Embedded dashboard, and is the easiest way to access your usage data at a glance. You can also access insights data through the Whereby REST API.
• Real-time troubleshooting: Enhance users’ experience when issues arise with real-time monitoring and troubleshooting tools. These tools are free to use and by default switched on for all embedded customers.
• Using the Insights dashboard
• Session Ratings: Session Ratings allow you to understand the quality of your sessions through quantitative and qualitative feedback from your participants. This is visually represented within your Insights Dashboard.
• Improving call quality
• Tracking room events with Webhooks: With Webhooks you can set up user-defined callbacks triggered by meeting events. These are a great way to programmatically keep track of some of the events and actions happening around your meetings.
• Recording: Recording allows for you or your hosts to capture a recording of a meeting as it appears within the Whereby room. We offer options for recording locally in the browser or using a cloud-based solution.
• Cloud Recording: Cloud recording is a feature of our paid Embedded plans and allows you to record meetings that are saved to a storage bucket accessible by you.
• Local Recording: Local Recording is handled completely locally in the host's browser and browser cache.
• Screen Sharing Setup & Usage: Screen sharing is a great way to share content to other hosts/participants in the room.
• Secure Authentication for S3 Storage: Use OpenId Connect for secure S3 storage of your recordings and transcriptions.
• Understanding Authentication Types
• Configure Access Key Authentication
• Configure OIDC Authentication
• Tracking Customer Usage: Use the Whereby Insights API for custom tracking
• Transcribing: Transcribing allows you to get a video to text transcript of what was said in your meeting rooms. You can get a transcript directly from the session, or from processing a recording.
• Session Transcription: Session Transcription allows you to produce a transcript directly from the live session, without the need to record it. Full transcript is available right after the session is finished.
• Recording Transcription: Recording Transcription allows you to get a transcript of any session recording stored in Whereby-provided storage
• User roles & meeting permissions: Whereby allows your participants to join a video meeting without creating accounts or logins. If you want some users to have altered privileges in the meeting, you can use different URL types
• Waiting Rooms: Waiting rooms are a great way for your hosts to manage meeting access with ease.
• Global room customizations: Some preferences can be enabled or disabled globally in the customer portal and therefore apply to all rooms and sessions.
• Privacy Configurations: Depending on your use case, you may want to enable some privacy configurations for your Whereby account.
• Building secure telehealth applications: implementation guide: This guide walks you through implementing essential features for your telehealth platform using Whereby's video API and SDK.
• HIPAA compliant setup: A HIPAA compliant setup comes at no additional cost for customers on an annual plan. This page describes how to set up HIPAA compliant video calls.
• Case Study: Using Whereby's Browser SDK with React Hooks to Build a Telehealth App: In this tutorial you will build a fully functional video-conferencing app using the Whereby browser SDK with React hooks.
• REST API Reference
• /meetings
• /insights
• /recordings
• /transcriptions
• /summaries
• /rooms
• Web Component Reference: Our web component allows you to embed Whereby's pre-built UI on any webpage. It provides a simple readable integration and exposes local client events and commands between our platform and yours.
• Core SDK Reference
• Quick Start: The following code snippets show a basic example of using the core sdk to join and leave a room.
• API Reference
• WherebyClient
• LocalMediaClient
• RoomConnectionClient
• GridClient
• Types
• LocalMedia Types
• Grid Types
• RoomConnection Types
• Assistant SDK Reference
• Quick Start: The following example shows a basic example of creating an assistant to join a room and send a chat message
• API Reference
• Assistant
• Trigger
• Types
• Assistant Types
• Trigger Types
• React SDK Reference: The Whereby browser SDK includes React hooks and components which allow integrating a fully custom video experience into your web application.
• WherebyProvider
• VideoView
• VideoGrid
• useLocalMedia
• useRoomConnection
• Types
• React Native Reference
• Quick Start
• WherebyEmbed
• Camera Effects Reference
• Quick Start: The following code snippets show a basic example of using the camera effects SDK to create an effect stream and use it in the core SDK.
• API Reference
• getUsablePresets: Returns a list of the available camera effects presets
• FAQ: We've compiled some of the most common questions and tips we receive about Whereby.
• Accessibility: When accessing Whereby via the pre-built UI, the experience is WCAG 2.1 Level AA compliant
• Whereby Words: Terms that are used within Whereby, and what they mean
• Firewall & Security: Configure allowed domains and manage access to Whereby services
• Security and Privacy at Whereby Embedded: Learn how Whereby handles privacy and security. This document is applicable for Whereby Embedded.
• Allowed Domains & Localhost: The allowed domains feature lets you control which domains can be used for embedding your room and is also required in order to enable some specific features.
• Whereby Embedded Feature Comparison: An exhaustive list of the features and capabilities available within our implementation options
• Postman collection: The Whereby Postman collection offers a quick and easy way of creating and managing rooms and lets you explore the API without needing to set up anything in your project first.
• Migrating from Twilio: A compilation of guides to help you migrate from Twilio to Whereby
• Twilio JS SDK Quick Migration
• Twilio JS SDK Direct Migration: This guide will walk you through migrating from Twilio's Programmable Video platform to Whereby's Browser SDK.
• Examples library: Looking for code examples? We've got some Github repos showing how to use the Whereby Embedded API to create and embed Whereby rooms in your own app/website.
• End User Support Guides: Guides to help your users get the most out of Whereby
• Supported Browsers & Devices
• Screen Sharing Setup & Usage
• Using Breakout Groups
• Troubleshooting & Basics: Use the below information with your Support, Success, and Product teams to better assist your customers. Feel free to add as much or as little of this information to your own documentation!

Agent Instructions: Querying This Documentation

If you need additional information, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on a page URL with the ask query parameter:

GET https://docs.whereby.com/getting-started/readme.md?ask=<question>

The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.