openapi: 3.2.0
info:
  title: Hookbase Outbound Messages 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: Outbound Messages
paths:
  /api/outbound-messages:
    get:
      tags:
      - Outbound Messages
      summary: List outbound messages
      operationId: outbound_messages_list_outbound_messages
      parameters:
      - name: applicationId
        in: query
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: string
        example: '50'
      responses:
        '200':
          description: Successful response
      description: List outbound messages (filter by ?applicationId=, status; paginated).
  /api/outbound-messages/stats/summary:
    get:
      tags:
      - Outbound Messages
      summary: Outbound message stats
      operationId: outbound_messages_outbound_message_stats
      responses:
        '200':
          description: Successful response
      description: Summary counts of outbound messages by status.
  /api/outbound-messages/{outboundMessageId}:
    get:
      tags:
      - Outbound Messages
      summary: Get outbound message by id
      operationId: outbound_messages_get_outbound_message_by_id
      parameters:
      - name: outboundMessageId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Fetch a single outbound message.
  /api/outbound-messages/{outboundMessageId}/attempts:
    get:
      tags:
      - Outbound Messages
      summary: Get outbound message attempts
      operationId: outbound_messages_get_outbound_message_attempts
      parameters:
      - name: outboundMessageId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: List delivery attempts for an outbound message.
  /api/outbound-messages/{outboundMessageId}/replay:
    post:
      tags:
      - Outbound Messages
      summary: Replay outbound message
      operationId: outbound_messages_replay_outbound_message
      parameters:
      - name: outboundMessageId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Re-queue a failed/exhausted/DLQ outbound message as a new delivery.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Hookbase API key with the whr_ prefix.