NotificationPreferenceCreate

Fields

Create or replace a single channel preference.

8 fields

channel · required

NotificationChannel

email_override

string (email) or null

enabled

boolean

events

array of string

List of NotificationEventType values

failure_rate_threshold

number

project_id

string (uuid) or null

slack_webhook_url

string or null

teams_webhook_url

string or null

Raw schema (JSON)

{
  "description": "Create or replace a single channel preference.",
  "properties": {
    "channel": {
      "$ref": "#/components/schemas/NotificationChannel"
    },
    "email_override": {
      "anyOf": [
        {
          "format": "email",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Email Override"
    },
    "enabled": {
      "default": true,
      "title": "Enabled",
      "type": "boolean"
    },
    "events": {
      "description": "List of NotificationEventType values",
      "items": {
        "type": "string"
      },
      "title": "Events",
      "type": "array"
    },
    "failure_rate_threshold": {
      "default": 80,
      "maximum": 100,
      "minimum": 0,
      "title": "Failure Rate Threshold",
      "type": "number"
    },
    "project_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Project Id"
    },
    "slack_webhook_url": {
      "anyOf": [
        {
          "maxLength": 2000,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Slack Webhook Url"
    },
    "teams_webhook_url": {
      "anyOf": [
        {
          "maxLength": 2000,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Teams Webhook Url"
    }
  },
  "required": [
    "channel"
  ],
  "title": "NotificationPreferenceCreate",
  "type": "object"
}

Used by endpoints

2 endpoints send or return this schema, on its own or inside another schema.

• POST /api/v1/notifications/preferences — Upsert Preference
• PUT /api/v1/notifications/preferences/{pref_id} — Update Preference

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON