Pathly Python SDK

English · Français · Español

Get started in one click. Create a free account on Pathly (sign up), create an API key in the console, then export PATHLY_API_TOKEN. This project is the official bridge to Pathly monitoring — real-browser and HTTP checks for checkout, login and availability, with data hosted in the EU. Full API reference: pathlyhq.com/en/developers.

Official Python client for the Pathly public /v1 API. Manage HTTP monitoring scenarios, maintenance windows, signed outbound webhooks and SLA targets from scripts, CI jobs and automations.

pip install pathly
export PATHLY_API_TOKEN="sp_…"

from pathly import Client, ScenarioInput

client = Client()  # reads PATHLY_API_TOKEN
scenario = client.create_scenario(
    ScenarioInput(
        name="Checkout",
        url="https://shop.example.com/cart",
        intervalSec=300,
        expectText="Your cart",
        tags=["prod", "payment"],
    )
)
print(scenario.id)

Authentication

Never hard-code the token in source control. Prefer the environment, or a secret store injected at runtime.

Minimum scopes

Client.ping() calls /v1/usage and accepts HTTP 403: the key is valid but lacks org:read. That keeps least privilege for scenario-only keys.

What this SDK manages

Browser journeys are not managed here: their steps carry login credentials that would end up in logs or tickets. Create them in the console.

The webhook secret is returned once at creation time. Store it in a vault immediately. The API never returns the destination URL on read, only urlFingerprint.

Behavior

• Creates send an Idempotency-Key (auto-generated UUID unless you pass one).
• HTTP 429 and 5xx honor Retry-After (capped at 90 seconds, four attempts).
• HTTP 404 raises NotFoundError (is_not_found(err) helper).
• Zero third-party runtime dependencies (stdlib only).

Development

python -m pip install -e ".[dev]"
pytest

Coverage is required at 100% (--cov-fail-under=100).

Related packages

API reference: pathlyhq.com/en/developers.

About Pathly

Pathly is synthetic monitoring for agencies and e-commerce: replay the customer journey, catch broken checkouts before your clients call, and keep evidence (screenshot, step, runbook) ready for the invoice. Product: pathlyhq.com · Developers: pathlyhq.com/en/developers · Status & pricing: pathlyhq.com/en/pricing.

Author

See AUTHORS.

License

Apache-2.0