openapi: 3.2.0
info:
  title: Hookbase Observability (OTel) 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: Observability (OTel)
paths:
  /api/observability:
    post:
      tags:
      - Observability (OTel)
      summary: Create OTel Config
      operationId: observability_otel_create_otel_config
      responses:
        '200':
          description: Successful response
      description: Configure OpenTelemetry export of traces/metrics/logs to an OTLP-compatible backend.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Required. Config name.
                provider:
                  type: string
                  description: Required. otlp | newrelic | grafana | honeycomb | axiom.
                endpoint:
                  type: string
                  description: Required. OTLP endpoint URL (max 500).
                protocol:
                  type: string
                  description: Optional. http/json | http/protobuf (default http/json).
                authHeaders:
                  type: object
                  description: Optional. Headers sent to the OTLP endpoint.
                exportTypes:
                  type: object
                  description: Optional. Which signals to export (default traces+metrics).
                samplingRate:
                  type: number
                  description: Optional. Trace sampling rate (0.01–1.0, default 1.0).
                resourceFilter:
                  type: array
                  items:
                    type: string
                  description: Optional. Limit export to these resource (source) ids.
              required:
              - name
              - provider
              - endpoint
            example:
              name: Datadog OTLP
              provider: otlp
              endpoint: https://otlp.example.com
              protocol: http/json
              authHeaders:
                api-key: xxx
              exportTypes:
                traces: true
                metrics: true
                logs: false
              samplingRate: 1.0
              resourceFilter:
              - '{{sourceId}}'
    get:
      tags:
      - Observability (OTel)
      summary: List OTel Configs
      operationId: observability_otel_list_otel_configs
      responses:
        '200':
          description: Successful response
      description: List OTel export configs for the org.
  /api/observability/status:
    get:
      tags:
      - Observability (OTel)
      summary: Get OTel Export Status
      operationId: observability_otel_get_otel_export_status
      responses:
        '200':
          description: Successful response
      description: Return current OTel export health/status.
  /api/observability/{otelConfigId}:
    get:
      tags:
      - Observability (OTel)
      summary: Get OTel Config
      operationId: observability_otel_get_otel_config
      parameters:
      - name: otelConfigId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Fetch a single OTel config.
    patch:
      tags:
      - Observability (OTel)
      summary: Update OTel Config
      operationId: observability_otel_update_otel_config
      parameters:
      - name: otelConfigId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Update an OTel config. All fields optional.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Optional. Config name.
                provider:
                  type: string
                  description: Optional. otlp | newrelic | grafana | honeycomb | axiom.
                endpoint:
                  type: string
                  description: Optional. OTLP endpoint URL.
                protocol:
                  type: string
                  description: Optional. http/json | http/protobuf.
                authHeaders:
                  type: object
                  description: Optional. OTLP headers.
                exportTypes:
                  type: object
                  description: Optional. Signals to export.
                samplingRate:
                  type: number
                  description: Optional. Sampling rate (0.01–1.0).
                resourceFilter:
                  type: array
                  items:
                    type: string
                  description: Optional. Resource id filter (null to clear).
                isActive:
                  type: boolean
                  description: Optional. Enable/disable export.
            example:
              name: Datadog OTLP
              provider: otlp
              endpoint: https://otlp.example.com
              protocol: http/json
              authHeaders:
                api-key: xxx
              exportTypes:
                traces: true
                metrics: true
                logs: false
              samplingRate: 1.0
              resourceFilter:
              - '{{sourceId}}'
              isActive: true
    delete:
      tags:
      - Observability (OTel)
      summary: Delete OTel Config
      operationId: observability_otel_delete_otel_config
      parameters:
      - name: otelConfigId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Delete an OTel config by id.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Hookbase API key with the whr_ prefix.