Mock Endpoints¶

4 endpoints for creating, serving, inspecting, and deleting HTTP mocks.

Python SDK Examples¶

Create a basic mock¶

from toolkitapi import Webhook

with Webhook(api_key="tk_...") as wh:
    created = wh.create_mock(
        name="payments-accepted",
        status_code=202,
        content_type="application/json",
        body='{"accepted": true}',
        ttl_seconds=3600,
    )

mock_id = created["mock"]["mock_id"]
endpoint = created["mock"]["endpoint_url"]
print(mock_id)
print(f"https://webhook.toolkitapi.io{endpoint}")

Create a mock with custom headers and delay¶

from toolkitapi import Webhook

with Webhook(api_key="tk_...") as wh:
    created = wh.create_mock(
        status_code=429,
        headers={
            "Retry-After": "120",
            "X-RateLimit-Policy": "test",
        },
        body='{"error":"rate_limited"}',
        content_type="application/json",
        delay_ms=800,
    )

print(created["mock"]["endpoint_url"])

Hit a mock endpoint¶

The serving URL is public and accepts any HTTP method.

curl -i -X POST "https://webhook.toolkitapi.io/v1/mock/{mock_id}" \
  -H "Content-Type: application/json" \
  -d '{"hello":"world"}'

Inspect mock metadata and usage¶

from toolkitapi import Webhook

with Webhook(api_key="tk_...") as wh:
    info = wh.get_mock("<mock_id>")

mock = info["mock"]
print(mock["status_code"], mock["content_type"])
print(mock["hit_count"])
print(mock["expires_at"])

Delete a mock¶

from toolkitapi import Webhook

with Webhook(api_key="tk_...") as wh:
    result = wh.delete_mock("<mock_id>")

print(result["message"])

Request Parameters¶

POST /v1/mocks¶

Response Fields¶

Mock metadata¶

Behavior Notes¶