Public docs

POST /ingest/changelog

AI-powered ingest that creates an alert directly in your workspace.

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 it does

This endpoint combines changelog analysis with alert creation in one call.

Send raw changelog text and a workspace ID. opSentry will:

  1. Run AI analysis on the changelog (always uses mode: ai)
  2. Derive severity, summary, and alert type from the output
  3. Cross-reference detected scopes against your uploaded partner map
  4. Create an alert in your workspace with the matched partners pre-filled

This is the preferred endpoint for automated release pipeline integrations.

Authentication

Requires app credentials — an X-Client-ID and X-Client-Secret pair you create in the dashboard (your workspace's apps / credentials). Send both as headers on every request. The secret is shown only once at creation, so store it securely.

Request body

{
  "raw_text":            "string (required) — the changelog text",
  "workspace_id":         123 (required) — your workspace ID,
  "created_by_user_id":  456 (optional) — user ID to attribute the alert to
}

How severity is derived

The AI analysis returns an impact_level (low, medium, high). That value is used directly as the alert severity.

How alert_type is derived

Detected from the risk flags in this priority order:

  • breaking_change — if "breaking change" is in risk flags
  • auth — if "authentication impact" is in risk flags
  • billing — if "billing impact" is in risk flags
  • downtime — if "downtime risk" is in risk flags
  • migration — if "migration required" is in risk flags
  • Falls back to the first extracted change's area, or general

How partners are matched

opSentry cross-references the AI-detected impacted_scopes against your workspace's partner map (partner_mappings table). Partners with overlapping scopes are automatically added to the alert's partners list.

If your partner map has not been uploaded yet, the partners list will be empty.

Response

{
  "success": true,
  "alert": {
    "id": 42,
    "workspace_id": 123,
    "severity": "high",
    "summary": "string",
    "partners": ["Northstar Bank"],
    "action": null,
    "created_at": "2025-01-15T10:30:00Z",
    "source": "ai_ingested",
    "alert_type": "breaking_change",
    "metadata": { ... },
    "resolved_at": null,
    "archived_at": null
  },
  "translation_summary": {
    "impact_level": "high",
    "risk_flags": ["breaking change", "authentication impact"],
    "ai_provider": "openai",
    "ai_fallback_used": false
  }
}
Ingest a changelog
curl -X POST https://api.opsentry.ai/ingest/changelog \
-H "Content-Type: application/json" \
-H "X-Client-ID: cli_your_client_id" \
-H "X-Client-Secret: your_client_secret" \
-d '{
"raw_text": "Deprecated scope auth:legacy. Introduced auth:token.rotate. Breaking: integrations using auth:legacy must migrate by June 30.",
"workspace_id": 1,
"created_by_user_id": 2
}'