openapi: 3.2.0
info:
  title: Hookbase Cron Groups 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: Cron Groups
paths:
  /api/cron-groups:
    post:
      tags:
      - Cron Groups
      summary: Create cron group
      operationId: cron_groups_create_cron_group
      responses:
        '200':
          description: Successful response
      description: Create a group for organizing cron jobs.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Required. Group name.
                description:
                  type: string
                  description: Optional. Freeform description.
              required:
              - name
            example:
              name: Data pipelines
              description: All ETL jobs
    get:
      tags:
      - Cron Groups
      summary: List cron groups
      operationId: cron_groups_list_cron_groups
      responses:
        '200':
          description: Successful response
      description: List cron groups for the org.
  /api/cron-groups/{cronGroupId}:
    get:
      tags:
      - Cron Groups
      summary: Get cron group
      operationId: cron_groups_get_cron_group
      parameters:
      - name: cronGroupId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Fetch a single cron group.
    patch:
      tags:
      - Cron Groups
      summary: Update cron group
      operationId: cron_groups_update_cron_group
      parameters:
      - name: cronGroupId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Update a cron group. All fields optional.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Optional. Group name.
                description:
                  type: string
                  description: Optional. Freeform description (null to clear).
                sortOrder:
                  type: integer
                  description: Optional. Display sort order.
                isCollapsed:
                  type: boolean
                  description: Optional. Whether the group is collapsed in the UI.
            example:
              name: Data pipelines
              description: All ETL jobs
              sortOrder: 0
              isCollapsed: false
  /api/cron-groups/reorder:
    post:
      tags:
      - Cron Groups
      summary: Reorder cron groups
      operationId: cron_groups_reorder_cron_groups
      responses:
        '200':
          description: Successful response
      description: Set the display order of cron groups.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                groupIds:
                  type: array
                  items:
                    type: string
                  description: Required. Group ids in the desired order.
              required:
              - groupIds
            example:
              groupIds:
              - '{{cronGroupId}}'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Hookbase API key with the whr_ prefix.