NotificationPreferenceResponse

Fields

12 fields

channel · required

string

created_at · required

string (date-time)

email_override · required

string or null

enabled · required

boolean

events · required

array of string

failure_rate_threshold · required

number or null

id · required

string (uuid)

project_id · required

string (uuid) or null

slack_webhook_url · required

string or null

teams_webhook_url · required

string or null

updated_at

string (date-time) or null

user_id · required

string (uuid)

Raw schema (JSON)

{
  "properties": {
    "channel": {
      "title": "Channel",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "email_override": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Email Override"
    },
    "enabled": {
      "title": "Enabled",
      "type": "boolean"
    },
    "events": {
      "items": {
        "type": "string"
      },
      "title": "Events",
      "type": "array"
    },
    "failure_rate_threshold": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Failure Rate Threshold"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "project_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Project Id"
    },
    "slack_webhook_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Slack Webhook Url"
    },
    "teams_webhook_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Teams Webhook Url"
    },
    "updated_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated At"
    },
    "user_id": {
      "format": "uuid",
      "title": "User Id",
      "type": "string"
    }
  },
  "required": [
    "id",
    "user_id",
    "project_id",
    "channel",
    "enabled",
    "events",
    "failure_rate_threshold",
    "email_override",
    "slack_webhook_url",
    "teams_webhook_url",
    "created_at"
  ],
  "title": "NotificationPreferenceResponse",
  "type": "object"
}

Used by endpoints

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

• GET /api/v1/notifications/preferences — List Preferences
• 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