Get started in 3 steps
With Whereby Embedded and our browser SDK, you can add video calls and video conferencing to your website in three easy steps.
Last updated
Was this helpful?
With Whereby Embedded and our browser SDK, you can add video calls and video conferencing to your website in three easy steps.
Last updated
Was this helpful?
is a protocol and collection of browser APIs that enable real-time communications. With WebRTC, you can send audio, video, images, and text without the need for a server — that is, as long as both parties are on the same network.
For most real-world uses of WebRTC, you'll need a server. In fact, you'll need a few servers.
A signaling server to manage connections between users.
A STUN server to discover the public IP addresses of user devices, and/or a TURN server to relay data between users.
A media server to distribute audio, video, and other media for multi-party communications.
Or, you can use . Whereby has built a network of signaling, STUN and media servers that you can use as a service. With Whereby Embedded and our browser SDK, you can add video calls and video conferencing to your website in three easy steps.
Get !
From your account dashboard, go to the Configure screen. Under the API keys panel, click the Generate key button to create a new key.
Your API key is only displayed once. Copy the key and save it to your secrets manager. You'll need it to send requests to our REST API.
Although you can create rooms from your account dashboard, using the lets you automate the process.
To create a meeting room, send a POST request to the end point. Whereby's REST API uses . Send your API key as part of the Authorization
header.
The request body should include a JSON-formatted string, with an endDate
should be a valid date string. It tells Whereby when the meeting room should expire. Here's an example using .
Response:
Whereby Embedded offers a couple of options for integrating video calling with your application. You'll need the roomURL
from the API response in Step 2.
whereby-embed
is a custom element, which mean you can use it as a CSS selector shown below
Both iframe
and whereby-embed
options use the pre-built Whereby UI. The pre-built UI gives you control over things like background and foreground colors. You can also add your company's logo, and choose which features you'd like to show to or hide from users.
Install the SDK using the npm install
, yarn add
, or pnpm install
command.
Then import the SDK into your React project, and connect to your room.
For simple projects that don't use a bundler, try Whereby's . Load it from our CDN, using a script
tag. Use the value of roomURL
for the web component's room
attribute value.
Perhaps you'd like to customize your button icons instead. Maybe you'd like to change the shape of your video tiles, or how they're arranged. For fine-grained control over your video call layouts, try the with React hooks.
Use the Whereby Browser SDK to create video conferencing UIs that fully reflect your brand. You'll need and a package manager such as , , or for this option. You'll also need a build tool such as , , or
Written by