railhook
Python SDK for Railhook.
pip install railhook
Before 2.12.0 this package was webhook-platform, imported as hookflow. That package gets no
more updates.
Send an event
import os
from railhook import Railhook, Event
client = Railhook(
api_key=os.environ["RAILHOOK_API_KEY"],
base_url="https://railhook.io", # default http://localhost:8080
)
event = client.events.send(
Event(type="order.completed", data={"order_id": "ord_123", "amount": 99.99}),
idempotency_key="order-123-completed", # optional
)
print(event.event_id, event.deliveries_created)
Verify a webhook
The signature covers the raw body, so verify the bytes as received.
import os
from flask import Flask, request
from railhook import construct_event, RailhookError
app = Flask(__name__)
@app.route("/webhooks", methods=["POST"])
def webhook():
try:
event = construct_event(
request.get_data(as_text=True), dict(request.headers), os.environ["WEBHOOK_SECRET"]
)
except RailhookError:
return "Invalid signature", 400
print(event.event_id, event.data)
return "OK", 200
verify_standard_webhook checks the webhook-* headers instead. During a secret rotation
either secret's signature is accepted.
The client also covers endpoints, subscriptions, deliveries, consumers and portal sessions, and incoming sources and events. It does not retry: one call is one HTTP request.
Full docs: https://railhook.io/docs/tools/sdks/
Develop
pip install -e ".[dev]"
pytest
python scripts/live_api_smoke.py # against a running stack (make up)
License
MIT
1 maintainer
Metadata
1 maintainer
Release files for railhook 3.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| railhook-3.6.0.tar.gz | 28.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| railhook-3.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 61.7 kB
Release files / railhook-3.6.0.tar.gz
| Download URL | railhook-3.6.0.tar.gz |
|---|---|
| Size | 28.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a250f6b97edf959fd6ad531b62d5d86a0b9cafffe40c05bf7abcfa74b2dbeb94
|
|
BLAKE2b-256 checksum How to use checksums |
5295076cad59b2c141a41a34913334cfa749e09c67ccdfdca40e157d497342a0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.16
|
Release files / railhook-3.6.0-py3-none-any.whl
| Download URL | railhook-3.6.0-py3-none-any.whl |
|---|---|
| Size | 33.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
da0352ea3de83d44020134b27692967c1a63cb74f145c94af44d4b117b74710c
|
|
BLAKE2b-256 checksum How to use checksums |
b4969813df5d83a306327d84f6b1817ca12b94c8d09345e3a7083ba8d8adeae1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.16
|
