Using URL parameters

With Whereby Embedded you can use URL parameters to customize the meeting experience for your users. It’s possible for each participant in a meeting to have different parameter combinations.

URL parameters are added to the roomURL when embedding a room in your web page or app.
Several parameters can be combined by using the ampersand symbol (&). For instance, the following URL parameters would open the room with the screenshare and people buttons hidden:
https://subdomain.whereby.com/room?screenshare=off&people=off
URL parameters
URL Parameter
Description
​?minimal​
Applies a minimal UI. Turns off all controls except for cam and mic.
​?video=off​
Participant joins the room with camera turned off.
​?audio=off​
Participant joins the room with microphone turned off.
​?screenshare=<on|off>​
Show/hide the screenshare button.
​?chat=<on|off>​
Show/hide the chat button.
​?people=off​
Hide the people button.
​?leaveButton=<on|off>​
Show/hide the leave button.
​?displayName=<name>​
Set display name of participant.
​ ?avatarUrl=<url>​
Set the profile avatar of participant.
​?background=off​
Hide the room background.
​?logo=off​
Hide the logo in the room header.
​?locking=off​
Hide the room lock button.
​?participantCount=off​
Hide the participant counter.
​?settingsButton=off​
Hide the settings button.
​?pipButton=off​
Hide the Picture in Picture button.
​?moreButton=off​
Hide the more button.
​?topToolbar=<on|off>​
Show/hide the entire top toolbar.
​?bottomToolbar=<on|off>​
Show/hide the entire bottom toolbar.
​?lang=<code>​
Set the room UI language.
​?floatSelf​
Float the self view to the bottom right.
​?breakout=<on|off>​
Show/hide the breakout room feature for the meeting host.
​?groups=Orange,Banana,Coconut​
Predefine up to 20 groups for the breakout groups function.
​?timer=<on|off>​
Show/hide the meeting timer.
​?precallReview=<on|off>​
Determines if users see the pre-call review step.
​?skipMediaPermissionPrompt​
Skips the request permissions UI and asks for devices
​?subgridLabels=<on|off>​
Enable name labels for participants in the subgrid
​?metadata=<string>​
Gets passed on to the corresponding webhooks.
​?lowData=<on|off>​
Use a lower resolution by default
​?autoSpotlight​
Automatically spotlight the local participant on room join
​?roomIntegrations=on​
Enables YouTube and Miro integrations in the meeting
​?virtualBackgroundUrl=<url>​
Specify custom virtual background which should be applied to the local participant
Property details
?minimal
The minimal parameter applies a combination of UI adjustments to simplify the embedded meeting interface.
Hidden items: Status bar, chat button, screensharing button, leave button, and Whereby’s branding.
Shown items: Video and audio buttons.
For further adjustments, additional parameters can be combined with ?minimal. For example
?minimal&chat=on will show the chat button.
?video=off
Participants join the meeting with their camera off, they can turn it on whenever they want.
Use case: A sales representative showcasing a product to a customer relaxing at home.
?audio=off
Participants join the meeting with their microphone off, they can turn it on whenever they want.
Use case: A presentation is being given in a big meeting where attendees are not expected to participate verbally.
?screenshare=<on|off>
Show/hide the screensharing button for the meeting participant.
Screensharing is available on all browsers that support this natively. Currently no mobile browsers support screensharing.
?chat=<on|off>
Show/hide the chat button. Messages are not stored after the meeting has ended.
?people=off
Hide the people button.
Use case: The people button shows the participant list, which can be useful for bulk management of participants in bigger meetings.
?leaveButton=off
Hide the leave button.
Use case: Can be used if you want to control the leave flow in other ways, like adding a custom link or button outside the embedded room to control what happens when users leave the call.
?displayName=<name>
Set the display name for a participant instead of prompting the user for this information.
Use case: A participant’s name may be known before they join the meeting. Including this information as a parameter will save the user from entering their name again.
?avatarUrl=<url>
Set the avatar / profile picture of the participant instead of the automatically assigned name initials. The image can be a .png or .jpeg, and must be a square maximum of 64x64.
Note: You must make sure to list the origin of the image URL in the allowed domains section of the dashboard. The image URL must be https and cannot contain query params.
?background=off
Hide the default meeting background.
Use case: Hiding the meeting background allows the meeting to appear more integrated by allowing the app or service’s branding shine through as the new background.
?logo=off
Hide the logo in the room header.
Use case: Control whether or not your company logo is displayed in the room header.
?locking=off
Hide the room lock button.
Use case: When set to off the lock button won’t be displayed in the room header. Also, hosts won’t be able to lock/unlock the room through the settings menu or the keyboard shortcut.
?participantCount=off
Hide the participant counter.
Use case: Will display the current and maximum number of participants in the room, e.g. “2/4” or “13/200”.
?settingsButton=off
Hide the settings button.
Use case: Control whether or not the settings button is displayed in the room header.
?pipButton=off
Hide the Picture in Picture button.
Use case: Control whether or not the Picture in Picture button is displayed in the room header. Picture in Picture lets you pop out your meeting guests’ faces while browsing other tabs or applications.
?moreButton=off
Hide the “…” button.
Use case: Control whether or not the “…” button is displayed in the room header.
?topToolbar=<on|off>
Used to toggle the entire top toolbar on/off.
Use case: When using the minimal parameter, the top toolbar is hidden along with many other UI elements. Using topToolbar=on will cause the top toolbar to display, which is required if you want to enable breakout groups using breakout=on.
?bottomToolbar=<on|off>
Show/hide the entire bottom tool bar.
User case: Hiding the bottom toolbar entirely can be useful in cases where you are hoping to control in room items like camera or microphone via your own websites UI. This can be achieved when embedding Whereby with the Whereby Embed Element.
?lang=<code>
Set the meeting UI language to match your product or service. Select from either English en, French fr, Italian it, German de, Norwegian nb, Dutch nl, Portuguese pt, Polish pl, Spanish es, Hindi hi, or Japanese jp.
?floatSelf
Float the self view to the bottom right.
Use case: Floating the self view to the bottom right maximizes the space for other meeting participants.
?breakout=<on|off>
Show/hide the Breakout Groups feature for the meeting host.
Use case: Combine bigger meetings with smaller, collaborative sessions. Your hosts can start breakout sessions where participants are split into smaller groups.
?groups=Orange,Banana,Coconut
Predefine up to 20 groups for the breakout groups function.
Use case: Setting up groups ahead of time can save the host time during the meeting. Hosts will still be able to modify the group setup during the session using the in-room controls if needed.
?timer=<on|off>
Show/hide the meeting timer within the room.
Use case: Set this to “on” to have the meeting timer be displayed in the room. When set to “off”, room hosts can still activate the meeting timer from the “…” button, unless this button has been hidden via the ?minimal or ?moreButton=off parameters.
?precallReview=<on|off>
Determines if users see the pre-call review step.
Use case: The pre-call review step will allow users to check their video/audio settings before joining the room, but this can be skipped by setting this parameter to “off”.
?skipMediaPermissionPrompt
Skips the request permissions UI and asks for devices
User case: This parameter will prevent the "Request Permissions" step during the pre-call phase and cause the browser to automatically request device permissions (if requested in the iFrame). This flag is required for Android app integration.
?subgridLabels=<on|off>
Used to toggle name labels for the participants in the subgrid.
Use case: Set this to “on” to show name labels for the participants that are rendered as small tiles in the subgrid. Makes it easier to distinguish participants with their camera off.
?metadata=<string>
Can be used to pass any URL-encoded string so that it is included in the corresponding webhooks. The decoded string has a limit of 512 characters.
Use case: Set it to the user’s ID so that you can easily track through webhooks when a particular user joins or leaves a room.
?lowData=<on|off>
Use a lower resolution by default
Use case: In some situations for users with poor network connections or devices with CPU constraints, it can be helpful to have lower resolution video feeds loading on the call. This can alleviate problems for users reporting issues with choppy video/audio or connecting to rooms.
?autoSpotlight
Automatically spotlight the local participant on room join. 
Note: Only works when the participant joining has host privileges.

