openapi: 3.2.0
info:
  title: Hookbase Signature Testing 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: Signature Testing
paths:
  /api/testing/signature/verify:
    post:
      tags:
      - Signature Testing
      summary: Verify a webhook signature
      operationId: testing_verify_signature
      responses:
        '200':
          description: Successful response
      description: Checks whether a signature matches the given payload and secret, using the same verification logic as inbound ingest signature checking. Useful for validating a provider integration or debugging a rejected webhook before wiring up a source.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                provider:
                  type: string
                  description: Required. Signature provider id, e.g. stripe, github, shopify, gitlab, paddle, square, linear.
                payload:
                  type: string
                  description: Required. Raw request body as received (exact bytes/string used to compute the signature).
                secret:
                  type: string
                  description: Required. Signing secret to verify against.
                signature:
                  type: string
                  description: Required. Signature value to check, as received in the provider's signature header.
                timestamp:
                  type: number
                  description: Optional. Unix timestamp, for providers whose signature scheme includes one (e.g. Stripe).
              required:
              - provider
              - payload
              - secret
              - signature
            example:
              provider: stripe
              payload: '{"id":"evt_123","type":"charge.succeeded"}'
              secret: whsec_...
              signature: t=1699999999,v1=abcdef123456...
              timestamp: 1699999999
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Hookbase API key with the whr_ prefix.