Skip to content
Everframe Docs
Documentation

Overview

One report format across every platform. Pick your SDK to get started, or read the envelope if you are writing a receiver.

Updated

An Everframe report is a single typed, signed document: a screenshot, the trail of actions that led to the bug, console and network state, device context, and a replay — delivered to your tools or our dashboard.

The report format is identical on every platform, so your triage prompts, your integrations and your receiver code are written once and never change when you add a platform.

Choose your SDK

SDKCovers
ReactReact web apps — a provider and a hook
WebEvery other web app — Vue, Svelte, Angular, Astro, or plain HTML
React NativeiOS, Android, tvOS and Vega OS
iOSiPhone, iPad and Apple TV, native Swift
AndroidPhones, tablets, Android TV and Fire TV, native Kotlin

Each SDK’s section is self-contained — install, configuration, and every capture feature documented for that platform only, so nothing on the page is about somebody else’s runtime.

React or Web? They share one capture core and produce the identical envelope, so this is not a feature trade: use React if your app is React, and Web for anything else. The difference is the binding — a provider, a hook, a <Sensitive> wrapper and an identity prop on React, a plain init() handle on Web. Capture is the same.

Writing a receiver?

You do not need an SDK for that. The server-side contract is one shared set of pages:

How it works

  1. Capture. A user reports a bug from inside your app, or an uncaught error files one on its own. The SDK assembles a screenshot, the breadcrumb trail, console and network state, and device metadata.
  2. Package. Everything becomes one typed envelope, protocol version 1.0.
  3. Ingest. The SDK posts it to the ingest API, authenticated with your SDK key.
  4. Deliver. Everframe fans the report out as a signed webhook to every receiver you have configured — your own tools, or the dashboard.

Retention, and what you own

Everframe is a pass-through pipe. Report artifacts are served only for your plan’s retention window — 14 days to unlimited, depending on plan — and are permanently erased a further 14 days after that window ends.

On the Free plan, attachments are also withheld while an organisation is over its install limit. Withheld is reversible: nothing is deleted, and the artifacts return when the org is back within its limit. Sustained overuse is different: on every plan, an organisation over its limit for two complete months has ingestion suspended until it upgrades or finishes a month within the limit — see Errors & limits.

You own the data and choose where it goes. See Data & retention.