Gruveo Embed API for Web

This is legacy documentation. We are no longer onboarding new Gruveo for Developers customers.

The Embed API lets you add a Gruveo embed to your page and control the embed using JavaScript. Using the methods exposed by the API, you can make the embed perform functions like starting or ending a call. You can also add event listeners that will get triggered in response to certain embed events, such as a state change.

Below is an example of a basic Gruveo embed with a pre-populated room name. (For more, check out the Examples section.)


Supported Platforms and Compatibility

Gruveo must be embedded in an HTTPS page of your web application. Due to security restrictions in certain browsers (e.g. Chrome), the embed WILL NOT work if inserted in a non-secure HTTP page.

The Embed API supports the following devices and platforms:

  • Desktop or laptop:
    • Recent Chrome, Firefox and Microsoft Edge on Windows, macOS and Linux
    • Safari 12.1 and above on macOS
  • Android phones and tablets:
    • Chrome and Firefox for Android, as well as other Chrome-like browsers
  • iPhone, iPad and iPod touch:
    • Safari on iOS 12.2 and above
    • Third-party and in-app browsers on iOS 14.3 and above. For example: Chrome for iOS, or the in-app browser in the Facebook app.

Screen Sharing Support

The Embed API supports outgoing screen sharing in Chrome and Firefox on desktop. For implementation details, please see see the description of the embed.toggleVideo() method as well as the screenSharingAvailability and streamStateChange events in the JavaScript API Reference. Our Basic Demo also provides an example of accessing the screen sharing functionality through the Embed API.

Exploring Further

Use the table of contents to the right to dig deeper and learn how to use the Gruveo Embed API to add video and voice calling functionality to your web app.