Skip to content
HookBridge Docs

Outbound Webhooks Guide

Use this guide when your system is sending events out through HookBridge.

Outbound Flow

Section titled “Outbound Flow”
  1. Your app calls POST /v1/webhooks/send.
  2. HookBridge queues and delivers to your outbound endpoint.
  3. Failed deliveries move through retry states.
  4. You monitor and recover from the console or API.

Idempotency (Outbound)

Section titled “Idempotency (Outbound)”

Use idempotency_key on send requests to avoid duplicate message creation.

{
  "endpoint_id": "YOUR_ENDPOINT_ID",
  "payload": {"event": "order.created", "order_id": "ord_123"},
  "idempotency_key": "order-123-created-v1"
}

Behavior:

  • Same key + same endpoint + same payload: original message is reused.
  • Same key + same endpoint + different payload: conflict response.
  • No key: new message each request.

Retry Behavior (Outbound)

Section titled “Retry Behavior (Outbound)”

Status progression:

  • queued
  • delivering
  • succeeded
  • pending_retry
  • failed_permanent

Recovery actions:

  • Retry now: POST /v1/messages/{id}/retry-now
  • Replay: POST /v1/messages/{id}/replay
  • Cancel pending retries: POST /v1/messages/{id}/cancel
  • DLQ replay: POST /v1/dlq/replay/{id}

Monitoring (Outbound)

Section titled “Monitoring (Outbound)”
  • Logs: GET /v1/logs
  • Metrics: GET /v1/metrics
  • Time series: GET /v1/metrics/timeseries
Section titled “Related”
Personalize Examples

Enter your credentials to populate code examples throughout the docs.