Documentation
Reference for how OctoPing checks, alerts, status pages and plans behave.
Getting started
- DocsGetting started with OctoPingWhat OctoPing monitors, how alerts and status pages fit together, and the terms the rest of the documentation uses.
- DocsAdd your first site, alert and status pageAdd a site, get a first alert through the default email notification and publish a status page, using the app's own labels.
Concepts
- DocsChecks referenceWhat each of the eight checks and heartbeats measures, whether it is on by default, how often it runs and what counts as a failure or a change.
- DocsStatusesThe statuses a site and a heartbeat can have in the app and on a public status page, and the order in which the rules apply.
- DocsUptime, downtime and outagesHow uptime percentage, downtime and outage counts are computed, why they don't add up to each other and how maintenance and probe results change them.
- DocsVantage points and confirmationHow the primary checker and the probe regions confirm a failure, what Partial means and why OctoPing alerts when the probes are silent.
- DocsFailure reasonsThe stable failure codes OctoPing assigns to a failed check, their labels and the order in which a failure is classified.
Alerts & integrations
- DocsAlert rulesHow a failed check becomes an alert: the retry threshold, the repeat interval, the four triggers, recovery, the default notification, the log and what a maintenance window holds back.
- DocsEmail alertsWho receives an email alert, what the message contains and how to read the notification log when one doesn't arrive.
- DocsSlack alertsConnect Slack to a workspace, post alerts to a channel, and what the log shows when a message fails.
- DocsDiscord alertsPost alerts to a Discord channel through a webhook URL: setup, the color of each alert and how failures are logged.
- DocsBrowser push alertsTurn on push notifications in a browser, choose who receives them on a site and read the failures the log can show.
- DocsWebhooksThe JSON payload for every website and heartbeat event, the request headers, how to verify the HMAC signature in Python, Node.js, PHP and Go, and how retries work.
API
- DocsAPI overviewThe public endpoints OctoPing offers today, how they are authenticated, their limits and what is not available yet.
- DocsHeartbeat pingReport that a scheduled job ran: the ping endpoint, its optional JSON body, every response and the limits.
- DocsBadgesEmbed a site's uptime or current status as an SVG image: both endpoints, their parameters, colors and embed snippets.
- DocsStatus page JSONRead a published status page and its incident history as JSON: the fields, pagination, caching and error responses.
Status pages
- DocsStatus pagesCreate, brand and publish a status page, choose what it shows and run an incident from first update to resolution.
- DocsCustom domainsServe a status page on your client's own domain: the plan requirement, the DNS records, the statuses a domain moves through and what the domain serves.
- DocsSubscribers and feedsHow visitors subscribe by email, what an incident email contains, the settings and limits, suppression and the Atom and RSS feeds.
- DocsContactsAdd your clients to a status page so they get every alert for its sites and a monthly summary: consent, what is sent, when and how a contact leaves.
Monitoring
Account
- DocsWorkspaces and teamHow a workspace is organized, what each role can do, how invitations and seats work, and how to group and change many sites at once.
- DocsPlans and billingWhat counts as a site, how the trial and a pause work, how to subscribe, what a failed payment or a cancellation does, and how history retention is handled.