openapi: 3.2.0
info:
  title: Hookbase Events 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: Events
paths:
  /api/events:
    get:
      tags:
      - Events
      summary: List events
      operationId: events_list_events
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
        example: '10'
      - name: sourceId
        in: query
        required: false
        schema:
          type: string
        description: Filter by source ID or slug. A slug that matches no source returns 404.
      responses:
        '200':
          description: Successful response
      description: List ingested events (filterable by source, type, time; paginated).
  /api/events/{eventId}:
    get:
      tags:
      - Events
      summary: Get event by id
      operationId: events_get_event_by_id
      parameters:
      - name: eventId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Fetch a single event including its deliveries.
  /api/events/{eventId}/debug:
    get:
      tags:
      - Events
      summary: Get event debug
      operationId: events_get_event_debug
      parameters:
      - name: eventId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: 'Return full debug detail for an event: raw payload, headers, routing trace, and delivery attempts.'
  /api/events/export:
    get:
      tags:
      - Events
      summary: Export events
      operationId: events_export_events
      parameters:
      - name: format
        in: query
        required: false
        schema:
          type: string
        example: json
      responses:
        '200':
          description: Successful response
      description: Export events as JSON or CSV for a time range (?format=json|csv).
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Hookbase API key with the whr_ prefix.