Hookbase Filters API

openapi: 3.2.0
info:
  title: Hookbase Filters 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: Filters
paths:
  /api/filters:
    post:
      tags:
      - Filters
      summary: Create filter
      operationId: filters_create_filter
      responses:
        '200':
          description: Successful response
      description: Create a reusable filter — a set of conditions combined with AND/OR — that routes can reference.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Required. Filter name.
                conditions:
                  type: array
                  items:
                    type: object
                  description: 'Required. Conditions [{field, operator, value}]. operator: equals, not_equals, contains, starts_with, ends_with, exists, not_exists, greater_than, less_than, regex.'
                logic:
                  type: string
                  description: Optional. AND | OR (default AND).
                description:
                  type: string
                  description: Optional. Freeform description.
                slug:
                  type: string
                  description: Optional. URL-safe id (auto-generated from name if omitted).
              required:
              - name
              - conditions
            example:
              name: Only opened PRs
              conditions:
              - field: action
                operator: equals
                value: opened
              logic: AND
              description: Match opened pull requests
              slug: only-opened-prs
    get:
      tags:
      - Filters
      summary: List filters
      operationId: filters_list_filters
      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 filters for the org (paginated).
  /api/filters/{filterId}:
    get:
      tags:
      - Filters
      summary: Get filter by id
      operationId: filters_get_filter_by_id
      parameters:
      - name: filterId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Fetch a single filter by id or slug.
    patch:
      tags:
      - Filters
      summary: Update filter
      operationId: filters_update_filter
      parameters:
      - name: filterId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Update a filter. All fields optional.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Optional. Filter name.
                conditions:
                  type: array
                  items:
                    type: object
                  description: Optional. Replacement conditions array.
                logic:
                  type: string
                  description: Optional. AND | OR.
                description:
                  type: string
                  description: Optional. Freeform description (null to clear).
            example:
              name: Only opened PRs
              conditions:
              - field: action
                operator: equals
                value: opened
              logic: AND
              description: Updated description
  /api/filters/test:
    post:
      tags:
      - Filters
      summary: Test filter against payload
      operationId: filters_test_filter_against_payload
      responses:
        '200':
          description: Successful response
      description: Evaluate a set of conditions against a sample payload and see which passed.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                conditions:
                  type: array
                  items:
                    type: object
                  description: Required. Conditions to evaluate.
                payload:
                  type: object
                  description: Required. Sample payload to test against.
                logic:
                  type: string
                  description: Optional. AND | OR (default AND).
              required:
              - conditions
              - payload
            example:
              conditions:
              - field: action
                operator: equals
                value: opened
              payload:
                action: opened
                number: 1
              logic: AND
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Hookbase API key with the whr_ prefix.