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

# Webhook delivery stats

> Retrieve a delivery rollup (success/fail counts, success rate, degraded flag) for every webhook endpoint in your organization. Defaults to the last 24 hours; accepts `from` and `to`.

Returns a per-endpoint delivery rollup for your organization. Use it to monitor 24-hour delivery health, current backlog, and why an endpoint is not currently receiving deliveries.

Each row includes `success_24h`, `fail_24h`, `success_rate`, and `degraded`, plus backlog and pause fields such as `pending_count`, `oldest_pending_at`, `circuit_broken_until`, `rate_limited_until`, `blocked_reason`, and `blocked_until`.

<Note>
  For recovery behavior and block reasons, see the [Webhooks guide: Endpoint Health](/guides/webhooks#endpoint-health).
</Note>


## OpenAPI

````yaml GET /v1/webhook-endpoints/delivery-stats
openapi: 3.0.3
info:
  contact:
    email: support@scrip.dev
    name: Scrip Support
  description: >-
    Scrip is the operating system for rewards programs. Use this REST API to
    define earn and redemption rules, issue and redeem assets, and track every
    movement in a double-entry ledger. Full guides and reference:
    https://docs.scrip.dev


    Core concepts:

    - **Programs**: Containers for incentive logic (e.g., "Q1 Sales Bonus",
    "Customer Loyalty")

    - **Assets**: The currency or points being tracked (e.g., "Bonus Points",
    "Cash Rewards")

    - **Participants**: Users who earn and spend assets (identified by
    external_id)

    - **Groups**: Collections of participants for team-based incentives

    - **Rules**: Automated reward logic triggered by events

    - **Events**: Actions that trigger rule evaluation (e.g., "purchase",
    "referral")


    Response formats:

    - **Collection endpoints** return: {"data": [...], "pagination":
    {"has_more": true, "next_cursor": "..."}}

    - **Single-resource endpoints** return the resource directly

    - **Errors** return: {"code": "...", "message": "...", "details": {...}} —
    `details` is an optional object, present on input errors only
  license:
    name: Proprietary
  termsOfService: https://scrip.dev/terms
  title: Scrip API
  version: '1.0'
servers:
  - url: https://api.scrip.dev
security: []
tags:
  - description: >-
      Manage incentive programs. Programs are the top-level container for all
      incentive logic.
    name: Programs
  - description: >-
      Manage asset types (currencies, points). Assets define what participants
      can earn and spend.
    name: Assets
  - description: >-
      Manage participants and their balances. Participants are identified by
      external_id from your system.
    name: Participants
  - description: Manage participant groups for team-based incentives.
    name: Groups
  - description: >-
      Manage automated reward rules. Rules define conditions and actions
      triggered by events.
    name: Rules
  - description: Ingest events that trigger rule evaluation and reward distribution.
    name: Events
  - description: Transfer assets between participants.
    name: Transfers
  - description: Access ledger summaries and program activity reports.
    name: Reporting
  - description: >-
      Redeem participant balances for rewards. Supports raw amount redemptions
      and catalog item redemptions.
    name: Redemptions
  - description: >-
      Manage the reward catalog. Create and manage redeemable items with
      inventory tracking.
    name: Rewards
  - description: >-
      Schedule and manage automated event dispatching. Automations generate
      events on cron schedules, at specific times, or by evaluating participant
      state.
    name: Automations
  - description: >-
      Manage tier types and levels within programs. Tiers define status
      hierarchies that participants progress through based on qualification
      rules.
    name: Tiers
  - description: Inspect double-entry ledger records for auditing and reconciliation.
    name: Journal Entries
  - description: >-
      Manage webhook endpoints and delivery logs. Webhooks notify your
      application of real-time events via HTTP POST with HMAC-SHA256 signatures.
    name: Webhooks
paths:
  /v1/webhook-endpoints/delivery-stats:
    get:
      tags:
        - Webhooks
      summary: Webhook delivery stats
      description: >-
        Retrieve a delivery rollup (success/fail counts, success rate, degraded
        flag) for every webhook endpoint in your organization. Defaults to the
        last 24 hours; accepts `from` and `to`.
      operationId: listWebhookEndpointDeliveryStats
      parameters:
        - description: 'Start date (RFC 3339, default: 24 hours ago)'
          in: query
          name: from
          schema:
            type: string
        - description: 'End date (RFC 3339, default: now)'
          in: query
          name: to
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/handlers.endpointDeliveryStatsListResponse
          description: Per-endpoint delivery rollup
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrUnauthorizedResponse'
          description: 'Missing or invalid credentials (code: unauthorized)'
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrForbiddenResponse'
          description: 'Insufficient permissions (code: forbidden)'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrInternalResponse'
          description: 'Internal server error (code: internal_error)'
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  schemas:
    handlers.endpointDeliveryStatsListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/handlers.endpointDeliveryStatsResponse'
          type: array
      type: object
    handlers.ErrUnauthorizedResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: unauthorized
          type: string
        details:
          allOf:
            - $ref: '#/components/schemas/handlers.ErrorDetails'
          description: Details provides optional structured error context
        message:
          description: Message is the human-readable error description
          example: Missing or invalid credentials
          type: string
      type: object
    handlers.ErrForbiddenResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: forbidden
          type: string
        details:
          allOf:
            - $ref: '#/components/schemas/handlers.ErrorDetails'
          description: Details provides optional structured error context
        message:
          description: Message is the human-readable error description
          example: Insufficient permissions for this action
          type: string
      type: object
    handlers.ErrInternalResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: internal_error
          type: string
        message:
          description: Message is the human-readable error description
          example: An internal error occurred
          type: string
      type: object
    handlers.endpointDeliveryStatsResponse:
      properties:
        blocked_reason:
          description: >-
            Why the endpoint is not currently receiving deliveries:
            endpoint_disabled,

            circuit_broken, or rate_limited. Omitted when the endpoint is
            deliverable.
          example: circuit_broken
          type: string
        blocked_until:
          description: >-
            When the block clears (omitted for indefinite blocks like
            endpoint_disabled)
          example: '2026-05-18T10:40:00Z'
          type: string
        circuit_broken_until:
          description: >-
            When set and in the future, the circuit breaker has paused this
            endpoint until this time
          example: '2026-05-18T10:40:00Z'
          type: string
        degraded:
          description: >-
            True when the window success rate is below the server-decided health
            threshold
          example: false
          type: boolean
        endpoint_id:
          description: The webhook endpoint this rollup is for
          example: 550e8400-e29b-41d4-a716-446655440000
          format: uuid
          type: string
        fail_24h:
          description: Deprecated compatibility alias for fail_count.
          example: 3
          type: integer
        fail_count:
          description: Deliveries that failed in the requested window
          example: 3
          type: integer
        last_attempt_at:
          description: >-
            When the endpoint was last attempted within the window (omitted if
            none)
          example: '2026-05-18T10:30:01Z'
          format: date-time
          type: string
        oldest_pending_at:
          description: >-
            created_at of the oldest queued delivery — the backlog age signal
            (omitted when empty)
          example: '2026-05-18T10:25:00Z'
          format: date-time
          type: string
        pending_count:
          description: >-
            Current backlog: deliveries queued (PENDING/SENDING) for this
            endpoint
          example: 0
          type: integer
        rate_limited_until:
          description: >-
            When set and in the future, 429 rate-limit backoff has paused this
            endpoint until this time
          example: '2026-05-18T10:35:00Z'
          type: string
        status:
          description: 'Endpoint lifecycle status: ACTIVE or DISABLED'
          example: ACTIVE
          type: string
        success_24h:
          description: Deprecated compatibility alias for success_count.
          example: 142
          type: integer
        success_count:
          description: Deliveries that succeeded in the requested window
          example: 142
          type: integer
        success_rate:
          description: >-
            Fraction of deliveries that succeeded (0..1); 1 when there were no
            deliveries
          example: 0.9793
          type: number
        url:
          description: Destination URL of the endpoint
          example: https://example.com/webhooks
          type: string
      type: object
    handlers.ErrorDetails:
      description: >-
        Optional structured details about the error. Always a JSON object: a
        `fields` array for validation errors, or flat
        field/reason/expected/received properties for other input errors.
      properties:
        expected:
          description: Expected value or format (non-validation input errors)
          example: uuid
          type: string
        field:
          description: Field name that caused the error (non-validation input errors)
          example: asset_id
          type: string
        fields:
          description: >-
            Fields lists each offending input field on validation_error
            responses.
          items:
            $ref: '#/components/schemas/handlers.ErrorFieldDetail'
          type: array
        reason:
          description: Machine-readable reason code (non-validation input errors)
          example: invalid
          type: string
        received:
          description: Value that was received (non-validation input errors)
          example: not-a-uuid
          type: string
      type: object
    handlers.ErrorFieldDetail:
      description: >-
        A single field-level error: which input field failed, why, and (where
        known) the expected and received values.
      properties:
        expected:
          description: >-
            Expected value or format. Usually a string; for "one of" constraints
            it

            is an array of the allowed values.
        field:
          description: Field name that caused the error
          example: amount
          type: string
        message:
          description: Human-readable explanation (validation errors only)
          example: This field is required
          type: string
        reason:
          description: Machine-readable reason code
          example: required
          type: string
        received:
          description: Value that was received
          example: '-10.00'
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: API key passed in the X-API-Key header.
      in: header
      name: X-API-Key
      type: apiKey
    BearerAuth:
      description: Bearer token passed in the Authorization header (e.g. "Bearer sk_...").
      in: header
      name: Authorization
      type: apiKey

````