Stagecast Integration API

Search…
Version 3.0
Activation discovery
get
https://d21pr33ep1h6mu.cloudfront.net
/api/workspaces/:workspaceId/activations/
Polling For Active Activations in a workspace
Note: You may use console.stagecast.io as host for development tests but please use our CDN host d21pr33ep1h6mu.cloudfront.net for production.
Opening activations in app webview
Note: When you integrate Stagecast into your App WebView, make sure to enable the support for window opening (more on this topic here and here).
get
https://console.stagecast.io
/api/open
Open an activation
The workspaceId can be found in the web frontend on https://console.stagecast.io/login for your created workspace. Look in the URL path once you have navigated to your workspace - it is some uuid string such as F5D6E9D6-5F1E-4A43-8348-0DA8BBAA29AF or similar - and replace :workspaceId in the request above with the uuid string you find.
Sample Code Snippets
Swift
import UIKit
import WebKit
class ViewController: UIViewController {
    @IBOutlet weak var webView: WKWebView!
    override func viewDidLoad() {
        super.viewDidLoad()
        let myURL = URL(string:"https://console.stagecast.io/api/open?code=abc123&deviceId=my-unique-device-id")
        let myRequest = URLRequest(url: myURL!)
        webView.load(myRequest)
    }
}
Opening activations in a browser
get
https://join.stagecast.io
/?code=:code
Open current activation in a browser
Embed in your website
If you want to embed the activations in your website. Just copy-paste the following code snippet where you want it to be displayed. You will have to replace the room code, with the one belonging to your workspace room.
Depending on your implementation, you might have to edit the style property.
HTML
Example
<iframe
    id="stagecast-embed"
    allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; microphone; midi; vr"
    title="Stagecast Embedded"
    style="width:100vw; height: 100vh; margin: 0;"
    src="https://join.stagecast.io/?code=YOUR_ROOM_CODE">
</iframe>
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Test Embed</title>
    <style>
        * {
            box-sizing: border-box;
        }
        body {
            margin: 0;
            padding: 0;
            overflow: hidden;
        }
    </style>
</head>
<body>
    <!-- The iframe is embedded in a page with a header -->
    <header style="height: 100px; width: 100%">
        <h1 style="margin: 0;">This is the page header</h1>
    </header>
    <iframe
        id="stagecast-embed"
        allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; microphone; midi; vr"
        title="Stagecast Embedded"
        style="width:100vw; height: calc(100vh - 100px); margin: 0; padding: 0; border: none;"
        src="https://join.stagecast.io/?code=1021">
    </iframe>
</body>
</html>
Missing a feature? This is the most high-level integration API:s that we encourage people to use. But if you have further requirements, such as needing to extract results and data out of the system, pleae feel free to contact us. We do have more API:s available - they are just not yet published here.
We are working hard to build the best possible product for you. Please let us know in case you are missing a feature and we will be quick to respond. Thank you for your help!
​Fill out the Feature Request Form****
​
Last modified 11mo ago
Copy link
On this page
Activation discovery
get
Polling For Active Activations in a workspace
Opening activations in app webview
get
Open an activation
Opening activations in a browser
get
Open current activation in a browser
Embed in your website