anchorAbout the Embedded Apps Framework

The Webex Embedded Apps Framework lets you easily integrate your existing web applications into Webex meetings and spaces. Webex Embedded Apps present a seamless user experience, and, as with Webex itself, can run across multiple platforms, including Windows, Mac, Linux, iOS, Android, and any popular web browser.

This guide provides the following:

• Overview of the embedded app experience in Meetings and Spaces
• Developer quick start
• Embedded Apps Framework API Reference
• Design guidelines and considerations for apps running in meeting, messaging and device contexts.

Create an Embedded App

anchorWhy Embedded Apps?

Webex users collaborate with each other both in real-time during Webex meetings and on an ongoing basis in Webex spaces. However, the information that they need to reference often resides in other web-based applications, requiring them to switch contexts and their focus between the meeting or in-space discussion and the external application. Webex Embedded Apps facilitate surfacing those other applications directly within the Webex in-meeting and in-space interfaces, making it frictionless for users to reference specific 3rd party application content and enabling other participants to access and interact with it directly:

anchorAbout Embedded Apps in Spaces and Meetings

This section provides a high-level overview of the user experience for using embedded apps in Webex meetings and spaces. In each case the process starts with a meeting participant clicking the Apps button (in a meeting) or tab (in a space) to view the list of available apps, and then opening your app.

The app the user opens is called the initiator app and is the one specified by your app's "Start Page URL" when you create a new embedded app in the Developer Portal. The purpose of the initiator app is to share the URL of an app — the shared app — that is either opened with meeting participants in real-time, or added as a tab to a space.

This URL is passed the framework's setShareUrl() method, which causes an Open for all or Add to tab button to appear in the initiator app's window, depending if the app is running in a meeting or space, respectively. Read more the user experience of in-meeting and in-space embedded apps.

anchorIn-Meeting App Experience

For purposes of discussion we'll look at an app for an online polling service. The initiator app in this example (shown below) lets the user create poll questions that are shared with meeting participants. Participants can select an option and send their answer. The initiator app also provides a view for observing live poll results.

When the user is ready to share the poll they click Create poll, which invokes the setShareUrl() method, passing it the unique URL for the poll and a string for the window title. The initiator app obtains the poll URL from a custom polling service and passes it to setShareUrl():

function createPoll() {
    // Custom app code to get poll instance for given configuration
    var pollURL = pollService.getPollUrl(pollConfig);
    app.setShareUrl(pollUrl, "", "Proposal Poll");
}

Calling setShareUrl() also causes the Open for all button to appear in the initiator app's window.

Clicking this button opens the shared URL in a sidebar window for all meeting participants, as shown below. Participants can also click a button in the window's title bar to open it in a separate window. In this case the app lets participants select a poll option and submit their answer.

In the initiator app the user can view poll results as they are tabulated. To end the sharing session — that is, close the app window for all meeting participants — the user of the initiator app clicks Close for all, which has replaced the Open for all button.

The initiator app calls clearShareUrl() to hide the Open for all button.

app.clearShareUrl();

Notes:

• The meeting host or co-host(s) will see the Close for all button when a sharing session is in progress, even if they did not click Open for all to start the session. This provides hosts with the ability to end a sharing sessions even if they didn't start it themselves.

• For a given meeting, only one sharing session can be started at a time. If a meeting participant starts a sharing session via one initiator app, and then tries to start another session with a different initiator app, the participant is prompted if they would like to stop the current session and start a new one.

  

  If a meeting participant starts a sharing session and a second user tries to start another session, the second user will see the following error dialog.

  

  Apps can avoid the latter scenario by checking if a sharing session is in progress before calling setShareUrl().

anchorIn-Space App Experience

The same initiator app can be used for both meetings and spaces, or you can specify a unique URL for each context (see Creating your Embedded App). There are some differences in the user experience of in-space compared to in-meeting apps to consider, as discussed below.

