GoRunner docs
Search or askSearch⌘K

Embed

Put GoRunner inside your product.

Embed · Self-hosted with an Embed license

GoRunner inside a partner’s page: the Workflows page of the customer’s own account, with the New workflow button.

Your customers build and run workflows inside your app, in their own account, in your look.

Embed runs on your own installation of GoRunner with an Embed license, which comes from GoRunner. Every page in this section assumes both. See Your license.

Quick startA partner key, a login-code route and the embed in your page · 15 min

How it fits together

Your page, in your customer’s browser, holds the GoRunner frame. The page asks your server for a login code; your server asks GoRunner for it with your partner key. The frame trades the code for a session and talks to GoRunner itself. Your installation holds the embed’s pages, one account per customer, and the Partner API. Your customer’s browser Your pageyour product GoRunner framefrom mount() Your serverkeeps the partner key GoRunner · your installation The embed’s pagesshown in the frame Accountsone per customer Partner API/api/embed/v1 asks for a login code session · gri_… partner API · gre_… The same picture, top to bottom: your page with the GoRunner frame, your server, then GoRunner. Your customer’s browser Your page GoRunner frame login code Your serverkeeps the partner key gre_… gri_… GoRunneryour installation
The partner key stays on your server. The page only ever holds a login code, which works once, and the frame its own session.

Common tasks

Look something up: SDK · Events and the protocol · Partner API · Workflows and runs from your server · Platform screens