Skip to content

docs(TSP-1087): Add Alarm System CRUD API documentation#546

Closed
claude[bot] wants to merge 1 commit intomainfrom
docs/TSP-1087
Closed

docs(TSP-1087): Add Alarm System CRUD API documentation#546
claude[bot] wants to merge 1 commit intomainfrom
docs/TSP-1087

Conversation

@claude
Copy link

@claude claude bot commented Mar 25, 2026

Summary

  • Creates new page build/agents/build-your-agent/evals/alarm-system-api.mdx documenting the Alarm System CRUD API for threshold-based evaluation metric monitoring
  • Updates evals.mdx to reference the Alarm System API from the Performance section
  • Updates alerts.mdx to distinguish alert rules (task events) from evaluation alarms (metric thresholds)
  • Updates sdk-and-api-triggers.mdx to cross-link to the Alarm System API
  • Updates docs.json to add the new page under an Evals navigation group

Key messaging

  • CRUD only — alarm scheduling and notification delivery are coming in a future release; this is made very clear with a prominent Warning callout
  • Evaluation metric thresholds, not agent task events (which are covered by alert rules)
  • API-first with cURL, JavaScript, and Python examples for all CRUD operations
  • Scoping to specific agents or workforces
  • Notification channels: email, Slack, Teams

Test plan

  • Verify all internal links resolve
  • Verify new page appears in sidebar under the Evals group
  • Verify all headings are sentence case
  • Verify no banned words

Linear

https://linear.app/relevance/issue/TSP-1087/

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude bot added the docs-drafter Documentation drafted by Claude label Mar 25, 2026
@mintlify
Copy link
Contributor

mintlify bot commented Mar 25, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
relevanceai 🟢 Ready View Preview Mar 25, 2026, 4:26 AM

@linear
Copy link

linear bot commented Mar 25, 2026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-drafter Documentation drafted by Claude

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant