1. OpenAPI (Demo)
  2. System
  3. Get API health
ReadmeGitHub
  • Platform API overview
  • Quickstart
  • POSTCreate a member session
  • POSTRefresh a member session
  • DELETERevoke a member session
  • GETList organizations
  • POSTCreate an organization
  • GETGet an organization
  • PATCHUpdate an organization
  • GETList organization members
  • POSTInvite an organization member
  • DELETERemove an organization member
  • PATCHUpdate a member role
  • GETList projects
  • POSTCreate a project
  • GETGet a project
  • DELETEArchive a project
  • PATCHUpdate a project
  • GETList project environments
  • POSTCreate a project environment
  • GETList project documents
  • POSTCreate a project document
  • GETGet a document
  • DELETEArchive a document
  • PATCHUpdate a document
  • POSTPublish a document
  • GETList contacts
  • POSTCreate a contact
  • GETGet a contact
  • DELETEDelete a contact
  • PATCHUpdate a contact
  • GETList product events
  • GETGet analytics overview
  • GETList workflows
  • POSTCreate a workflow
  • GETList workflow runs
  • GETList webhook subscriptions
  • POSTCreate a webhook subscription
  • GETGet a webhook subscription
  • DELETEDelete a webhook subscription
  • PATCHUpdate a webhook subscription
  • GETList webhook deliveries
  • POSTReplay a webhook delivery
  • GETList files
  • POSTCreate a multipart file upload
  • GETGet file metadata
  • DELETEDelete a file
  • GETGet current subscription
  • PATCHUpdate subscription settings
  • GETList invoices
  • GETGet metered usage
  • GETList API keys
  • POSTCreate an API key
  • POSTRevoke an API key
  • GETList audit logs
  • GETList exports
  • POSTCreate an export
  • GETGet API health
GET/system/health

Get API health

Returns public API component health. This endpoint requires no authentication.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Responses

200application/json

Current health status.

{
  "status": "operational",
  "checked_at": "2026-09-03T12:35:00Z",
  "components": [
    {
      "name": "public_api",
      "status": "operational",
      "latency_ms": 42
    },
    {
      "name": "event_delivery",
      "status": "operational",
      "latency_ms": 81
    },
    {
      "name": "file_processing",
      "status": "degraded",
      "latency_ms": 920
    }
  ],
  "incident": null
}
statusenumoptional

Values: "operational" · "degraded" · "outage"

checked_atstring · date-timeoptional
componentsarray<object>optional
incidentobjectoptional
503application/json

One or more components are unavailable.

{
  "status": "operational",
  "checked_at": "2026-09-03T12:35:00Z",
  "components": [
    {
      "name": "public_api",
      "status": "operational",
      "latency_ms": 42
    },
    {
      "name": "event_delivery",
      "status": "operational",
      "latency_ms": 81
    },
    {
      "name": "file_processing",
      "status": "degraded",
      "latency_ms": 920
    }
  ],
  "incident": null
}
statusenumoptional

Values: "operational" · "degraded" · "outage"

checked_atstring · date-timeoptional
componentsarray<object>optional
incidentobjectoptional
Create an export< Previous

Powered by heyo

curl --request GET \  'https://api.demo.heyo.example/v3/system/health'
{  "status": "operational",  "checked_at": "2026-09-03T12:35:00Z",  "components": [    {      "name": "public_api",      "status": "operational",      "latency_ms": 42    },    {      "name": "event_delivery",      "status": "operational",      "latency_ms": 81    },    {      "name": "file_processing",      "status": "degraded",      "latency_ms": 920    }  ],  "incident": null}