GoRunner docs
Search or askSearch⌘K

Error codes

Every error code the API, the embed SDK, a workflow check and the preflight check can return.

Every API error has the same body. Branch on error.code. The message is written for a person and may change. Some codes add a details object, such as {"reason": "revoked"}.

json
{ "error": { "code": "CONCURRENCY_LIMIT", "message": "…" } }

The request · 400, 405, 422 13

Access · 401, 403 19

Not found or in conflict · 404, 409 29

The body · 413, 415 2

Limits · 429 4

The server · 500, 503 14

The embed SDK’s codes, from mount(), the error event, and its methods.

When mounting, or after 16

  • not_allowed_heremount() or the error event

    Your page's origin is not one of the installation's allowed websites (Platform › Partner keys › Allowed websites), or the page has no web origin at all (a file: page). The browser would block the frame, so the SDK refuses before it is made.

  • licencemount() or the error event

    The installation's license does not include Embed, or the installation is paused because its license ended.

  • unavailablemount() or the error event

    Embedding is turned off on the installation (sign-in is off), or nothing is switched on for this person, so there is no page to show them.

  • code_failedmount() or the error event

    getCode threw, returned something that is not a code, or did not settle in time. The message carries your error's message.

  • code_expiredmount() or the error event

    The installation refused the code, and the fresh one the frame asked for too: used, or older than 60 seconds. Check that your server asks for a new code on every call rather than handing out a cached one.

  • access_endedmount() or the error event

    The person no longer has access to this account: they were removed, or the account or the workspace was deleted. A new code for the same account will not help.

  • account_suspendedmount() or the error event

    This account is suspended: everything can be read, nothing can be changed or run. A warning: the frame stays open, and the error event has fatal: false.

  • not_availablemount() or the error event

    The page you mounted is switched off for this person: “The page this embed was asked to open (/overview) is switched off here.” Mount without it, or with one that is on. The frame says this, so every SDK version gets it.

  • session_failedmount() or the error event

    The session could not be renewed: the host page did not hand over a new sign-in code.

  • unreachablemount() or the error event

    The frame could not reach the installation while signing in.

  • crashedmount() or the error event

    The frame hit an error it could not recover from.

  • version_mismatchmount() or the error event

    The frame and the SDK share no protocol version. Load /embed.js from the installation, or upgrade the package.

  • timeoutmount() or the error event

    The frame did not answer within timeoutMs. The commonest cause is your page's Content-Security-Policy not allowing the installation in frame-src. For a method, the frame did not reply within ten seconds.

  • container_not_foundmount() or the error event

    No element matches the container selector, or the element given is not in the page.

  • invalid_optionsmount() or the error event

    An option is missing or not what it should be; the message names it. Methods use it for an argument they cannot take, such as a theme that is not one.

  • unmountedmount() or the error event

    unmount() was called, or the React component went away, before the mount finished. For a method: the instance was unmounted.

From a method 9

  • not_readya method

    The embed is not ready: still mounting, reconnecting, or ended.

  • not_alloweda method

    The page is switched off for this person, or making connections is not available to them.

  • not_configureda method

    Connecting that service is not set up on the installation (no OAuth app for its provider).

  • invalid_pagea method

    What you passed to navigate or switchAccount is not a page.

  • piece_not_founda method

    connect named a service the installation does not have, or an app id that is not one.

  • busya method

    A connection dialog is already open, or the embed is already signing in.

  • invalid_appearancea method

    setAppearance was given something that is not a settings object, one over 16 KB, or one the frame refuses: a value outside the appearance settings, a font service's stylesheet, or an uploaded face whose file is not at the installation's own address or on your page's own website. An appearance in mount() that the frame refuses is ignored, and the embed shows your installation's look.

  • unsupporteda method

    The frame answered without the result the method expects — an installation of another release than this SDK.

  • frame_reloadeda method

    The frame document reloaded, or the embed switched account, while the call was waiting for its reply. Call it again once the embed is ready.

Check a definition answers with diagnostics, and Publish a workflow refuses with the first blocking one. Each has a code, a severity, and where it points: path, step and field. Many also list the allowed values in alternatives.

Errors 26

Warnings 5

Notes 1

  • legacy_error_handling

    A step keeps retry and timeout settings from the old Advanced section. They still apply.

The exit status of the preflight check (check), which setup and every update run first.

Exit statuses 4

  • 0exit 0

    Nothing is wrong. Warnings are allowed.

  • 1exit 1

    At least one problem. Each one names the line to change.

  • 2exit 2

    The command line itself was wrong.

  • 4exit 4

    At least one problem that protects data GoRunner already holds, such as an encryption key that is not the installation’s. Setup, deploy and a container’s start never go past it, even when told to skip the check.

How to handle them: see Errors in the API, The SDK and The preflight check.