Skip to content
HookBridge Docs

Overview

HookBridge API 1.0.0

Section titled “HookBridge API 1.0.0”

HookBridge is a webhook delivery reliability platform that provides:

  • Guaranteed delivery with intelligent retries
  • Full observability through logs and metrics
  • HMAC signing for security
  • Idempotency guarantees
  • Replay capabilities for failed deliveries

Authentication

All API requests require authentication via API key. Include your API key in the Authorization header:

Authorization: Bearer hb_live_xxxxxxxxxxxxxxxxxxxx

API keys can be created and managed via the /v1/api-keys endpoints or through the web console.

Rate Limits

  • Project-level: 1000 requests per minute
  • Endpoint-level: 10 requests per second

Webhook Delivery

When HookBridge delivers webhooks to your customers’ endpoints, it includes:

  • X-Webhook-Signature: HMAC-SHA256 signature for payload verification
  • X-Webhook-Id: Unique message ID for tracking
  • X-Webhook-Timestamp: Unix timestamp of the original send request
  • Custom headers you specify in the send request

Information

  • License: Proprietary
  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/health
POST
/v1/webhooks/send
GET
/v1/endpoints
POST
/v1/endpoints
GET
/v1/endpoints/{id}
DELETE
/v1/endpoints/{id}
PATCH
/v1/endpoints/{id}
POST
/v1/endpoints/{id}/pause
POST
/v1/endpoints/{id}/resume
GET
/v1/endpoints/{id}/signing-keys
POST
/v1/endpoints/{id}/signing-keys
DELETE
/v1/endpoints/{id}/signing-keys/{keyId}
GET
/v1/messages/{id}
DELETE
/v1/messages/{id}
POST
/v1/messages/delete-batch
POST
/v1/messages/delete-all
GET
/v1/messages/{id}/attempts
POST
/v1/messages/{id}/replay
POST
/v1/messages/{id}/cancel
POST
/v1/messages/{id}/retry-now
POST
/v1/messages/replay-all
POST
/v1/messages/replay-batch
GET
/v1/dlq/messages
POST
/v1/dlq/replay/{id}
GET
/v1/logs
GET
/v1/metrics
GET
/v1/metrics/timeseries
GET
/v1/api-keys
POST
/v1/api-keys
DELETE
/v1/api-keys/{id}
GET
/v1/billing/subscription
GET
/v1/billing/usage-history
GET
/v1/billing/invoices
POST
/v1/billing/webhook
GET
/v1/inbound-endpoints
POST
/v1/inbound-endpoints
GET
/v1/inbound-endpoints/{id}
DELETE
/v1/inbound-endpoints/{id}
PATCH
/v1/inbound-endpoints/{id}
GET
/v1/inbound-endpoints/{id}/signing-keys
POST
/v1/inbound-endpoints/{id}/signing-keys
DELETE
/v1/inbound-endpoints/{id}/signing-keys/{keyId}
POST
/v1/inbound-endpoints/{id}/pause
POST
/v1/inbound-endpoints/{id}/resume
GET
/v1/inbound-endpoints/{id}/listen
GET
/v1/pull-endpoints
POST
/v1/pull-endpoints
GET
/v1/pull-endpoints/{id}
DELETE
/v1/pull-endpoints/{id}
PATCH
/v1/pull-endpoints/{id}
POST
/v1/pull-endpoints/{id}/pause
POST
/v1/pull-endpoints/{id}/resume
GET
/v1/pull-endpoints/{id}/events
GET
/v1/pull-endpoints/{id}/events/{event_id}
DELETE
/v1/pull-endpoints/{id}/events/{event_id}
POST
/v1/pull-endpoints/{id}/events/delete-batch
POST
/v1/pull-endpoints/{id}/events/delete-all
POST
/v1/pull-endpoints/{id}/events/ack
GET
/v1/pull-logs
GET
/v1/pull-metrics
GET
/v1/pull-metrics/timeseries
GET
/v1/inbound-messages/{id}
DELETE
/v1/inbound-messages/{id}
POST
/v1/inbound-messages/delete-batch
POST
/v1/inbound-messages/delete-all
GET
/v1/inbound-messages/{id}/attempts
POST
/v1/inbound-messages/{id}/replay
POST
/v1/inbound-messages/replay-all
POST
/v1/inbound-messages/replay-batch
GET
/v1/inbound-logs
GET
/v1/inbound-metrics
GET
/v1/inbound-metrics/timeseries
GET
/v1/inbound-rejections
GET
/v1/exports
POST
/v1/exports
GET
/v1/exports/{id}
DELETE
/v1/exports/{id}
GET
/v1/exports/{id}/download
GET
/v1/actors/lookup

Authentication

Section titled “Authentication”

BearerAuth

Section titled “BearerAuth”

API key authentication. Include your API key in the Authorization header:

Authorization: Bearer hb_live_xxxxxxxxxxxxxxxxxxxx

API keys are prefixed with:

  • hb_live_ for production keys
  • hb_test_ for test/development keys

Security scheme type: http

Bearer format: API Key

Personalize Examples

Enter your credentials to populate code examples throughout the docs.