openapi: 3.2.0
info:
  title: Hookbase Schemas 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: Schemas
paths:
  /api/schemas:
    post:
      tags:
      - Schemas
      summary: Create schema
      operationId: schemas_create_schema
      responses:
        '200':
          description: Successful response
      description: Create a JSON Schema that routes can validate payloads against.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Required. Schema name.
                jsonSchema:
                  type: object
                  description: Required. A JSON Schema object.
                description:
                  type: string
                  description: Optional. Freeform description.
              required:
              - name
              - jsonSchema
            example:
              name: Order Schema
              jsonSchema:
                type: object
                required:
                - id
                properties:
                  id:
                    type: string
              description: Validates order payloads
    get:
      tags:
      - Schemas
      summary: List schemas
      operationId: schemas_list_schemas
      responses:
        '200':
          description: Successful response
      description: List schemas for the org.
  /api/schemas/{schemaId}:
    get:
      tags:
      - Schemas
      summary: Get schema by id
      operationId: schemas_get_schema_by_id
      parameters:
      - name: schemaId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Fetch a single schema by id or slug.
    put:
      tags:
      - Schemas
      summary: Update schema
      operationId: schemas_update_schema
      parameters:
      - name: schemaId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Replace a schema's fields. All fields optional.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Optional. Schema name.
                jsonSchema:
                  type: object
                  description: Optional. Replacement JSON Schema object.
                description:
                  type: string
                  description: Optional. Freeform description.
            example:
              name: Order Schema
              jsonSchema:
                type: object
                required:
                - id
                properties:
                  id:
                    type: string
              description: Updated description
  /api/schemas/{schemaId}/validate:
    post:
      tags:
      - Schemas
      summary: Validate payload against schema
      operationId: schemas_validate_payload_against_schema
      parameters:
      - name: schemaId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Validate a payload against a stored schema and return any errors.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  type: object
                  description: Required. Payload to validate.
              required:
              - payload
            example:
              payload:
                id: ord_123
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Hookbase API key with the whr_ prefix.