Skip to main content

​
title: ‘API overview’ description: ‘Integrate WHAWIT with your observability stack, incident tooling, and CI/CD pipelines’

​
What the WHAWIT API does

The WHAWIT API lets you automate and extend the platform so it fits cleanly into your existing tooling. Typical use cases include:
  • Syncing incident and insight data into ticketing systems.
  • Building custom internal dashboards on top of WHAWIT’s incident understanding.
  • Managing services, environments, and integrations as code.
  • Exporting recommendations and code-level findings into your engineering workflow.
The examples in this section are placeholders. Replace them with real endpoints and payloads as your WHAWIT API stabilizes.

​
Authentication

WHAWIT uses Bearer tokens for authentication.
Tokens should be kept secret and rotated regularly. Use environment variables or your secrets manager rather than hard-coding tokens in source control.

​
Example endpoints

The starter kit includes placeholder endpoints that you can repurpose for WHAWIT:

List incidents

Replace with an endpoint that lists recent incidents with summaries, severity, and affected services.

Create recommendation

Replace with an endpoint for creating or tracking reliability recommendations.

Dismiss or resolve items

Replace with an endpoint that archives or resolves recommendations or incidents.

Incident webhooks

Replace with an endpoint that documents how WHAWIT posts incident and insight webhooks into your systems.

​
OpenAPI specification

Once your WHAWIT API is defined, update openapi.json in this folder (or point to a remote spec) so the reference pages stay in sync with the live API. Until then, treat the existing openapi.json and endpoint pages as scaffolding for future work.