DigestSubscriptionCreate

Fields

10 fields

channel

string

name · required

string

project_id

string (uuid) or null

report_attachment

boolean

saved_view_id

string (uuid) or null

schedule

string

scope_type

string or null

scope_value

string or null

send_when_unchanged

boolean

trigger_filter

string or null

Raw schema (JSON)

{
  "properties": {
    "channel": {
      "default": "email",
      "pattern": "^(email|slack|teams)$",
      "title": "Channel",
      "type": "string"
    },
    "name": {
      "maxLength": 255,
      "minLength": 2,
      "title": "Name",
      "type": "string"
    },
    "project_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Project Id"
    },
    "report_attachment": {
      "default": false,
      "title": "Report Attachment",
      "type": "boolean"
    },
    "saved_view_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Saved View Id"
    },
    "schedule": {
      "default": "WEEKLY",
      "pattern": "^(DAILY|WEEKLY|WEEKLY_RETRO|PER_RUN|PER_RELEASE|PER_SUITE)$",
      "title": "Schedule",
      "type": "string"
    },
    "scope_type": {
      "anyOf": [
        {
          "pattern": "^(project|release|suite|global)$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": "project",
      "title": "Scope Type"
    },
    "scope_value": {
      "anyOf": [
        {
          "maxLength": 255,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Scope Value"
    },
    "send_when_unchanged": {
      "default": true,
      "title": "Send When Unchanged",
      "type": "boolean"
    },
    "trigger_filter": {
      "anyOf": [
        {
          "pattern": "^(all|failed_only|degraded_only)$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": "all",
      "title": "Trigger Filter"
    }
  },
  "required": [
    "name"
  ],
  "title": "DigestSubscriptionCreate",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• POST /api/v1/digests/subscriptions — Create Subscription

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON