generated: '2026-10-18'
method: derived
generator: derive-vocabulary.py
source: openapi/_original/hookbridge-api-openapi.yml
vocabulary:
  name: Hookbridge Domain Vocabulary
  description: 'Terms declared by Hookbridge''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions.
    Derived, not authored.'
  version: '2026-10-18'
  terms:
  - term: Health
    definition: Service health checks
    tags:
    - Resource Group
    source: openapi/_original/hookbridge-api-openapi.yml
  - term: Webhooks
    definition: Send webhooks for delivery
    tags:
    - Resource Group
    source: openapi/_original/hookbridge-api-openapi.yml
  - term: Endpoints
    definition: Manage webhook endpoints
    tags:
    - Resource Group
    source: openapi/_original/hookbridge-api-openapi.yml
  - term: Messages
    definition: Query and manage message delivery
    tags:
    - Resource Group
    source: openapi/_original/hookbridge-api-openapi.yml
  - term: DLQ
    definition: Dead Letter Queue management for failed messages
    tags:
    - Resource Group
    source: openapi/_original/hookbridge-api-openapi.yml
  - term: Observability
    definition: Logs and metrics
    tags:
    - Resource Group
    source: openapi/_original/hookbridge-api-openapi.yml
  - term: API Keys
    definition: Manage API keys for authentication
    tags:
    - Resource Group
    source: openapi/_original/hookbridge-api-openapi.yml
  - term: Projects
    definition: Project management
    tags:
    - Resource Group
    source: openapi/_original/hookbridge-api-openapi.yml
  - term: Billing
    definition: Subscription management and Stripe integration
    tags:
    - Resource Group
    source: openapi/_original/hookbridge-api-openapi.yml
  - term: Inbound Endpoints
    definition: Manage inbound webhook endpoints for receiving webhooks from external sources
    tags:
    - Resource Group
    source: openapi/_original/hookbridge-api-openapi.yml
  - term: Pull Endpoints
    definition: Manage pull mode endpoints for consumer-controlled event retrieval
    tags:
    - Resource Group
    source: openapi/_original/hookbridge-api-openapi.yml
  - term: Pull Events
    definition: Retrieve and acknowledge events stored at pull endpoints
    tags:
    - Resource Group
    source: openapi/_original/hookbridge-api-openapi.yml
  - term: Pull Observability
    definition: Logs and metrics for pull endpoint events
    tags:
    - Resource Group
    source: openapi/_original/hookbridge-api-openapi.yml
  - term: Inbound Messages
    definition: Query, replay, and monitor inbound webhook messages
    tags:
    - Resource Group
    source: openapi/_original/hookbridge-api-openapi.yml
  - term: Exports
    definition: CSV export jobs for webhook delivery data
    tags:
    - Resource Group
    source: openapi/_original/hookbridge-api-openapi.yml
  - term: SendWebhookRequest
    definition: 'Object declared by the contract with fields: endpoint_id, payload, headers, idempotency_key, retention_hours.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/SendWebhookRequest
  - term: SendWebhookResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/SendWebhookResponse
  - term: GetMessageResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/GetMessageResponse
  - term: DeleteMessageResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/DeleteMessageResponse
  - term: DeleteEventResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/DeleteEventResponse
  - term: DeleteBatchRequest
    definition: 'Object declared by the contract with fields: message_ids.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/DeleteBatchRequest
  - term: DeleteBatchResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/DeleteBatchResponse
  - term: DeleteEventBatchResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/DeleteEventBatchResponse
  - term: DeleteAllResponse
    definition: 'Object declared by the contract with fields: data, error, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/DeleteAllResponse
  - term: PullDeleteAllResponse
    definition: 'Object declared by the contract with fields: data, error, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/PullDeleteAllResponse
  - term: ActorLookupResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/ActorLookupResponse
  - term: ReplayMessageResponse
    definition: 'Object declared by the contract with fields: message, data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/ReplayMessageResponse
  - term: GetLogsResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/GetLogsResponse
  - term: GetMetricsResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/GetMetricsResponse
  - term: CreateEndpointRequest
    definition: 'Object declared by the contract with fields: url, description, rate_limit_rps, burst, headers, ephemeral, ttl_minutes.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/CreateEndpointRequest
  - term: CreateEndpointResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/CreateEndpointResponse
  - term: GetEndpointResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/GetEndpointResponse
  - term: ListEndpointsResponse
    definition: Paginated list of endpoints. Uses EndpointSummary (omits headers, rate limits) for performance. Use GET /endpoints/:id for full
      details.
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/ListEndpointsResponse
  - term: UpdateEndpointRequest
    definition: 'Object declared by the contract with fields: url, description, rate_limit_rps, burst, headers.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/UpdateEndpointRequest
  - term: UpdateEndpointResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/UpdateEndpointResponse
  - term: SigningKey
    definition: 'Object declared by the contract with fields: id, key_hint, created_at.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/SigningKey
  - term: CreateSigningKeyResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/CreateSigningKeyResponse
  - term: ListSigningKeysResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/ListSigningKeysResponse
  - term: Endpoint
    definition: Full endpoint details (returned by GET /endpoints/:id)
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/Endpoint
  - term: EndpointSummary
    definition: Summary endpoint info for list responses (omits headers for performance)
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/EndpointSummary
  - term: ListAPIKeysResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/ListAPIKeysResponse
  - term: CreateAPIKeyRequest
    definition: 'Object declared by the contract with fields: label.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/CreateAPIKeyRequest
  - term: CreateAPIKeyResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/CreateAPIKeyResponse
  - term: APIKeyInfo
    definition: 'Object declared by the contract with fields: key_id, label, prefix, created_at, last_used_at.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/APIKeyInfo
  - term: Message
    definition: 'Object declared by the contract with fields: id, project_id, endpoint_id, status, attempt_count, replay_count, content_type,
      size_bytes, payload_sha256, idempotency_key, next_attempt_at, last_error. (13 more)'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/Message
  - term: MessageSummary
    definition: 'Object declared by the contract with fields: message_id, endpoint, status, attempt_count, created_at, delivered_at, first_attempt_at,
      response_status, response_latency_ms, processing_ms, total_delivery_ms, queue_wait_ms. (2 more)'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/MessageSummary
  - term: Metrics
    definition: 'Object declared by the contract with fields: window, total_messages, succeeded, failed, retries, success_rate, avg_latency_ms,
      avg_delivery_time_ms, avg_queue_wait_ms.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/Metrics
  - term: CreateCheckoutRequest
    definition: 'Object declared by the contract with fields: plan, interval.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/CreateCheckoutRequest
  - term: CreateCheckoutResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/CreateCheckoutResponse
  - term: CreatePortalRequest
    definition: 'Object declared by the contract with fields: return_url.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/CreatePortalRequest
  - term: CreatePortalResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/CreatePortalResponse
  - term: GetSubscriptionResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/GetSubscriptionResponse
  - term: UsageHistoryRow
    definition: 'Object declared by the contract with fields: period_start, period_end, message_count, overage_count, plan_limit.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/UsageHistoryRow
  - term: GetUsageHistoryResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/GetUsageHistoryResponse
  - term: InvoiceLine
    definition: 'Object declared by the contract with fields: description, amount, quantity.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/InvoiceLine
  - term: Invoice
    definition: 'Object declared by the contract with fields: id, status, amount_due, amount_paid, currency, period_start, period_end, created,
      invoice_pdf, hosted_invoice_url, lines.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/Invoice
  - term: GetInvoicesResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/GetInvoicesResponse
  - term: TimeSeriesBucket
    definition: 'Object declared by the contract with fields: timestamp, succeeded, failed, retrying, total, avg_latency_ms.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/TimeSeriesBucket
  - term: GetTimeSeriesMetricsResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/GetTimeSeriesMetricsResponse
  - term: CreateInboundEndpointRequest
    definition: 'Object declared by the contract with fields: name, description, mode, url, verify_static_token, token_header_name, token_query_param,
      token_value, verify_hmac, hmac_header_name, hmac_secret, timestamp_header_name. (8 more)'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/CreateInboundEndpointRequest
  - term: CreateInboundEndpointResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/CreateInboundEndpointResponse
  - term: InboundEndpoint
    definition: Full inbound endpoint details (returned by GET /inbound-endpoints/:id)
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/InboundEndpoint
  - term: InboundEndpointSummary
    definition: Summary inbound endpoint info for list responses
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/InboundEndpointSummary
  - term: GetInboundEndpointResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/GetInboundEndpointResponse
  - term: ListInboundEndpointsResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/ListInboundEndpointsResponse
  - term: UpdateInboundEndpointRequest
    definition: 'Object declared by the contract with fields: name, description, mode, url, verify_static_token, token_header_name, token_query_param,
      token_value, verify_hmac, hmac_header_name, hmac_secret, timestamp_header_name. (6 more)'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/UpdateInboundEndpointRequest
  - term: UpdateInboundEndpointResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/UpdateInboundEndpointResponse
  - term: ListenInboundEndpointResponse
    definition: Response from the CLI polling endpoint. Contains an array of inbound messages with their full payload and headers. Use `next_cursor`
      to paginate through additional messages.
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/ListenInboundEndpointResponse
  - term: ReplayInboundMessageResponse
    definition: 'Object declared by the contract with fields: message, data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/ReplayInboundMessageResponse
  - term: ReplayAllInboundMessagesResponse
    definition: 'Object declared by the contract with fields: message, data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/ReplayAllInboundMessagesResponse
  - term: InboundLogEntry
    definition: 'Object declared by the contract with fields: message_id, inbound_endpoint_id, endpoint, status, attempt_count, received_at, delivered_at,
      response_status, response_latency_ms, last_error, total_delivery_ms, deleted_at.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/InboundLogEntry
  - term: GetInboundLogsResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/GetInboundLogsResponse
  - term: GetInboundMetricsResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/GetInboundMetricsResponse
  - term: GetInboundTimeSeriesMetricsResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/GetInboundTimeSeriesMetricsResponse
  - term: InboundRejection
    definition: 'Object declared by the contract with fields: id, reason_code, received_at, inbound_endpoint_id, reason_detail, source_ip, headers_redacted.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/InboundRejection
  - term: ListInboundRejectionsResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/ListInboundRejectionsResponse
  - term: CreateExportRequest
    definition: 'Object declared by the contract with fields: start_time, end_time, status, endpoint_id, direction, inbound_endpoint_id.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/CreateExportRequest
  - term: ExportRecord
    definition: 'Object declared by the contract with fields: id, project_id, status, filter_start_time, filter_end_time, filter_status, filter_endpoint_id,
      filter_inbound_endpoint_id, direction, row_count, file_size_bytes, error_message. (4 more)'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/ExportRecord
  - term: CreateExportResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/CreateExportResponse
  - term: ListExportsResponse
    definition: 'Object declared by the contract with fields: data, meta.'
    tags:
    - Object
    source: openapi/_original/hookbridge-api-openapi.yml#/components/schemas/ListExportsResponse