Notification Settings

Control how notifications are delivered — in-app (toast) and by email — for each category. All routes are mounted under /v1/notification-settings and require an authenticated session.

Get Settings

GET /v1/notification-settings

Response:

{
  "email": "you@example.com",
  "toast_enabled": true,
  "categories": [
    {
      "category": "deployment",
      "label": "Deployments",
      "description": "Updates about your deployments",
      "in_app_enabled": true,
      "email_enabled": true
    }
  ]
}
FieldDescription
emailThe address email notifications are sent to
toast_enabledWhether in-app toast notifications are shown
categories[]Per-category preferences: category, label, description, in_app_enabled, email_enabled

Update Settings

PUT /v1/notification-settings

Request body:

{
  "toast_enabled": true,
  "categories": [
    {
      "category": "deployment",
      "in_app_enabled": true,
      "email_enabled": false
    }
  ]
}

Returns the updated settings (same shape as Get Settings).

Send Test Email

POST /v1/notification-settings/test-email

Sends a test email to the account address to verify email delivery. Returns the delivery status:

{ "status": "sent", "error": null }

Email delivery requires the SMTP environment variables to be configured — see Environment Variables.