Request Bins¶

7 endpoints for request capture, inspection, and replay.

Python SDK Examples¶

Create a request bin¶

from toolkitapi import Webhook

with Webhook(api_key="tk_...") as wh:
    created = wh.create_bin(
        name="payment-webhooks",
        ttl_seconds=7200,
    )

bin_id = created["bin"]["bin_id"]
catch_path = created["bin"]["catch_url"]
print(bin_id)
print(f"https://webhook.toolkitapi.io{catch_path}")

Capture traffic in the bin¶

The catch endpoint is public and can receive any HTTP method.

curl -X POST "https://webhook.toolkitapi.io/v1/catch/{bin_id}?event=invoice.paid" \
  -H "Content-Type: application/json" \
  -H "X-Provider-Signature: test-signature" \
  -d '{"id":"evt_123","type":"invoice.paid"}'

List captured requests¶

from toolkitapi import Webhook

with Webhook(api_key="tk_...") as wh:
    requests = wh.list_bin_requests("<bin_id>", limit=50, offset=0)

print(requests["total"])
for req in requests["requests"]:
    print(req["request_id"], req["method"], req["path"], req["timestamp"])

Inspect one captured request¶

from toolkitapi import Webhook

with Webhook(api_key="tk_...") as wh:
    detail = wh.get_bin_request("<bin_id>", "<request_id>")

req = detail["request"]
print(req["method"], req["path"])
print(req["query_string"])
print(req["headers"].get("content-type"))
print(req["body"])

Replay a captured request to a target URL¶

from toolkitapi import Webhook

with Webhook(api_key="tk_...") as wh:
    replay = wh.replay_bin_request(
        "<bin_id>",
        "<request_id>",
        target_url="https://httpbin.org/anything",
    )

print(replay["response_status"])
print(replay["elapsed_ms"])

Delete a bin when done¶

from toolkitapi import Webhook

with Webhook(api_key="tk_...") as wh:
    result = wh.delete_bin("<bin_id>")

print(result["message"])

Request Parameters¶

POST /v1/bins¶

GET /v1/bins/{bin_id}/requests¶

POST /v1/bins/{bin_id}/requests/{request_id}/replay¶

Response Fields¶

Bin metadata¶

Captured request summary¶

Captured request detail¶

Replay response¶