Skip to main content

Documentation Index

Fetch the complete documentation index at: https://noradocs.solomontsao.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Alert rules API

Workspace-scoped CRUD for alert rules. Webhook deliveries are queued with retry; email deliveries dispatch inline.
All endpoints are mounted under /api/workspaces/:workspaceId/alert-rules. Use a workspace-scoped API key (agents:read or agents:write scope, matched to the role each route requires) or an authenticated session cookie. See the Alert rules guide for event patterns, channel shapes, and how delivery retry works.

​
List rules

GET /api/workspaces/{workspaceId}/alert-rules
Required role: viewer. Response 200: 
[
  {
    "id": "rule-uuid",
    "workspaceId": "workspace-uuid",
    "createdBy": "user-uuid",
    "name": "Production errors",
    "eventPattern": "agent.*",
    "channels": [{ "type": "webhook", "url": "https://hooks.example.com/nora" }],
    "enabled": true,
    "lastFiredAt": "2026-05-07T00:00:00Z",
    "lastError": null,
    "createdAt": "2026-04-01T00:00:00Z",
    "updatedAt": "2026-05-01T00:00:00Z"
  }
]

​
Create a rule

POST /api/workspaces/{workspaceId}/alert-rules
Content-Type: application/json
Required role: admin. Body: 
{
  "name": "Production errors",
  "eventPattern": "agent.*",
  "channels": [
    { "type": "webhook", "url": "https://hooks.example.com/nora", "headers": { "Authorization": "Bearer ..." } },
    { "type": "email", "to": ["ops@example.com"], "subjectPrefix": "PROD" }
  ],
  "enabled": true
}
FieldTypeRequiredNotes
namestringYesDisplay name; trimmed and capped at 100 characters.
eventPatternstringYesLiteral (agent.error), suffix glob (agent.*), or *. Capped at 100 characters.
channelsarrayYesAt least one channel. Each entry is an object with a type and type-specific fields. See the guide.
enabledbooleanNoDefaults to true.
Response 200: the serialized rule (same shape as the list endpoint entries). Errors:
  • 400 — validation failure (empty channels, malformed URL, unsupported channel type, too many email recipients).
  • 403 — caller lacks the admin role on this workspace.

​
Update a rule

PATCH /api/workspaces/{workspaceId}/alert-rules/{ruleId}
Content-Type: application/json
Required role: admin. Body fields are all optional; supply only the ones you want to change. Same validation rules as create. 
{
  "enabled": false
}

​
Delete a rule

DELETE /api/workspaces/{workspaceId}/alert-rules/{ruleId}
Required role: admin. Response 200: { "success": true }.

​
Send a test event

POST /api/workspaces/{workspaceId}/alert-rules/{ruleId}/test
Required role: admin. Fires a synthetic event matching the rule’s pattern through the same delivery pipeline. Webhooks are queued with retry; emails are sent inline. Use this to verify channel configuration without waiting for a real event. Response 200: { "success": true }. Delivery results land asynchronously on the rule’s lastFiredAt and lastError.