Docs / Teams and workspaces
Public status page
An optional status page for the whole server (not per workspace) at /status, with the same data as JSON at /status.json.
ONESEND_STATUS_PAGE=on
ONESEND_ADMIN_EMAILS=ops@example.com,alice@example.com # instance admins: may post incidents
Without ONESEND_STATUS_PAGE=on neither path exists. Search engines may index /status (it is listed in robots.txt); the page has no scripts and no cookies.
What it shows
| Component | Self-check |
|---|---|
| API | a database round trip: operational under 1 s, degraded under 5 s, otherwise down |
| Sending queue | how long the oldest due send job has waited: operational under 2 minutes, degraded under 15 minutes, otherwise down |
| Inbound mail | the same for jobs that deliver received mail to webhooks and rules |
| Dashboard | served by the same server as the API, so it follows the API check |
The checks run every 5 minutes (the status_check job; on Cloudflare Workers the cron trigger runs it). Each check adds to a daily total per component (status_daily), so the page draws 90 daily bars and an uptime percentage: checks that were not down, divided by all checks (degraded counts as up). A component with no check in the last 20 minutes shows No data.
Open incidents are shown at the top, and set their components to degraded (minor impact) or down (major or critical). Resolved incidents are listed under past incidents for 90 days.
Instance admins and incidents
An instance admin is a signed-in person whose account email is listed in ONESEND_ADMIN_EMAILS. Workspace roles do not matter, and API keys are not accepted. Create those accounts yourself (or keep ONESEND_SIGNUP at invite or closed) so nobody else can sign up with a listed address first. The cloud edition's operator console uses the same list.
# post an incident
curl -X POST https://mail.example.com/v1/admin/status-incidents -H "authorization: Bearer $SESSION" -H 'content-type: application/json' \
-d '{"title":"Delayed sending","body":"A provider is slow; mail is queued and will go out.","impact":"major","components":["sending"]}'
# add an update, or resolve it
curl -X PATCH https://mail.example.com/v1/admin/status-incidents/inc_… -H "authorization: Bearer $SESSION" -H 'content-type: application/json' \
-d '{"status":"resolved","body":"All queued mail was sent."}'
| Endpoint | |
|---|---|
GET /v1/admin/status-incidents | list incidents |
POST /v1/admin/status-incidents | title, body, status (investigating, identified, monitoring, resolved), impact (minor, major, critical), components (api, sending, inbound, dashboard; empty means all) |
PATCH /v1/admin/status-incidents/{id} | change any field; body adds an update |
DELETE /v1/admin/status-incidents/{id} | remove an incident posted by mistake |
POST /v1/admin/status-checks/run | run the self-checks now |
/status.json is public, cached for 30 seconds and allows any origin, so another site can embed the status.