Clarity Notifications V2 API

openapi: 3.2.0
info:
  title: Fast Notifications V2 API
  version: 0.1.0
tags:
- name: notifications_v2
paths:
  /api/v2/notifications:
    get:
      tags:
      - notifications_v2
      summary: List Notifications
      description: 'List all notifications for the current project.


        Returns:

        List of notification objects with computed schedule descriptions.'
      operationId: list_notifications_api_v2_notifications_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/NotificationResponse'
                type: array
                title: Response List Notifications Api V2 Notifications Get
      security:
      - HTTPBearer: []
    post:
      tags:
      - notifications_v2
      summary: Create Notification
      description: 'Create a new notification with an EventBridge schedule.


        Args:

        body: Notification configuration including schedule, destinations, and payload.


        Returns:

        Created notification object.


        Raises:

        HTTPException: 502 if EventBridge schedule creation fails.

        HTTPException: 500 if database persist fails after schedule creation.'
      operationId: create_notification_api_v2_notifications_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNotificationRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v2/notifications/{notification_id}:
    put:
      tags:
      - notifications_v2
      summary: Update Notification
      description: 'Update an existing notification. All fields are optional.


        Args:

        notification_id: ID of the notification to update.

        body: Fields to update (only non-null fields are applied).


        Returns:

        Updated notification object.


        Raises:

        HTTPException: 404 if notification not found.

        HTTPException: 502 if EventBridge schedule update fails.'
      operationId: update_notification_api_v2_notifications__notification_id__put
      security:
      - HTTPBearer: []
      parameters:
      - name: notification_id
        in: path
        required: true
        schema:
          type: integer
          title: Notification Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/src__notifications_v2__schemas__notification__UpdateNotificationRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - notifications_v2
      summary: Delete Notification
      description: 'Delete a notification and its EventBridge schedule.


        Args:

        notification_id: ID of the notification to delete.


        Raises:

        HTTPException: 404 if notification not found.

        HTTPException: 502 if EventBridge schedule deletion fails.'
      operationId: delete_notification_api_v2_notifications__notification_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: notification_id
        in: path
        required: true
        schema:
          type: integer
          title: Notification Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v2/notifications/preview:
    post:
      tags:
      - notifications_v2
      summary: Preview Report
      description: 'Generate a report preview without saving or sending.


        Results are cached in DynamoDB by (project_id, payload, notification_name).

        Cache TTL: 10 minutes.'
      operationId: preview_report_api_v2_notifications_preview_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v2/notifications/{notification_id}/reports:
    get:
      tags:
      - notifications_v2
      summary: List Reports
      description: List delivery reports for a notification.
      operationId: list_reports_api_v2_notifications__notification_id__reports_get
      security:
      - HTTPBearer: []
      parameters:
      - name: notification_id
        in: path
        required: true
        schema:
          type: integer
          title: Notification Id
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 10
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v2/notifications/{notification_id}/test:
    post:
      tags:
      - notifications_v2
      summary: Test Notification
      description: Test-send a notification by invoking the same Trigger Lambda that EventBridge calls.
      operationId: test_notification_api_v2_notifications__notification_id__test_post
      security:
      - HTTPBearer: []
      parameters:
      - name: notification_id
        in: path
        required: true
        schema:
          type: integer
          title: Notification Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v2/notifications/send-preview:
    post:
      tags:
      - notifications_v2
      summary: Send Preview
      description: 'Send preview content directly to a single channel (slack or email).


        No report is created — this is a fire-and-forget send from the UI preview panel.'
      operationId: send_preview_api_v2_notifications_send_preview_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendPreviewRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
