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

# Endpoints with failed delivery attempts

> The account's endpoints with failed attempts in the window,
most failures first — the "which webhook is down" view.
`terminal_failures` counts attempts that exhausted their retry
budget; the rest were retried.




## OpenAPI

````yaml /api-reference/specs/notifications.yaml get /v1/delivery-statistics/failing-endpoints
openapi: 3.0.3
info:
  title: Basaltic Notifications API
  version: 1.0.0
  description: |
    Publish/subscribe notification topics with email and webhook delivery.

    A topic is a fan-out root. Subscriptions bind it to endpoints;
    publishing to the topic delivers to every confirmed subscription
    whose filter policy matches the message.

    **Publishing is asynchronous.** Publish returns 202 as soon as the
    notification is durable and queued: no delivery has happened yet.
    Fan-out into per-subscription deliveries runs on a worker, so
    publish latency does not grow with subscriber count. Poll
    `GET /v1/messages/{message_id}` for the fan-out state and
    `GET /v1/deliveries?message_id=...` for per-endpoint outcomes.

    **Subscriptions must be confirmed.** Subscribe creates the
    subscription in `pending_confirmation` and sends a token to the
    endpoint — a link for email, a `subscription_confirmation` POST for
    webhooks. Nothing is delivered until the endpoint owner presents
    that token back. The confirmation window is 72 hours; unconfirmed
    subscriptions are reclaimed after it. If the handshake never
    arrived, `POST /v1/subscriptions/{id}/resend-confirmation` mints a
    fresh one — the original token is not recoverable, only its hash is
    stored.

    **Webhook endpoints must be publicly routable.** Endpoints resolving
    to loopback, RFC1918, link-local, or unique-local addresses are
    refused at subscribe time and again at delivery time.

    **Webhook deliveries are signed.** Each POST carries
    `X-Basaltic-Signature: v1,t=<unix-seconds>,s=<hex>`, an HMAC-SHA256
    over `"<t>.<raw-request-body>"` keyed by the subscription's signing
    secret. The secret is returned once by Subscribe and is readable
    afterwards via the signing-secret endpoint. Verify by recomputing
    the MAC over the raw body you received — not a re-serialised copy —
    and reject timestamps more than five minutes from now.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://notifications.{region}.basaltic.sh
    description: Regional API endpoint
    variables:
      region:
        default: sa-saopaulo-1
        description: Region code
security:
  - SignatureAuth: []
tags:
  - name: Topics
    description: Fan-out topics
  - name: Subscriptions
    description: Endpoint subscriptions and their confirmation handshake
  - name: Messages
    description: Publishing and delivery status
  - name: Confirmations
    description: Unauthenticated endpoint-owner actions
paths:
  /v1/delivery-statistics/failing-endpoints:
    get:
      tags:
        - Messages
      summary: Endpoints with failed delivery attempts
      description: |
        The account's endpoints with failed attempts in the window,
        most failures first — the "which webhook is down" view.
        `terminal_failures` counts attempts that exhausted their retry
        budget; the rest were retried.
      operationId: listFailingEndpoints
      parameters:
        - name: window
          in: query
          description: Look-back window as a Go duration. Capped at 2160h (90 days).
          schema:
            type: string
            default: 24h
            example: 6h
        - name: limit
          in: query
          schema:
            type: integer
            default: 20
            minimum: 1
            maximum: 100
            example: 20
      responses:
        '200':
          description: Failing endpoints, most failed attempts first.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailingEndpointsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    FailingEndpointsResponse:
      type: object
      required:
        - window_seconds
        - failing_endpoints
      properties:
        window_seconds:
          type: integer
          example: 86400
        failing_endpoints:
          type: array
          items:
            $ref: '#/components/schemas/FailingEndpoint'
    FailingEndpoint:
      type: object
      required:
        - subscription_id
        - topic_id
        - protocol
        - endpoint
        - failed_attempts
        - terminal_failures
        - last_error
        - last_status_code
        - last_failure_at
      properties:
        subscription_id:
          type: string
          format: uuid
          example: b2c3d4e5-6f7a-4b8c-9d0e-1f2a3b4c5d6e
        topic_id:
          type: string
          format: uuid
          example: 019400aa-bbbb-7ccc-8ddd-eeeeffff0000
        protocol:
          type: string
          enum:
            - email
            - https
            - http
            - queue
          example: https
        endpoint:
          type: string
          example: https://hooks.example.com/basaltic
        failed_attempts:
          type: integer
          description: Failed attempts in the window, retries included.
          example: 34
        terminal_failures:
          type: integer
          description: Attempts that exhausted their retry budget.
          example: 5
        last_error:
          type: string
          example: 'connect: connection refused'
        last_status_code:
          type: integer
          description: HTTP status of the most recent failure; 0 when none.
          example: 503
        last_failure_at:
          type: string
          format: date-time
          example: '2026-08-04T11:20:04Z'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Error code identifying the type of error
              example: INVALID_INPUT
            message:
              type: string
              description: Human-readable error message
              example: Invalid request parameters
            request_id:
              type: string
              format: uuid
              description: Request ID for debugging
              example: 550e8400-e29b-41d4-a716-446655440000
  responses:
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_INPUT
              message: Invalid request parameters
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Unauthorized:
      description: Authentication required or token invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    SignatureAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >
        Request signing with an access key issued to a service account. An

        HMAC-SHA256 over a canonical form of the request, close to AWS SigV4.

        The `basaltic` CLI signs for you.


        Send `Authorization`, `X-Date` (UTC, `YYYYMMDDTHHMMSSZ`) and `X-Nonce`

        (random per request); add `X-Content-Sha256` to bind a body, and

        `X-Amz-Security-Token` when using temporary credentials.


        ```

        Authorization: BASALTIC-HMAC-SHA256
        Credential=<access_key_id>/<date>/<region>/basaltic/basaltic_request,
        SignedHeaders=host;x-date;x-nonce, Signature=<hex>

        ```


        `<region>` is the region code you are calling, or `global` for the
        global

        services. A signature is valid for 5 minutes from `X-Date`, and mutating

        requests are replay-guarded on the nonce.


        **Full signing procedure, including a working implementation:**

        https://docs.basaltic.sh/authentication


        ## Rate limits

        There is no global request budget. A limit applies only where an

        operation documents a `429`, and that operation says what it counts.

        Those responses carry `X-RateLimit-Limit`, `X-RateLimit-Remaining`,

        `X-RateLimit-Reset` and, on a `429`, `Retry-After` — read them rather

        than hard-coding a number. Retrying before `Retry-After` is refused and

        extends the window. Everything else is bounded by quota, not by request

        rate.

````