Check the installation can be embedded
This page needs your own installation with an Embed license.
GET/
Says whether this installation can be embedded, and whether the page asking may show it. Public.
Needs nothing: it is public.
Parameters
Query
originOptional · stringThe page to ask about, when the frame itself asks. A page on another website is asked about by its own
Origin, and this is ignored.
Read it
available is false when Embed isn’t licensed or sign-in is off (reason). originAllowed says whether the page asking may show the embed; allowedOrigins holds that page’s own address when it may, and is empty otherwise. The lists of websites are never given out.
It needs no key and answers any website (Access-Control-Allow-Origin: *). Send its ETag back as If-None-Match.
Responses
- 200OK
Whether the embed works here.
- 304
Nothing changed since the
ETagyou sent. Something failed on the installation’s side. Try again.
Any call can also answer: 429 RATE_LIMITED · 503 BUSY. See Errors.
Request
GORUNNER="https://automations.example.com"
URL="$GORUNNER/api/embed/v1/"
URL="${URL}bootstrap?origin=https%3A%2F%2Fapp.bakery.example"
curl "$URL"const GORUNNER = "https://automations.example.com";
const res = await fetch(
`${GORUNNER}/api/embed/v1/` +
`bootstrap?origin=https%3A%2F%2Fapp.bakery.example`,
);
const { data } = await res.json();import os, requests
GORUNNER = "https://automations.example.com"
res = requests.get(
f"{GORUNNER}/api/embed/v1/bootstrap",
params={
"origin": "https://app.bakery.example",
},
)
data = res.json()["data"]Response · 200 OK
{
"data": {
"protocol": "gorunner-embed/1",
"protocols": [
1
],
"available": true,
"reason": null,
"originAllowed": true,
"allowedOrigins": [
"https://app.bakery.example"
]
}
}Every field
It takes no body.
Response · 200 OK
dataobjectprotocolstringprotocolsarray of integersavailablebooleanreasonstring or nullOne of
not_licensed,sign_in_off,null.originAllowedbooleanWhether the page asking may host the embed: one of the installation’s allowed websites, or a website the partner’s server allowed for one customer.
allowedOriginsarray of stringsThe asking page’s own origin when it is allowed; empty otherwise. Never the lists.