DigestSubscriptionResponse

Fields

22 fields

channel · required

string

created_at · required

string (date-time)

delivery_count

integer

id · required

string (uuid)

is_active · required

boolean

is_paused · required

boolean

last_delivered_at

string (date-time) or null

name · required

string

next_delivery_at

string (date-time) or null

project_id

string (uuid) or null

report_attachment

boolean

saved_view_id

string (uuid) or null

saved_view_name

string or null

schedule · required

string

scope_label

string or null

scope_problem

string or null

scope_type

string or null

scope_value

string or null

send_when_unchanged

boolean

trigger_filter

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"
    },
    "delivery_count": {
      "default": 0,
      "title": "Delivery Count",
      "type": "integer"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "is_active": {
      "title": "Is Active",
      "type": "boolean"
    },
    "is_paused": {
      "title": "Is Paused",
      "type": "boolean"
    },
    "last_delivered_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Delivered At"
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "next_delivery_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Next Delivery At"
    },
    "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"
    },
    "saved_view_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Saved View Name"
    },
    "schedule": {
      "title": "Schedule",
      "type": "string"
    },
    "scope_label": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Scope Label"
    },
    "scope_problem": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Scope Problem"
    },
    "scope_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": "project",
      "title": "Scope Type"
    },
    "scope_value": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Scope Value"
    },
    "send_when_unchanged": {
      "default": true,
      "title": "Send When Unchanged",
      "type": "boolean"
    },
    "trigger_filter": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": "all",
      "title": "Trigger Filter"
    },
    "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",
    "name",
    "schedule",
    "channel",
    "is_active",
    "is_paused",
    "created_at"
  ],
  "title": "DigestSubscriptionResponse",
  "type": "object"
}

Used by endpoints

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

• GET /api/v1/digests/subscriptions — List Subscriptions
• POST /api/v1/digests/subscriptions — Create Subscription
• GET /api/v1/digests/subscriptions/{sub_id} — Get Subscription
• PATCH /api/v1/digests/subscriptions/{sub_id} — Update Subscription
• POST /api/v1/digests/subscriptions/{sub_id}/pause — Pause Subscription
• POST /api/v1/digests/subscriptions/{sub_id}/resume — Resume Subscription

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON