openapi: 3.2.0
info:
  title: Hookbase Custom Domains 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: Custom Domains
paths:
  /api/custom-domains:
    post:
      tags:
      - Custom Domains
      summary: Create Custom Domain
      operationId: custom_domains_create_custom_domain
      responses:
        '200':
          description: Successful response
      description: Register a custom domain for source ingest or tunnel URLs; returns DNS records to add.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                domain:
                  type: string
                  description: Required. Fully-qualified domain (max 253).
                domainType:
                  type: string
                  description: Required. source | tunnel.
                targetId:
                  type: string
                  description: Optional. Source/tunnel id to bind the domain to.
              required:
              - domain
              - domainType
            example:
              domain: hooks.example.com
              domainType: source
              targetId: '{{sourceId}}'
    get:
      tags:
      - Custom Domains
      summary: List Custom Domains
      operationId: custom_domains_list_custom_domains
      responses:
        '200':
          description: Successful response
      description: List custom domains for the org.
  /api/custom-domains/{customDomainId}:
    get:
      tags:
      - Custom Domains
      summary: Get Custom Domain
      operationId: custom_domains_get_custom_domain
      parameters:
      - name: customDomainId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Fetch a single custom domain and its verification status.
    delete:
      tags:
      - Custom Domains
      summary: Delete Custom Domain
      operationId: custom_domains_delete_custom_domain
      parameters:
      - name: customDomainId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Delete a custom domain by id.
  /api/custom-domains/{customDomainId}/verify:
    post:
      tags:
      - Custom Domains
      summary: Verify Custom Domain
      operationId: custom_domains_verify_custom_domain
      parameters:
      - name: customDomainId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Check DNS and activate the domain once records are in place.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Hookbase API key with the whr_ prefix.