Public docs

Overview

What opSentry is, how it works, and where to start.

Phase 1 shell: this docs surface is wired to the existing backend and repo documentation, and will be expanded as the private dashboard comes online.

What is opSentry?

opSentry is a change intelligence platform. It sits between your engineering team's releases and the people who manage customer and partner relationships.

When a new changelog or release comes in, opSentry:

  • Extracts structured change data (what changed, what type, which area)
  • Detects risk signals — breaking changes, auth impact, migration requirements
  • Identifies which partners are likely affected based on their API scopes
  • Creates a tracked alert with severity, status, and affected partner list
  • Provides your CS and support team with clear, actionable summaries

Two ways to use opSentry

1. The dashboard (no code required)

Sign in, upload your partner map, and create alerts manually or via the AI ingest pipeline. Everything is managed through the opSentry interface.

2. The API (for engineering teams)

Send changelogs programmatically using your API key. The core translate and ingest endpoints let you wire opSentry directly into your release pipeline.

API key vs. session auth

Core API endpoints (/v1/translate, /v1/history, /v1/metrics) require an X-API-Key header.

App API endpoints (alerts, partners, team, apps) are protected by session auth — they require the bearer token returned by POST /app-auth/login, sent as an Authorization: Bearer <token> header, and every request is checked against your workspace membership. The AI ingest endpoint (/ingest/changelog) uses app credentials instead — an X-Client-ID + X-Client-Secret pair you create in the dashboard.

Where to start

  • If you're new: read Quickstart → Authentication → POST /v1/translate
  • If you want AI ingest: read POST /ingest/changelog
  • If you're setting up the dashboard: read the App API section