openapi: 3.2.0
info:
  title: Hookbase Scheduled Sends 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: Scheduled Sends
paths:
  /api/scheduled-sends:
    post:
      tags:
      - Scheduled Sends
      summary: Create scheduled send
      operationId: scheduled_sends_create_scheduled_send
      responses:
        '200':
          description: Successful response
      description: Schedule a one-off HTTP request to fire at a future time.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Required. Send name.
                url:
                  type: string
                  description: Required. Target URL.
                scheduledFor:
                  type: string
                  description: Required. When to fire (ISO 8601).
                description:
                  type: string
                  description: Optional. Freeform description.
                method:
                  type: string
                  description: Optional. HTTP method (default POST).
                headers:
                  type: object
                  description: Optional. Request headers.
                payload:
                  type: object
                  description: Optional. Request body (object or string).
                timezone:
                  type: string
                  description: Optional. IANA timezone (default UTC).
                maxAttempts:
                  type: integer
                  description: Optional. Max delivery attempts (default 3).
              required:
              - name
              - url
              - scheduledFor
            example:
              name: Reminder blast
              url: https://api.example.com/notify
              scheduledFor: '2024-06-01T09:00:00Z'
              description: One-off reminder
              method: POST
              headers:
                Authorization: Bearer xxx
              payload:
                message: hello
              timezone: UTC
              maxAttempts: 3
    get:
      tags:
      - Scheduled Sends
      summary: List scheduled sends
      operationId: scheduled_sends_list_scheduled_sends
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: string
        example: '1'
      - name: pageSize
        in: query
        required: false
        schema:
          type: string
        example: '20'
      responses:
        '200':
          description: Successful response
      description: List scheduled sends (paginated).
  /api/scheduled-sends/{scheduledSendId}:
    get:
      tags:
      - Scheduled Sends
      summary: Get scheduled send
      operationId: scheduled_sends_get_scheduled_send
      parameters:
      - name: scheduledSendId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Fetch a single scheduled send.
    patch:
      tags:
      - Scheduled Sends
      summary: Update scheduled send
      operationId: scheduled_sends_update_scheduled_send
      parameters:
      - name: scheduledSendId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Update a pending scheduled send. All fields optional.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Optional. Send name.
                description:
                  type: string
                  description: Optional. Freeform description.
                url:
                  type: string
                  description: Optional. Target URL.
                method:
                  type: string
                  description: Optional. HTTP method.
                headers:
                  type: object
                  description: Optional. Request headers.
                payload:
                  type: object
                  description: Optional. Request body.
                scheduledFor:
                  type: string
                  description: Optional. When to fire (ISO 8601).
                timezone:
                  type: string
                  description: Optional. IANA timezone.
                maxAttempts:
                  type: integer
                  description: Optional. Max delivery attempts.
            example:
              name: Reminder blast
              description: Updated description
              url: https://api.example.com/notify
              method: POST
              headers:
                Authorization: Bearer xxx
              payload:
                message: hello
              scheduledFor: '2024-06-01T09:00:00Z'
              timezone: UTC
              maxAttempts: 3
    delete:
      tags:
      - Scheduled Sends
      summary: Cancel scheduled send
      operationId: scheduled_sends_cancel_scheduled_send
      parameters:
      - name: scheduledSendId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Cancel (delete) a scheduled send by id.
  /api/scheduled-sends/{scheduledSendId}/send-now:
    post:
      tags:
      - Scheduled Sends
      summary: Send scheduled send now
      operationId: scheduled_sends_send_scheduled_send_now
      parameters:
      - name: scheduledSendId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Fire a pending/failed scheduled send immediately.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Hookbase API key with the whr_ prefix.