> ## Documentation Index
> Fetch the complete documentation index at: https://docs.closient.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Notification system health

> Aggregate health of the notification delivery pipeline. Reports a status verdict (``healthy`` / ``degraded`` / ``unhealthy``) computed from the trailing-hour failure rate, plus delivery counters for the last hour and unsubscribe counters for the last 24 hours. Used by uptime monitors and the internal ops dashboard.



## OpenAPI

````yaml /openapi/openapi-notifications.json get /notifications/api/v1/notifications/health
openapi: 3.1.0
info:
  title: Notifications API
  version: 1.0.0
  description: >
    Manage notification preferences and delivery.


    ## Authentication


    All endpoints require an API key passed via the `X-API-Key` HTTP header,
    unless otherwise noted.


    ```

    X-API-Key: csb_<body>_<checksum>

    ```


    Generate API keys in **Settings > API Keys** in your dashboard, or via the
    Account API.

    Session-based (cookie) authentication is also accepted for browser-based
    access.


    ## Rate Limits


    | Tier        | Requests / minute | Requests / day |

    |-------------|-------------------|----------------|

    | Default     | 300               | 10,000         |

    | Custom      | Contact us        | Contact us     |


    Those windows are per key. Your plan also caps each organization per hour,
    across every key,

    login and session acting for it: 100 requests on Free (or while a
    subscription is lapsed),

    10,000 on Business. While a subscription is lapsed, any method other than
    `GET`, `HEAD` and

    `OPTIONS` returns `403`.


    Rate-limit headers are included on every response so callers can
    self-throttle without

    hitting our 429s ("informed governor"):


    - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400`

    - `RateLimit-Limit` — quota for the **most-restrictive** currently-active
    window

    - `RateLimit-Remaining` — requests left in that window

    - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew
    safe)


    Legacy `X-RateLimit-*` aliases are also emitted for back-compat.
    `X-RateLimit-Reset`

    keeps the absolute Unix-timestamp shape to avoid breaking existing
    consumers.


    When rate-limited, you receive `429 Too Many Requests` with a
    `retry_after_seconds` field

    in the error envelope and a `Retry-After` header.


    ## Pagination


    List endpoints return paginated results in this envelope:


    ```json

    {
      "data": [...],
      "pagination": {
        "page": 1,
        "page_size": 25,
        "total_count": 342,
        "total_pages": 14,
        "has_next": true,
        "has_previous": false
      }
    }

    ```


    Use `?page=2&page_size=50` query parameters. Maximum page size is 100.


    ## Error Responses


    All errors conform to [RFC 9457 Problem
    Details](https://www.rfc-editor.org/rfc/rfc9457)

    with `Content-Type: application/problem+json`:


    ```json

    {
      "type": "https://closient.com/docs/errors/not_found",
      "title": "Not Found",
      "status": 404,
      "detail": "The requested resource was not found.",
      "error_code": "not_found",
      "retryable": false,
      "timestamp": "2026-03-31T12:00:00+00:00"
    }

    ```


    Common error codes: `unauthorized` (401), `forbidden` (403), `not_found`
    (404),

    `validation_error` (422), `rate_limited` (429), `internal_error` (500).
  termsOfService: https://www.closient.com/terms/
servers:
  - url: https://www.closient.com
security: []
tags:
  - name: Notifications
    description: Manage notification preferences and delivery.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /notifications/api/v1/notifications/health:
    get:
      tags:
        - Notifications
      summary: Notification system health
      description: >-
        Aggregate health of the notification delivery pipeline. Reports a status
        verdict (``healthy`` / ``degraded`` / ``unhealthy``) computed from the
        trailing-hour failure rate, plus delivery counters for the last hour and
        unsubscribe counters for the last 24 hours. Used by uptime monitors and
        the internal ops dashboard.
      operationId: notification_health
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthSchema'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '405':
          description: Method Not Allowed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '429':
          description: Too Many Requests
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
      security:
        - APIKeyHeaderAuth: []
        - OAuthTokenAuth: []
        - CookieGatedSessionAuth: []
components:
  schemas:
    HealthSchema:
      description: |-
        Aggregate health snapshot of the notification delivery pipeline.

        Returned by ``GET /health``. Used by uptime monitors and the internal
        ops dashboard to decide whether the pipeline is keeping up with its
        queue. The two time-window buckets are dynamic-shape JSON because the
        underlying monitor returns different metrics per window:

        * ``last_hour`` — keys ``deliveries`` (per-status counts) and
          ``performance`` (failure rate, throughput).
        * ``last_24h`` — keys ``unsubscribes`` (counts by source).
      examples:
        - last_24h:
            failed: 3
            pending: 0
            sent: 1024
          last_hour:
            failed: 0
            pending: 2
            sent: 45
          status: healthy
      properties:
        status:
          $ref: '#/components/schemas/HealthStatusEnum'
          description: Aggregate health verdict. Computed from trailing-hour failure rate.
        last_hour:
          additionalProperties: true
          description: >-
            Delivery counters for the trailing 1-hour window. Keys:
            ``deliveries`` (counts by status), ``performance`` (failure rate,
            throughput).
          title: Last Hour
          type: object
        last_24h:
          additionalProperties: true
          description: >-
            Activity counters for the trailing 24-hour window. Keys:
            ``unsubscribes`` (counts by source).
          title: Last 24H
          type: object
      required:
        - status
        - last_hour
        - last_24h
      title: HealthSchema
      type: object
    ErrorOut:
      description: |-
        RFC 9457 Problem Details response.

        All API errors are returned in this format with Content-Type:
        application/problem+json.
      examples:
        - detail: The requested resource was not found.
          error_code: not_found
          retryable: false
          status: 404
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Not Found
          type: https://closient.com/docs/errors/not_found
        - detail: Validation error.
          details:
            - loc:
                - body
                - name
              msg: Field required
              type: missing
          error_code: validation_error
          retryable: false
          status: 422
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Validation Error
          type: https://closient.com/docs/errors/validation_error
        - detail: Rate limit exceeded. Please try again later.
          error_code: rate_limited
          retry_after: 31
          retryable: true
          status: 429
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Rate Limited
          type: https://closient.com/docs/errors/rate_limited
      properties:
        type:
          description: URI reference identifying the error type.
          title: Type
          type: string
        title:
          description: Short human-readable summary of the error.
          title: Title
          type: string
        status:
          description: HTTP status code.
          title: Status
          type: integer
        detail:
          description: Human-readable explanation of this specific occurrence.
          title: Detail
          type: string
        error_code:
          description: Machine-readable error code (e.g. not_found, unauthorized).
          title: Error Code
          type: string
        retryable:
          default: false
          description: Whether retrying the same request can succeed.
          title: Retryable
          type: boolean
        timestamp:
          description: ISO 8601 timestamp of when the error occurred.
          title: Timestamp
          type: string
        retry_after:
          anyOf:
            - type: integer
            - type: 'null'
          description: Seconds to wait before retrying (when applicable).
          title: Retry After
        owner_action_required:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Whether the error requires account owner intervention.
          title: Owner Action Required
        details:
          description: Additional context (validation errors, etc.).
          title: Details
      required:
        - type
        - title
        - status
        - detail
        - error_code
        - timestamp
      title: ErrorOut
      type: object
    HealthStatusEnum:
      description: |-
        Aggregate health state of the notification delivery pipeline.

        Computed from the trailing-hour failure rate:
        ``healthy`` (<=10% failure), ``degraded`` (>10%), ``unhealthy`` (>50%).
      enum:
        - healthy
        - degraded
        - unhealthy
      title: HealthStatusEnum
      type: string
  securitySchemes:
    APIKeyHeaderAuth:
      type: apiKey
      in: header
      name: X-API-Key
    OAuthTokenAuth:
      type: http
      scheme: bearer
    CookieGatedSessionAuth:
      type: apiKey
      in: cookie
      name: sessionid

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.