openapi: 3.2.0
info:
  title: Hookbase Delivery Clusters API
  version: 1.0.0
  description: Official OpenAPI 3.0 specification for the Hookbase webhook relay platform. Generated from the maintained Postman collection. Authenticate with an API key (whr_ prefix) as a Bearer token.
  contact:
    name: Hookbase
    url: https://www.hookbase.app
servers:
- url: https://api.hookbase.app
  description: Production
security:
- bearerAuth: []
tags:
- name: Delivery Clusters
paths:
  /api/delivery-clusters:
    get:
      tags:
      - Delivery Clusters
      summary: List delivery clusters
      operationId: delivery_clusters_list_delivery_clusters
      parameters:
      - name: sinceHours
        in: query
        required: false
        schema:
          type: string
        example: '24'
      - name: limit
        in: query
        required: false
        schema:
          type: string
        example: '50'
      responses:
        '200':
          description: Successful response
      description: List failed deliveries grouped by failure fingerprint over a look-back window.
  /api/delivery-clusters/{clusterFingerprint}/events:
    get:
      tags:
      - Delivery Clusters
      summary: List cluster events
      operationId: delivery_clusters_list_cluster_events
      parameters:
      - name: clusterFingerprint
        in: path
        required: true
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: string
        example: '500'
      responses:
        '200':
          description: Successful response
      description: List the events whose deliveries belong to a failure cluster.
  /api/delivery-clusters/{clusterFingerprint}/replay-all:
    post:
      tags:
      - Delivery Clusters
      summary: Replay all in cluster
      operationId: delivery_clusters_replay_all_in_cluster
      parameters:
      - name: clusterFingerprint
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Replay every failed delivery in a cluster in one call, with optional overrides.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                destinationOverride:
                  type: string
                  description: Optional. Send the replay(s) to a different destination id instead of the original.
                transformOverride:
                  type: object
                  description: 'Optional. One-off transform applied to this replay only. { code (<=64KB), type?: jsonata|xslt|liquid|javascript, inputFormat?, outputFormat? }.'
                headersOverride:
                  type: object
                  description: Optional. Extra request headers for the replay (max 50).
                persistTransform:
                  type: boolean
                  description: Optional. Persist transformOverride onto the route (requires transformOverride).
                limit:
                  type: integer
                  description: Optional. Cap the number of deliveries replayed (cluster default 500, max 2000).
            example:
              destinationOverride: '{{destinationId}}'
              transformOverride:
                code: $
                type: jsonata
                inputFormat: json
                outputFormat: json
              headersOverride:
                X-Replay: 'true'
              persistTransform: false
              limit: 500
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Hookbase API key with the whr_ prefix.