HeimPulse API

Programmatic access to services, incidents, and regions - authenticate with an org-scoped API key.

Start with Getting started, then browse the full API reference.

Guides

Getting started — Authenticate a request and make your first call to the HeimPulse API.
Authentication and scopes — How API keys work, the two scopes, and what each request is allowed to do.
Rate limits and errors — How /v1 throttles requests, and what every error response looks like.
Services — The real shape of an endpoint's call and assertions, including the few leaves the reference documents as opaque objects.
Incidents — The real request/response field shape for POST /v1/incidents and its /updates route.
API keys vs. webhooks — Two different, complementary mechanisms it's easy to conflate.

llms.txt and llms-full.txt summarize this site for LLM tooling, and the raw spec is always at /openapi.json.