generated: '2026-10-18' method: derived generator: derive-vocabulary.py source: openapi/hookbase-openapi.json vocabulary: name: Hookbase Domain Vocabulary description: 'Terms declared by Hookbase''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions. Derived, not authored.' version: '2026-10-18' terms: - term: Provider Catalog definition: Public catalog of supported webhook providers and their signature/secret rules. tags: - Resource Group source: openapi/hookbase-openapi.json - term: Error definition: 'Object declared by the contract with fields: error.' tags: - Object source: openapi/hookbase-openapi.json#/components/schemas/Error - term: Source definition: A source. The full signing secret is never included except in the create response. tags: - Object source: openapi/hookbase-openapi.json#/components/schemas/Source - term: CatalogSignatureVerificationSummary definition: 'Object declared by the contract with fields: supported, kind, secretSource, secretLabel, secretPlaceholder, secretAfterRegistration.' tags: - Object source: openapi/hookbase-openapi.json#/components/schemas/CatalogSignatureVerificationSummary - term: CatalogSignatureVerification definition: 'Object declared by the contract with fields: supported, kind, secretSource, secretLabel, secretPlaceholder, secretAfterRegistration, algorithm, headerName, secretLocationHint, secretInstruction, secretFormat, verifyToken.' tags: - Object source: openapi/hookbase-openapi.json#/components/schemas/CatalogSignatureVerification - term: Sources definition: 'Resource group in the contract; its operation POST /api/sources: Create an inbound source.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Destinations definition: 'Resource group in the contract; its operation POST /api/destinations: Create an outbound destination (HTTP endpoint or warehouse/queue sink).' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Routes definition: 'Resource group in the contract; its operation POST /api/routes: Create a route wiring a source to a destination, with optional filter, transform, schema validation, failover, and circuit-breaker config.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Filters definition: 'Resource group in the contract; its operation POST /api/filters: Create a reusable filter — a set of conditions combined with AND/OR — that routes can reference.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Transforms definition: 'Resource group in the contract; its operation POST /api/transforms: Create a reusable payload transform (JSONata, XSLT, Liquid, or JavaScript).' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Schemas definition: 'Resource group in the contract; its operation POST /api/schemas: Create a JSON Schema that routes can validate payloads against.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Events definition: 'Resource group in the contract; its operation GET /api/events: List ingested events (filterable by source, type, time; paginated).' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Deliveries definition: 'Resource group in the contract; its operation GET /api/deliveries: List delivery attempts (filterable by status, route, destination; paginated).' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Delivery Clusters definition: 'Resource group in the contract; its operation GET /api/delivery-clusters: List failed deliveries grouped by failure fingerprint over a look-back window.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Cron Jobs definition: 'Resource group in the contract; its operation POST /api/cron: Create a scheduled HTTP job that fires on a cron expression.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Cron Groups definition: 'Resource group in the contract; its operation POST /api/cron-groups: Create a group for organizing cron jobs.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Webhook Applications definition: 'Resource group in the contract; its operation POST /api/webhook-applications: Create a webhook application (a tenant/customer that owns endpoints and subscriptions).' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Event Types definition: 'Resource group in the contract; its operation POST /api/event-types: Define an event type that endpoints can subscribe to.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Webhook Endpoints definition: 'Resource group in the contract; its operation POST /api/webhook-endpoints: Create a webhook endpoint (a delivery target) under an application.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Webhook Subscriptions definition: 'Resource group in the contract; its operation POST /api/webhook-subscriptions: Subscribe an endpoint to an event type, with optional filtering and transform.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Send Event definition: 'Resource group in the contract; its operation POST /api/send-event: Publish an outbound event; Hookbase fans it out to all matching subscriptions.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Outbound Messages definition: 'Resource group in the contract; its operation GET /api/outbound-messages: List outbound messages (filter by ?applicationId=, status; paginated).' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Webhook Analytics definition: 'Resource group in the contract; its operation GET /api/webhooks/analytics: Outbound webhook analytics across the org for a time range (?timeRange=).' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Operational Webhooks definition: 'Resource group in the contract; its operation POST /api/applications/{webhookApplicationId}/operational-webhooks: Register an operational webhook that notifies you about endpoint lifecycle events (exhaustion, circuit-breaker, disabling).' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Publish Event (v1) definition: 'Resource group in the contract; its operation POST /v1/events: Stable v1 endpoint to publish an outbound event (fanned out to matching subscriptions).' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Portal Tokens definition: 'Resource group in the contract; its operation POST /api/portal/webhook-applications/{webhookApplicationId}/tokens: Mint a portal token that lets an application''s users access the embeddable portal.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Tunnels definition: 'Resource group in the contract; its operation POST /api/tunnels: Create a tunnel for forwarding webhooks to a local/dev environment.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Notification Channels definition: 'Resource group in the contract; its operation POST /api/notification-channels: Create a notification channel used by routes and alert rules.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Redaction Policies definition: 'Resource group in the contract; its operation POST /api/redaction-policies: Create a policy that redacts/masks/hashes/removes sensitive fields before storage and/or delivery.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Custom Domains definition: 'Resource group in the contract; its operation POST /api/custom-domains: Register a custom domain for source ingest or tunnel URLs; returns DNS records to add.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Scheduled Sends definition: 'Resource group in the contract; its operation POST /api/scheduled-sends: Schedule a one-off HTTP request to fire at a future time.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Observability (OTel) definition: 'Resource group in the contract; its operation POST /api/observability: Configure OpenTelemetry export of traces/metrics/logs to an OTLP-compatible backend.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Alert Rules definition: 'Resource group in the contract; its operation POST /api/alert-rules: Create a rule that notifies channels on source silence, failure/latency spikes, volume anomalies, or schema drift.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Analytics definition: 'Resource group in the contract; its operation GET /api/analytics/dashboard: Aggregated dashboard metrics for the org over a range (?range=).' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Audit Logs definition: 'Resource group in the contract; its operation GET /api/audit-logs: List audit log entries (filterable; paginated).' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Signature Testing definition: 'Resource group in the contract; its operation POST /api/testing/signature/verify: Checks whether a signature matches the given payload and secret, using the same verification logic as inbound ingest signature checking.' tags: - Resource Group source: openapi/hookbase-openapi.json - term: Realtime definition: 'Resource group in the contract; its operation GET /api/realtime/stream: Server-Sent Events (SSE) stream of live inbound events and deliveries for the organization (event_received, delivery_started/completed/failed/throttled, source_rate_limited).' tags: - Resource Group source: openapi/hookbase-openapi.json