components:
  schemas:
    NotificationResponse:
      properties:
        id:
          type: integer
          title: Id
        project_id:
          type: integer
          title: Project Id
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        destinations:
          $ref: '#/components/schemas/src__notifications_v2__services__dto__destinations__Destinations'
        schedule_expression:
          type: string
          title: Schedule Expression
        schedule_timezone:
          type: string
          title: Schedule Timezone
        schedule_arn:
          anyOf:
          - type: string
          - type: 'null'
          title: Schedule Arn
        schedule_description:
          type: string
          title: Schedule Description
          description: Human-readable schedule description
          default: ''
        is_enabled:
          type: boolean
          title: Is Enabled
        created_by:
          type: integer
          title: Created By
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        payload:
          $ref: '#/components/schemas/PayloadConfig'
        last_run_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Run At
          description: Started_at of the most recent successful report run
        last_tickets_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Last Tickets Count
          description: tickets_count of the most recent successful report run
      type: object
      required:
      - id
      - project_id
      - destinations
      - schedule_expression
      - schedule_timezone
      - is_enabled
      - created_by
      - created_at
      - updated_at
      - payload
      title: NotificationResponse
      description: Response schema for a notification.
    src__notifications_v2__services__dto__destinations__SlackDestination:
      properties:
        channel_id:
          type: string
          minLength: 1
          title: Channel Id
          description: Slack channel ID
        channel_name:
          type: string
          minLength: 1
          title: Channel Name
          description: Slack channel display name
      type: object
      required:
      - channel_id
      - channel_name
      title: SlackDestination
      description: Slack delivery channel.
    EmailDestination:
      properties:
        addresses:
          items:
            type: string
            format: email
          type: array
          minItems: 1
          title: Addresses
          description: Recipient email addresses
      type: object
      required:
      - addresses
      title: EmailDestination
      description: Email delivery channel.
    PayloadConfig:
      properties:
        report_type:
          type: string
          enum:
          - feedback_search
          - agent_usage_digest
          title: Report Type
          description: Which generator produces this notification's report
          default: feedback_search
        search_query:
          anyOf:
          - type: string
          - type: 'null'
          title: Search Query
          description: Search query or topic
        filters:
          items:
            $ref: '#/components/schemas/QueryFilter'
          type: array
          title: Filters
          description: Elasticsearch filters
        is_deep_search:
          type: boolean
          title: Is Deep Search
          description: Use deeper search agent
          default: false
        include_summary:
          type: boolean
          title: Include Summary
          description: Generate AI summary
          default: true
        include_feed:
          type: boolean
          title: Include Feed
          description: Include individual feedback items
          default: true
        send_empty:
          type: boolean
          title: Send Empty
          description: Deliver the report even when zero tickets matched; when False, mark as skipped
          default: true
        summary_slack_split:
          type: boolean
          title: Summary Slack Split
          description: Split summary into multiple Slack messages via LLM
          default: false
        horizon_days:
          anyOf:
          - type: integer
            maximum: 365.0
            minimum: 1.0
          - type: 'null'
          title: Horizon Days
          description: Lookback window in days
        custom_prompt_begin:
          anyOf:
          - type: string
          - type: 'null'
          title: Custom Prompt Begin
          description: Prepended to summarization prompt
        custom_prompt_end:
          anyOf:
          - type: string
          - type: 'null'
          title: Custom Prompt End
          description: Appended to summarization prompt
        additional_fields:
          items:
            type: string
          type: array
          title: Additional Fields
          description: Extra metadata fields
      type: object
      title: PayloadConfig
      description: Report payload configuration for a notification.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SendPreviewRequest:
      properties:
        channel:
          type: string
          enum:
          - slack
          - email
          title: Channel
          description: Delivery channel
        slack_blocks:
          anyOf:
          - items:
              additionalProperties: true
              type: object
            type: array
          - type: 'null'
          title: Slack Blocks
        slack_messages:
          anyOf:
          - items:
              items:
                additionalProperties: true
                type: object
              type: array
            type: array
          - type: 'null'
          title: Slack Messages
        email_html:
          anyOf:
          - type: string
          - type: 'null'
          title: Email Html
        email_subject:
          anyOf:
          - type: string
          - type: 'null'
          title: Email Subject
        email_addresses:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Email Addresses
        slack_channel_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Slack Channel Id
      type: object
      required:
      - channel
      title: SendPreviewRequest
      description: Request for POST /send-preview. Send to either slack or email, not both.
    ReportListResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ReportDetailResponse'
          type: array
          title: Items
        total:
          type: integer
          title: Total
      type: object
      required:
      - items
      - total
      title: ReportListResponse
      description: Response from GET /{id}/reports.
    PreviewRequest:
      properties:
        payload:
          $ref: '#/components/schemas/PayloadConfig'
        notification_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Notification Name
      type: object
      required:
      - payload
      title: PreviewRequest
      description: Request for POST /preview.
    CreateNotificationRequest:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Human-readable notification name
        schedule_expression:
          type: string
          title: Schedule Expression
          description: EventBridge cron() or rate() expression
        schedule_timezone:
          type: string
          title: Schedule Timezone
          description: IANA timezone string
        destinations:
          $ref: '#/components/schemas/src__notifications_v2__services__dto__destinations__Destinations'
        payload:
          $ref: '#/components/schemas/PayloadConfig'
        is_enabled:
          type: boolean
          title: Is Enabled
          default: true
      type: object
      required:
      - schedule_expression
      - schedule_timezone
      - destinations
      - payload
      title: CreateNotificationRequest
      description: Request schema for creating a notification.
    ReportStatus:
      type: string
      enum:
      - pending
      - generated
      - success
      - failed
      - skipped
      title: ReportStatus
    TestResponse:
      properties:
        status:
          type: string
          title: Status
          default: accepted
      type: object
      title: TestResponse
      description: Response from POST /{id}/test.
    src__notifications_v2__services__dto__destinations__Destinations:
      properties:
        email:
          anyOf:
          - $ref: '#/components/schemas/EmailDestination'
          - type: 'null'
        slack:
          anyOf:
          - $ref: '#/components/schemas/src__notifications_v2__services__dto__destinations__SlackDestination'
          - type: 'null'
      type: object
      title: Destinations
      description: Delivery destinations — at least one of email or slack must be present.
    ReportDetailResponse:
      properties:
        id:
          type: integer
          title: Id
        notification_id:
          type: integer
          title: Notification Id
        status:
          $ref: '#/components/schemas/ReportStatus'
        destination:
          additionalProperties: true
          type: object
          title: Destination
        delivery:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Delivery
        error_message:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Message
        started_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Started At
        completed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Completed At
        created_at:
          type: string
          format: date-time
          title: Created At
        content:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Content
      type: object
      required:
      - id
      - notification_id
      - status
      - destination
      - created_at
      title: ReportDetailResponse
      description: List item plus the generated content payload — for the UI detail view.
    src__notifications_v2__schemas__notification__UpdateNotificationRequest:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        schedule_expression:
          anyOf:
          - type: string
          - type: 'null'
          title: Schedule Expression
        schedule_timezone:
          anyOf:
          - type: string
          - type: 'null'
          title: Schedule Timezone
        destinations:
          anyOf:
          - $ref: '#/components/schemas/src__notifications_v2__services__dto__destinations__Destinations'
          - type: 'null'
        payload:
          anyOf:
          - $ref: '#/components/schemas/PayloadConfig'
          - type: 'null'
        is_enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Enabled
      type: object
      title: UpdateNotificationRequest
      description: Request schema for updating a notification. All fields optional.
    QueryFilter:
      properties:
        type:
          anyOf:
          - type: string
            const: exists
          - type: string
            const: list
          - type: string
            const: nested
          - type: string
            const: range
          - type: string
            const: text
          title: Type
        key:
          type: string
          title: Key
        values:
          anyOf:
          - items:
              type: string
            type: array
          - items:
              type: integer
            type: array
          - items:
              additionalProperties: true
              type: object
            type: array
          - type: string
          - type: 'null'
          title: Values
        min:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: 'null'
          title: Min
        max:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: 'null'
          title: Max
        operator:
          anyOf:
          - type: string
            const: eq
          - type: string
            const: neq
          - type: string
            const: contains
          title: Operator
          default: eq
        generated:
          type: boolean
          title: Generated
          default: false
      type: object
      required:
      - type
      - key
      title: QueryFilter
    PreviewResponse:
      properties:
        slack_blocks:
          anyOf:
          - items:
              additionalProperties: true
              type: object
            type: array
          - type: 'null'
          title: Slack Blocks
        slack_messages:
          anyOf:
          - items:
              items:
                additionalProperties: true
                type: object
              type: array
            type: array
          - type: 'null'
          title: Slack Messages
        email_html:
          anyOf:
          - type: string
          - type: 'null'
          title: Email Html
        email_subject:
          anyOf:
          - type: string
          - type: 'null'
          title: Email Subject
        tickets_count:
          type: integer
          title: Tickets Count
          default: 0
        summary:
          anyOf:
          - type: string
          - type: 'null'
          title: Summary
      type: object
      title: PreviewResponse
      description: Response from POST /preview.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    HTTPBasic:
      type: http
      scheme: basic