outworx-hooks 0.1.0

Lightweight webhook monitoring SDK for Python

Outworx Hooks Python SDK

Lightweight webhook monitoring SDK for Python. Know exactly when your webhooks break, how long they take, and what payload they received.

Features

• 🚀 Zero Latency: Events are batched and sent in a background thread.
• 🛠️ Framework Support: Native integrations for FastAPI, Flask, and Django.
• 🔐 Privacy First: Sensitive headers are automatically redacted.
• 📦 Lightweight: Minimal dependencies, focus on performance.

Installation

pip install outworx-hooks

Quick Start

1. Initialize the SDK

import outworx_hooks

outworx_hooks.init(api_key="your_api_key_here")

2. Framework Integrations

FastAPI

from fastapi import FastAPI
from outworx_hooks.integrations.fastapi import OutworxHooksMiddleware
from outworx_hooks import TrackOptions

app = FastAPI()

app.add_middleware(
    OutworxHooksMiddleware,
    options=TrackOptions(provider="stripe")
)

@app.post("/webhook")
async def handle_webhook():
    return {"status": "ok"}

Flask

from flask import Flask
from outworx_hooks.integrations.flask import with_webhook_monitoring
from outworx_hooks import TrackOptions

app = Flask(__name__)

@app.route("/webhook", methods=["POST"])
@with_webhook_monitoring(TrackOptions(provider="stripe"))
def handle_webhook():
    return {"status": "ok"}

Django

Add the middleware to your MIDDLEWARE setting:

# settings.py
MIDDLEWARE = [
    ...
    'outworx_hooks.integrations.django.OutworxHooksMiddleware',
]

OUTWORX_HOOKS_OPTIONS = {
    'provider': 'stripe',
    'capture_body': True
}

Advanced Configuration

You can pass various options to TrackOptions:

Option	Type	Description
provider	str	Name of the webhook provider (e.g., "stripe", "shopify").
event_type_header	str	Header name to extract the event type from.
event_type_field	str	JSON field name to extract the event type from.
capture_body	bool	Whether to capture the response body (default: False).
capture_headers	bool	Whether to capture request headers (default: True).
metadata	dict	Custom metadata to attach to the event.

License

MIT