openapi: 3.2.0
info:
  title: Hookbase Send Event 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: Send Event
paths:
  /api/send-event:
    post:
      tags:
      - Send Event
      summary: Send event
      operationId: send_event_send_event
      responses:
        '200':
          description: Successful response
      description: Publish an outbound event; Hookbase fans it out to all matching subscriptions.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                eventType:
                  type: string
                  description: Required. Event type name (1–255).
                payload:
                  type: object
                  description: Required. Event payload (any JSON).
                applicationId:
                  type: string
                  description: Optional. Scope delivery to one application.
                endpointId:
                  type: string
                  description: Optional. Scope delivery to one endpoint.
                idempotencyKey:
                  type: string
                  description: Optional. Dedupe key (max 255).
                labels:
                  type: object
                  description: Optional. String labels for subscription label-filtering (max 20).
                metadata:
                  type: object
                  description: Optional. Flat metadata, primitive values (max 50 keys, values max 1000 chars).
                priority:
                  type: integer
                  description: Optional. Priority 0=Critical,1=High,2=Normal,3=Low,4=Bulk.
              required:
              - eventType
              - payload
            example:
              eventType: invoice.paid
              payload:
                id: inv_1
                amount: 500
              applicationId: '{{webhookApplicationId}}'
              endpointId: '{{webhookEndpointId}}'
              idempotencyKey: evt-2024-01-15-001
              labels:
                env: prod
              metadata:
                source: billing-service
              priority: 2
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Hookbase API key with the whr_ prefix.