Skip to main content
GET
/
v1
/
me
/
notifications
Get notification preferences
curl --request GET \
  --url https://api.example.com/v1/me/notifications \
  --header 'Authorization: Bearer <token>'
{
  "user_id": "<string>",
  "updated_at": "<string>",
  "email_enabled": true,
  "slack_enabled": false,
  "teams_enabled": false,
  "slack_webhook_url": "<string>",
  "teams_webhook_url": "<string>",
  "pagerduty_enabled": false,
  "digest_frequency": "daily",
  "min_severity_for_alert": "p2",
  "min_risk_score_for_alert": 70,
  "notify_on_new_issue": true,
  "notify_on_pattern_detected": true,
  "notify_on_prediction": true,
  "notify_on_recommendation": true,
  "notify_on_report_ready": true,
  "events": {
    "new_issue_ingested": {
      "email": true,
      "in_app": true,
      "slack": false
    },
    "issue_escalated_critical": {
      "email": true,
      "in_app": true,
      "slack": true
    },
    "pattern_detected": {
      "email": false,
      "in_app": true,
      "slack": false
    },
    "pattern_confirmed": {
      "email": false,
      "in_app": true,
      "slack": false
    },
    "new_prediction": {
      "email": false,
      "in_app": true,
      "slack": false
    },
    "high_confidence_prediction": {
      "email": true,
      "in_app": true,
      "slack": true
    },
    "recommendation_pushed": {
      "email": false,
      "in_app": true,
      "slack": false
    },
    "member_invited": {
      "email": true,
      "in_app": true,
      "slack": false
    },
    "weekly_digest": {
      "email": true,
      "in_app": false,
      "slack": false
    }
  },
  "quiet_hours": {
    "start": "<string>",
    "end": "<string>",
    "timezone": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

user_id
string
required
updated_at
string
required
email_enabled
boolean
default:true
slack_enabled
boolean
default:false
teams_enabled
boolean
default:false
slack_webhook_url
string | null
teams_webhook_url
string | null
pagerduty_enabled
boolean
default:false
digest_frequency
enum<string>
default:daily
Available options:
realtime,
daily,
weekly,
never
min_severity_for_alert
enum<string>
default:p2
Available options:
p1,
p2,
p3,
p4
min_risk_score_for_alert
integer
default:70
Required range: 0 <= x <= 100
notify_on_new_issue
boolean
default:true
notify_on_pattern_detected
boolean
default:true
notify_on_prediction
boolean
default:true
notify_on_recommendation
boolean
default:true
notify_on_report_ready
boolean
default:true
events
NotificationEvents · object
quiet_hours
QuietHours · object