Hookbase

Hookbase Event Types API

The Event Types API from Hookbase — 2 operation(s) for event types.

GitHub OpenAPI

Operations 4

POST /api/event-types Create event type #
GET /api/event-types List event types #
GET /api/event-types/{eventTypeId} Get event type by id #
PATCH /api/event-types/{eventTypeId} Update event type #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/hookbase/refs/heads/main/openapi/hookbase-event-types-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hookbase/refs/heads/main/json-schema/hookbase-source-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hookbase/refs/heads/main/json-schema/hookbase-catalog-signature-verification-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hookbase/refs/heads/main/json-schema/hookbase-catalog-signature-verification-summary-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hookbase/refs/heads/main/json-schema/hookbase-created-source-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/hookbase:hookbase-event-types-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hookbase-event-types-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Hookbase Event Types 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: Event Types
paths:
  /api/event-types:
    post:
      tags:
      - Event Types
      summary: Create event type
      operationId: event_types_create_event_type
      responses:
        '200':
          description: Successful response
      description: Define an event type that endpoints can subscribe to.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Required. Machine name (e.g. invoice.paid).
                displayName:
                  type: string
                  description: Optional. Human-friendly name (max 100).
                description:
                  type: string
                  description: Optional. Description (max 1000).
                category:
                  type: string
                  description: Optional. Grouping category (max 50).
                schema:
                  type: string
                  description: Optional. JSON Schema (as a JSON string) for payload validation.
                examplePayload:
                  type: string
                  description: Optional. Example payload (as a JSON string).
                documentationUrl:
                  type: string
                  description: Optional. Link to docs for this event type.
                isEnabled:
                  type: boolean
                  description: Optional. Whether the type is enabled (default true).
                defaultPriority:
                  type: integer
                  description: Optional. Default priority 0=Critical,1=High,2=Normal,3=Low,4=Bulk.
              required:
              - name
            example:
              name: invoice.paid
              displayName: Invoice Paid
              description: Fired when an invoice is paid
              category: billing
              schema: '{"type":"object"}'
              examplePayload: '{"id":"inv_1"}'
              documentationUrl: https://docs.example.com/invoice-paid
              isEnabled: true
              defaultPriority: 2
    get:
      tags:
      - Event Types
      summary: List event types
      operationId: event_types_list_event_types
      responses:
        '200':
          description: Successful response
      description: List event types for the org.
  /api/event-types/{eventTypeId}:
    get:
      tags:
      - Event Types
      summary: Get event type by id
      operationId: event_types_get_event_type_by_id
      parameters:
      - name: eventTypeId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Fetch a single event type.
    patch:
      tags:
      - Event Types
      summary: Update event type
      operationId: event_types_update_event_type
      parameters:
      - name: eventTypeId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Update an event type. All fields optional.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                displayName:
                  type: string
                  description: Optional. Human-friendly name.
                description:
                  type: string
                  description: Optional. Description (max 1000).
                category:
                  type: string
                  description: Optional. Category (null to clear).
                schema:
                  type: string
                  description: Optional. JSON Schema string (null to clear).
                examplePayload:
                  type: string
                  description: Optional. Example payload string (null to clear).
                documentationUrl:
                  type: string
                  description: Optional. Docs URL (null to clear).
                isEnabled:
                  type: boolean
                  description: Optional. Enable/disable the type.
                isDeprecated:
                  type: boolean
                  description: Optional. Mark the type deprecated.
                deprecatedMessage:
                  type: string
                  description: Optional. Deprecation note (max 500).
                defaultPriority:
                  type: integer
                  description: Optional. Default priority 0–4.
            example:
              displayName: Invoice Paid
              description: Updated description
              category: billing
              schema: '{"type":"object"}'
              examplePayload: '{"id":"inv_1"}'
              documentationUrl: https://docs.example.com/invoice-paid
              isEnabled: true
              isDeprecated: false
              deprecatedMessage: Use invoice.settled instead
              defaultPriority: 2
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Hookbase API key with the whr_ prefix.