Clarity Notifications V2 Admin API

openapi: 3.2.0
info:
  title: Fast Notifications V2 Admin API
  version: 0.1.0
tags:
- name: notifications_v2_admin
paths:
  /api/admin/v2/notifications/{notification_id}/trigger:
    post:
      tags:
      - notifications_v2_admin
      summary: Trigger Notification
      description: 'Generate and save a report for a notification.


        Called by EB proxy Lambda on schedule, and by /test endpoint via Lambda.invoke.

        Returns report_id + destinations for SQS enqueue.'
      operationId: trigger_notification_api_admin_v2_notifications__notification_id__trigger_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/TriggerResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/v2/notifications/{notification_id}/reports/{report_id}:
    get:
      tags:
      - notifications_v2_admin
      summary: Get Report Content
      description: 'Get report content for delivery.


        Called by Sending Lambda to fetch content + destinations before sending.'
      operationId: get_report_content_api_admin_v2_notifications__notification_id__reports__report_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: notification_id
        in: path
        required: true
        schema:
          type: integer
          title: Notification Id
      - name: report_id
        in: path
        required: true
        schema:
          type: integer
          title: Report Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportContentResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/v2/notifications/reports/{report_id}/send:
    post:
      tags:
      - notifications_v2_admin
      summary: Send Report
      description: 'Send a generated report to its configured destinations.


        Called by Lambda after trigger. Delegates orchestration to DeliveryService.'
      operationId: send_report_api_admin_v2_notifications_reports__report_id__send_post
      security:
      - HTTPBearer: []
      parameters:
      - name: report_id
        in: path
        required: true
        schema:
          type: integer
          title: Report Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/v2/notifications/reports/reconcile:
    post:
      tags:
      - notifications_v2_admin
      summary: Reconcile Reports
      description: 'Check delivery completeness and set final status for stale reports.


        Called by Reconciler Lambda every 5 minutes.'
      operationId: reconcile_reports_api_admin_v2_notifications_reports_reconcile_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
components:
  schemas:
    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
    TriggerResponse:
      properties:
        report_id:
          type: integer
          title: Report Id
        destinations:
          additionalProperties: true
          type: object
          title: Destinations
      type: object
      required:
      - report_id
      - destinations
      title: TriggerResponse
      description: Response from POST /admin/{id}/trigger.
    ReportStatus:
      type: string
      enum:
      - pending
      - generated
      - success
      - failed
      - skipped
      title: ReportStatus
    ReportContentResponse:
      properties:
        report_id:
          type: integer
          title: Report Id
        notification_id:
          type: integer
          title: Notification Id
        status:
          $ref: '#/components/schemas/ReportStatus'
        content:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Content
        destinations:
          additionalProperties: true
          type: object
          title: Destinations
        project_id:
          type: integer
          title: Project Id
      type: object
      required:
      - report_id
      - notification_id
      - status
      - destinations
      - project_id
      title: ReportContentResponse
      description: Response from GET /admin/{id}/reports/{rid}. Used by Sending Lambda.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    HTTPBasic:
      type: http
      scheme: basic