Getting Started
What Breaklytix watches, how alerts work, and your first scan.
Authentication & GitHub
Sign in securely with GitHub and connect your repositories.
Signing in with GitHubBreaklytix uses GitHub OAuth for authentication. No passwords, no tokens stored in our database.Connecting and disconnecting GitHubManage the read-only GitHub connection that powers repository scanning.Repository ScannerStatic analysis that maps the APIs used in your code and checks them against provider changes.
Provider Monitoring
Which APIs we monitor for breaking changes.
Monitored providersThe API providers Breaklytix tracks, and how coverage works.Provider changes & changelogHow breaking changes are collected, matched, and turned into alerts.Runtime Intelligence overviewLive health signals for each provider you connect: errors, failures, incidents, and rate limits.API errors & failuresElevated error rates and failed calls on your integrations.Provider incidentsOfficial incident status for monitored providers.Rate limit eventsSee when your usage approaches or exceeds API rate limits.Code break detectionStatic analysis results that locate the code a provider change affects.Deprecated APIsUsage of API versions or endpoints providers have deprecated.Auto-fix PRsMechanical fixes Breaklytix proposes when a change is unambiguous.Impact EngineQuantify what a breaking change means for your repositories before it ships.API Fire DrillSimulate a breaking change to see how your team would respond — without waiting for a real one.Deploy day checklistA practical playbook for the day a breaking provider change lands.AlertsThe alert lifecycle: created, matched, resolved, ignored.Notification preferencesWhich triggers email you: breaking changes, code breaks, errors, incidents, digests.Email alerts & delivery statusHow alert emails are sent, and what 'accepted by provider' means.Agency ModeRun Breaklytix for external clients through your own GitHub App installation.Client invites & email statusInviting clients, resending, and reading honest email status.Developer CLIScan a repository and get Breaklytix findings without leaving the terminal.Slack integrationMirror alerts to a Slack channel.Settings overviewProfile, GitHub connection, theme, notifications, email, billing, and danger zone.Theme (light / dark / system)Appearance preference stored on your device, applied without flash.API keysProgrammatic access to your Breaklytix data for scripts and the CLI.Security model & privacyEncryption, scoping, and why Breaklytix never sees your keys.Privacy PolicyWhat we collect, store, and share.Terms of ServiceYour rights and obligations when using Breaklytix.Plans & billingTrials, monitored-API limits, and renewal.TroubleshootingCommon issues and their fixes.FAQCommon questions about Breaklytix.
33 articles covering every feature of Breaklytix.