Documentation
Everything you need to install error.page, design your outage experience, and turn errors into engagement.
Getting started
Quickstart
Install the SDK and show your first branded error page in five minutes.
Read →Projects & API keys
How projects, API keys and secret keys work, and how to rotate them.
Read →Browser SDK reference
Every init() option, identify(), track(), captureException(), when the branded page is shown, session replay, and troubleshooting.
Read →API reference
API overview & authentication
Base URL, versioning, the three authentication tiers, rate limits, quotas, error codes and the OpenAPI spec — everything you need to call error.page from any language.
Read →Report errors from any app
The Ingest API for backend services, mobile, desktop and CLI apps — send an error with logs, screenshots and core/crash dumps over plain HTTPS. Copy-paste examples in curl, Python, Node, Go, Ruby, PHP and Java.
Read →Read errors, status & releases
Pull your error stream and project health server-to-server, and mark releases to auto-resolve incidents.
Read →Features
Account Health
Your product-adoption score, setup checklist and 8-week usage trend — see the value you're getting and what to do next.
Read →Usage recording & journeys
Record how people use your site — pageviews, clicks and custom events — tie them to signed-in users, and replay each session as a journey.
Read →Branded error pages
Design the page your users see when your site errors — copy, colours and templates.
Read →Incident feed
How errors are grouped into incidents, deduplicated and acknowledged.
Read →Engagement & lead capture
Turn an outage into a mailing-list opt-in and notify users when you recover.
Read →AI error analysis
Bring your own model to auto-classify incidents by severity and component.
Read →Webhooks & alerts
Push error, acknowledgement and resolution events to Slack, Zendesk or your own endpoint.
Read →Custom domains
Serve your branded error page from a domain you control, like errors.yourcompany.com.
Read →Custom sending domain
Send outage-recovery emails to your users from your own mail server and domain.
Read →Teams & collaboration
Invite teammates into an organization, share projects, and work the same pipeline with roles.
Read →GitHub & Jira integrations
Link incidents to issues and auto-resolve (and notify users) when the fix ships to production.
Read →Attachments & screenshots
Attach screenshots, logs and diagnostic files to an error report, within your plan's size limits.
Read →Security
Security overview
Start simple, add protection as you grow — the layered path from public key to signed tokens.
Read →Hardened ingest (signed tokens)
Verify short-lived signed tokens your server mints so forged reports can't be trusted. Includes sample code.
Read →Single sign-on (SAML)
Connect your identity provider (Okta, Entra ID, Google) so your team signs in via SAML, with JIT provisioning.
Read →