The screenshot below is of the initiator app open in a Webex messaging space. As with the in-meeting experience the user enters the poll questions and clicks Create poll which invokes setShareUrl(), causing an Add to tab button to appear.

Clicking Add to tab adds the specified URL as a tab to the space, as shown below. At the time the initiator app window closes. For this reason the in-space app design is slightly different than the in-meeting version: the poll results are provided in a separate tab of the shared app rather than in the initiator app.

A feature unique to in-space apps is that you can optionally pass setShareUrl() the URL of a version of the shared app that's meant for use outside of the Webex client. For example, the following call to setShareUrl() includes the external URL "https://www.example.com/poll_123_ext" for the poll.

app.setShareUrl("https://www.example.com/poll_123", "https://www.example.com/poll_123_ext", "Proposal Poll"`

The external URL is exposed to users via the Open in browser and Copy URL space tab menu items, as discussed in Space tab menu items.

To clear the shared URL the initiator app calls clearShareUrl().

app.clearShareUrl();

Space tab menu items

The following lists the menu items displayed for an embedded app's space tab. Note that some of the menu items are only available to space moderators, as noted.

• Expand — Opens embedded app in a new window.
• Copy link — Copies external URL of embedded app to the clipboard. Only appears if a URL was provided as the second parameter to the setShareUrl() method call.
• Open in browser — Opens embedded app in the system's default web browser. Only appears if a URL was provided as the second parameter to the setShareUrl() method call.
• Edit — Opens a dialog where a user can edit the name the embedded app's tab. In moderated spaces, only moderators can edit an app; in unmoderated spaces any user can edit an app.
• View information — Lists basic information about the embedded app, including its URL, the user who added the app to the Space, the last edited date and the user who made the most recent edits.
• Remove — Removes the app from the Space. In moderated spaces, only moderators can remove apps; in unmoderated spaces any user can remove an app.

anchorSidebar App Experience

Sometimes, you’ll want to have your embedded app available outside of explicit meetings and spaces. As an example, let's look at a CRM application. An end user sales agent wants to run an app that loads the CRM profile of a caller before answering a call so that they are prepared to edit the caller's profile or gather essential information to help with closing a deal. The embedded app developer can configure the embedded as always ON when building the app, meaning that the app launches and is always running in the background when the Webex app launches, and is always able to listen to incoming call events.

When a call comes in, the app can detect the call, extract the caller's number, and use that number to load the corresponding CRM profile:

app.on("sidebar:callStateChanged", (call) => {
    if (call.state = "Started") { 
        const calling_number = call.id; 
    } 
}); 

In order grab the sales agent's attention, the app can show a notification badge, prompting the agent to click on the embedded app:

const badge = { 
  badgeType: 'count', 
  count: 1, 
}; 
const sidebar = await app.getSidebar();
sidebar.showBadge(badge); 

Once the agent clicks on the app, the loaded profile is shown, and the app is notified that it’s now in focus:

app.on("application:viewStateChanged", (viewState) => {
  if (viewState == "IN_FOCUS") {
    // Display the CRM record...
}

The app then displays the CRM record for the caller:

Sidebar Notes

• Sidebar apps are available in the Webex client but not in the Meeting Center client. Also, sidebar apps are not supported on Mobile and Cisco devices at the moment.
• Each organization has a limit of 3 always ON sidebar apps

anchorMore Information

For more information about developing embedded apps, see the following topics:

• Developer quick start — Walks you through the steps to create your first embedded app and test it with the Open for all feature in a meeting, and the Add to tab feature in a space.
• Responding to events — Explains how to register event handlers for various events generated by the framework.
• Embedded Apps Framework API Reference — Complete API reference for embedded app developers.
• Design guidelines and considerations for in-meeting and in-space embedded apps.
• Embedded Apps Framework Sidebar API Quick Start — Walks you through using the Sidebar API to create Always On Embedded Apps that can respond to various events.
• Embedded Apps Framework Sidebar API Quick Start — Walks you through using the Sidebar API to create Always On Embedded Apps that can respond to various events.