Docs
Getting started, custom domains, the REST API, and webhooks. The in-app reference with copy-paste commands is at /app/#/docs/api.
Getting started
- Create an account. Signup does not ask for a card. The 14-day trial starts when you create the account. Add a card later from Billing if you want the paid plan.
- Create a client status page and add components.
- Share the page. On statusfleet.app the public page is the app route for that slug. On a custom domain the same page is served at
/. - Optional: add subscribers, a Slack or webhook integration, and HTTPS uptime monitors.
One account can hold up to 10 status pages and 20 monitors. A monitor checks an HTTPS URL with GET or HEAD every 1, 5, or 10 minutes. After the failure threshold, the monitor opens an incident. A later success resolves that incident when the page allows it.
Custom domains
Each status page can have one hostname, such as status.client.com. The hostname has to be a subdomain of a registrable domain. Apex names such as example.com and example.co.uk are rejected, and names under statusfleet.app are rejected.
- In the page editor, add the hostname.
- At the client’s DNS, create
status.client.comas a CNAME tocustomers.statusfleet.app. - Use Check in the editor until hostname status and SSL are both active.
A mapped custom domain serves that client’s status page, including paths such as /pricing. It does not serve this marketing site. An unknown *.statusfleet.app name returns 404 unless it is an active custom hostname.
API reference
Version 1 is an account API. Create a key on the dashboard. The full key is shown once and looks like sf_live_<prefix>_<secret>. Send it as Authorization: Bearer. The Supabase gateway also expects the project publishable key in the apikey header. The bearer key chooses the account. Another account’s page, component, or incident is a 404.
export API="https://wfhcckdxmrnhccakafyh.supabase.co/functions/v1/api" export SUPABASE_ANON_KEY="<project publishable key>" export STATUSFLEET_API_KEY="sf_live_..." curl "$API/v1/pages" \ -H "apikey: $SUPABASE_ANON_KEY" \ -H "Authorization: Bearer $STATUSFLEET_API_KEY"
Routes used by the in-app reference:
GET /v1/pagesandGET /v1/pages/:idGET /v1/pages/:id/monitorsandGET /v1/pages/:id/componentsPATCH /v1/components/:idwith a component statusPOST /v1/pages/:id/incidentsandPOST /v1/incidents/:id/updatesPOST /v1/incident-groupsto post one incident to several pages
New incidents start as investigating. A resolved update restores linked components when no other open incident still affects them. Creating or updating an incident, and changing a component status, uses the same path as the dashboard, so webhooks, Slack, and subscriber email send as they do there.
Sixty requests per key are allowed each minute. The 61st returns 429 and a Retry-After header. Errors use {"error":{"code":"...","message":"..."}}.
OpenAPI document and the in-app command reference.
Webhooks and Slack
A page integration is either a Slack incoming webhook or an HTTPS webhook you host. Slack URLs have to be https://hooks.slack.com/services/.... Slack messages are unsigned. Other webhooks must be HTTPS. StatusFleet does not follow redirects, and it refuses loopback, link-local, and private addresses.
A customer webhook is a JSON body. The payload includes id, event, and page. Incident events include incident and may include update. A component change uses event component.status_changed and a component object with status and previous_status.
Signed webhooks send two headers:
X-StatusFleet-Timestamp— unix secondsX-StatusFleet-Signature—sha256=plus HMAC-SHA256 oftimestamp + "." + raw body, using the integration signing secret
Verify the signature against the raw body before you trust the JSON. Compare in constant time and reject a timestamp that is too far from now.