Monitoring API

Continuous compliance monitoring — schedule automated checks, receive alerts, and configure webhook notifications. All endpoints require JWT authentication.

Schedules (4)

POST /api/v1/monitoring/schedules 🔒

Create a scheduled compliance check.

Request Body

Field	Type	Required	Description
`frameworkId`	string	Yes	Framework to check
`frequency`	string	Yes	`daily`, `weekly`, `monthly`, `quarterly`
`businessProfile`	object	Yes	Business profile for checks
`notifyOnFail`	boolean	No	Send alert on failures (default: true)

curl -X POST https://api.privabase.com/api/v1/monitoring/schedules \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "frameworkId": "gdpr",
    "frequency": "weekly",
    "businessProfile": { "collectsPersonalData": true, "hasPrivacyPolicy": true },
    "notifyOnFail": true
  }'

GET /api/v1/monitoring/schedules 🔒

List all monitoring schedules.

DELETE /api/v1/monitoring/schedules/:id 🔒

Delete a monitoring schedule.

POST /api/v1/monitoring/schedules/:id/run 🔒

Trigger an immediate run of a scheduled check.

Results

GET /api/v1/monitoring/results 🔒

Get monitoring check results. Supports filtering by framework, date range, and status.

Webhook Notifications (3)

POST /api/v1/monitoring/webhooks 🔒

Request Body

{
  "url": "https://your-app.com/webhooks/privabase",
  "events": ["check.failed", "check.degraded", "schedule.error"],
  "secret": "your-webhook-secret"
}

GET /api/v1/monitoring/webhooks 🔒

List registered webhooks.

DELETE /api/v1/monitoring/webhooks/:id 🔒

Delete a webhook registration.

Alerts (3)

GET /api/v1/monitoring/alerts 🔒

List compliance alerts — triggered when scheduled checks fail or scores degrade.

POST /api/v1/monitoring/alerts/:id/read 🔒

Mark an alert as read.

POST /api/v1/monitoring/alerts/read-all 🔒

Mark all alerts as read.