Developer documentation

Troubleshoot an installation

Resolve host policies, publication, media and capability problems with scoped evidence.

Player and loader

SymptomCheck
No iframe appearsConfirm that the HTML editor kept both snippet lines, JavaScript executes, and the loader request succeeds.
window.RapidEye is undefinedWait for the async script; initialize programmatic instances after load.
Experience UUID errorReplace EXPERIENCE_ID with the exact published UUID from Copy snippet.
Framing refusedCompare the actual browser origin with Allowed domains, including hostname/port and every framing ancestor. Publish the change.
CSP refuses script/frameCheck your host script-src/frame-src and the iframe frame-ancestors console message separately.
Ready fires but playback failsReady is setup only. Check media processing, the playback request and browser media policy.

Chat, browser tasks and Voice

SymptomCheck
Chat missingEnable Chat, publish and reload. Confirm runtime access and owner capacity.
Browser task unavailableEnable Chat and Browser agent, publish, and have the operator check owner capacity and worker health.
Task preview without answerInspect the task’s requested decision or failure in Chat; a preview alone does not prove completion.
Task still active after host unmountdestroy removes the UI, not the backend task. Use viewer Stop before teardown when the task must end.
Voice controls hiddenCheck the published Voice flag, HTTPS and microphone delegation from every relevant parent policy.
Theme or logo change has no effectThose compatibility fields are not rendered by the current player. Use title/accent for supported branding.

Settings and continuity

SymptomCheck
Draft edits appear unchangedChoose Publish embed changes and confirm the new published revision.
Republished capability appears staleAllow the documented cache window and reload presentation.
Earlier chat disappears after reloadThe runtime restores active task/conversation identity, not prior visible chat messages.
Private grant rejected after retryGrants are short-lived and single-use. Issue a fresh nonce from the authenticated server.
Session lost across tabsGuest storage is scoped to its browser session and iframe partition. Do not share refresh credentials.
Revoke appears delayedAllow recheck/network/cleanup bounds; already loaded media bytes are not erased.

Collect useful evidence

  • Record the host page URL and RapidEye environment.
  • Include the experience identifier and published revision.
  • Record the browser, device, UTC time, visible error and relevant HTTP status/code.
  • Include whether playback advanced and whether the task reached a final answer.
  • Use the support contact agreed for your installation.

Redact credentials, grants, signing secrets and unnecessary viewer conversation content. Report fixture or local checks as such rather than calling them a real partner deployment.