Webhook (oridecon-webhook)

Webhook management for the Oridecon Framework — subscription CRUD, delivery tracking, HMAC verification, and dead-letter queue

Overview

oridecon-webhook provides outbound webhook management with subscription CRUD, fan-out delivery with exponential backoff retry, HMAC-SHA256 signing, dead-letter queue, and event bus bridge. It supports in-memory and SQL persistence backends, secret rotation with grace periods, and automatic subscription disable after consecutive failures.

Full documentation: oridecon.dev

Install

uv add oridecon-webhook
# Optional extras
uv add "oridecon-webhook[sql]"

Quick Start

from oridecon import Application
from oridecon.di.module import Module, module

# Import the module from the package
from oridecon.webhook import WebhookModule


@module(imports=[WebhookModule.configure()])
class AppModule(Module):
    pass


async with Application.boot(modules=[AppModule]) as app:
    # use app.container to resolve services
    ...

Configuration

Zero-config usage: Call WebhookModule.configure() with no arguments to use defaults.

Option 1 — YAML file

webhook:
  store_backend: "memory"
  retry_max_attempts: 5
  retry_base_delay: 1.0
  delivery_timeout_seconds: 30.0
  signature_algorithm: "sha256"

Option 2 — Profiles + Environment Variables (recommended)

export ORI_WEBHOOK__ENABLED=true
# Environment variables for each field

Option 3 — Python

from oridecon.webhook.config import WebhookConfig
from oridecon.webhook import WebhookModule

config = WebhookConfig(store_backend="memory", retry_max_attempts=5)
WebhookModule.configure(config)

Config reference

Field	Default	Env var	Description
`store_backend`	`"memory"`	`ORI_WEBHOOK__STORE_BACKEND`	`"memory"` or `"sql"` (requires `[sql]` extra)
`retry_max_attempts`	`5`	`ORI_WEBHOOK__RETRY_MAX_ATTEMPTS`	Delivery attempts before dead-letter
`retry_base_delay`	`1.0`	`ORI_WEBHOOK__RETRY_BASE_DELAY`	Initial retry delay in seconds
`retry_max_delay`	`60.0`	`ORI_WEBHOOK__RETRY_MAX_DELAY`	Maximum retry delay ceiling in seconds
`retry_backoff_factor`	`2.0`	`ORI_WEBHOOK__RETRY_BACKOFF_FACTOR`	Exponential backoff multiplier
`secret_length`	`32`	`ORI_WEBHOOK__SECRET_LENGTH`	Secret bytes (hex output is 2×)
`secret_rotation_grace_hours`	`24`	`ORI_WEBHOOK__SECRET_ROTATION_GRACE_HOURS`	Grace window where both old and new secrets are valid
`delivery_timeout_seconds`	`30.0`	`ORI_WEBHOOK__DELIVERY_TIMEOUT_SECONDS`	HTTP request timeout per attempt
`disable_after_consecutive_failures`	`50`	`ORI_WEBHOOK__DISABLE_AFTER_CONSECUTIVE_FAILURES`	Auto-disable threshold
`failure_window_hours`	`24`	`ORI_WEBHOOK__FAILURE_WINDOW_HOURS`	Window for counting consecutive failures
`signature_algorithm`	`"sha256"`	`ORI_WEBHOOK__SIGNATURE_ALGORITHM`	HMAC algorithm: `"sha256"` or `"sha512"`
`enable_admin`	`True`	`ORI_WEBHOOK__ENABLE_ADMIN`	Register the admin panel contributor
`delivery_log_retention_days`	`30`	`ORI_WEBHOOK__DELIVERY_LOG_RETENTION_DAYS`	Days to retain delivery logs (0 = indefinite)
`signature_header`	`"X-Webhook-Signature"`	`ORI_WEBHOOK__SIGNATURE_HEADER`	HMAC signature header name
`event_type_header`	`"X-Webhook-Event-Type"`	`ORI_WEBHOOK__EVENT_TYPE_HEADER`	Event type header name
`event_id_header`	`"X-Webhook-Event-ID"`	`ORI_WEBHOOK__EVENT_ID_HEADER`	Event ID header name
`timestamp_header`	`"X-Webhook-Timestamp"`	`ORI_WEBHOOK__TIMESTAMP_HEADER`	Delivery timestamp header name

Module Factory Methods

Method	Description
`WebhookModule.configure(config)`	Configure with explicit WebhookConfig (defaults apply when omitted)

Key Features

Subscription CRUD — Create, list, update, deactivate webhook subscriptions
Secret rotation — Automatic secret generation with grace period for rotation
Fan-out delivery — Concurrently delivers events to all matching active subscriptions
Exponential backoff retry — Configurable retry attempts with exponential delay
Dead-letter queue — Failed deliveries after max attempts are preserved for inspection
Auto-disable — Subscriptions automatically deactivated after consecutive failures
HMAC-SHA256 signing — sha256=hex_digest format, compatible with Stripe/GitHub
Timing-attack prevention — Uses compare_digest for constant-time signature verification
Event bus bridge — Forward domain events as webhook events to external consumers
Admin panel integration — WebhookAdminContributor for subscriptions, deliveries, DLQ

Testing

async with Application.boot(modules=[WebhookModule.configure()]) as app:
    # your test code
    ...

Key Source Files

File	What it contains
`src/oridecon/webhook/module.py`	`WebhookModule` class with factory methods
`src/oridecon/webhook/di/bundle_provider.py`	`WebhookBundleProvider` — wires webhook protocols into DI container
`src/oridecon/webhook/config.py`	`WebhookConfig` dataclass
`src/oridecon/webhook/subscription/service.py`	`WebhookSubscriptionService` — subscription CRUD with secret rotation
`src/oridecon/webhook/delivery/service.py`	`WebhookDeliveryService` — fan-out, retry, auto-disable
`src/oridecon/webhook/delivery/sender.py`	`WebhookSender` — single HTTP delivery attempt
`src/oridecon/webhook/delivery/dead_letter.py`	`DeadLetterManager` — DLQ inspection and re-queue
`src/oridecon/webhook/verification/hmac.py`	`HMACSignatureVerifier` — constant-time signature verification
`src/oridecon/webhook/bridge/event_bus.py`	`EventBusWebhookBridge` — domain event → webhook forward