Use case: Apply this parameter to ensure focus is directed at the local participant by spotlighting them. The spotlight ensures everyone else in the meeting has a bigger view of this participant.
?roomIntegrations
Integrations are disabled for Whereby Embedded by default while using the ?minimal parameter. We set this by default because Content Security Policy restrictions can sometimes cause integrations to fail in unexpected ways. Currently only our YouTube and Miro integrations will work in an embedded setting.
It is recommended you do testing to verify these integrations behave as expected before releasing to your users.
?virtualBackgroundUrl=<url>
Specify a image url to use as the virtual background for the participant. The image must be provided in 1280x720 resolution in either image/jpeg or image/png format. In addition, the image should be retrievable using CORS.

On creation

Dashboard preferences

Last modified 9d ago

Copy link

On this page

URL parameters

Property details

URL parameters

Property details

`?minimal`

`?video=off`

`?audio=off`

`?screenshare=<on|off>`

`?chat=<on|off>`

`?people=off`

`?leaveButton=off`

`?displayName=<name>`

`?avatarUrl=<url>`

`?background=off`

`?logo=off`

`?locking=off`

`?participantCount=off`

`?settingsButton=off`

`?pipButton=off`

`?moreButton=off`

`?topToolbar=<on|off>`

`?bottomToolbar=<on|off>`

`?lang=<code>`

`?floatSelf`

`?breakout=<on|off>`

`?groups=Orange,Banana,Coconut`

`?timer=<on|off>`

`?precallReview=<on|off>`

`?skipMediaPermissionPrompt`

`?subgridLabels=<on|off>`

`?metadata=<string>`

`?lowData=<on|off>`

`?autoSpotlight`

`?roomIntegrations`

`?virtualBackgroundUrl=<url>`