openapi: 3.2.0
info:
  title: Hookbase Operational Webhooks 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: Operational Webhooks
paths:
  /api/applications/{webhookApplicationId}/operational-webhooks:
    post:
      tags:
      - Operational Webhooks
      summary: Create operational webhook
      operationId: operational_webhooks_create_operational_webhook
      parameters:
      - name: webhookApplicationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Register an operational webhook that notifies you about endpoint lifecycle events (exhaustion, circuit-breaker, disabling).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: Required. URL to receive operational events.
                description:
                  type: string
                  description: Optional. Freeform description (max 500).
                onMessageExhausted:
                  type: boolean
                  description: Optional. Notify when a message exhausts retries (default true).
                onCircuitBreakerOpen:
                  type: boolean
                  description: Optional. Notify when a circuit opens (default true).
                onCircuitBreakerClose:
                  type: boolean
                  description: Optional. Notify when a circuit closes (default false).
                onEndpointDisabled:
                  type: boolean
                  description: Optional. Notify when an endpoint is auto-disabled (default true).
              required:
              - url
            example:
              url: https://ops.example.com/hooks
              description: Ops alerting
              onMessageExhausted: true
              onCircuitBreakerOpen: true
              onCircuitBreakerClose: false
              onEndpointDisabled: true
    get:
      tags:
      - Operational Webhooks
      summary: List operational webhooks
      operationId: operational_webhooks_list_operational_webhooks
      parameters:
      - name: webhookApplicationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: List operational webhooks for an application.
  /api/applications/{webhookApplicationId}/operational-webhooks/{operationalWebhookId}:
    get:
      tags:
      - Operational Webhooks
      summary: Get operational webhook by id
      operationId: operational_webhooks_get_operational_webhook_by_id
      parameters:
      - name: webhookApplicationId
        in: path
        required: true
        schema:
          type: string
      - name: operationalWebhookId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Fetch a single operational webhook.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Hookbase API key with the whr_ prefix.