Developers documentation

Mental model

Pathly exposes a versioned public API under https://api.pathlyhq.com/v1. An organisation owns scenarios, runs, incidents, webhooks, maintenance windows and availability targets. Console and API share one configuration truth: what you create here appears there, and the other way around.

Two doors, one stack: business records a Flow in the console; engineering versions Ping, Chain, webhooks and SLAs via IaC or SDK. A Chain is created with `httpChain` on POST /v1/scenarios (login → API hops). Flow secrets must never enter Terraform state or a Git repo.

The OpenAPI contract the platform serves is the source of truth for routes. This page loads it at render: a removed route disappears from the reference below on its own.

5-minute quickstart

Goal: one key, one Ping, one test webhook, one Terraform pointer. About five minutes if the Solo account already exists. A Chain is then created with httpChain (API) or http_chain (provider).

1) Open the Pathly Console (create a free account via the link below) → Settings → API keys → issue a key with scenarios:write and alerting:write. Copy the secret once (sp_ prefix). 2) Export PATHLY_API_TOKEN. 3) Create the scenario (example below). 4) Create a webhook to a test sink (webhook.site or your /hooks). 5) Terraform provider pathlyhq/pathly to version the rest.

• Create a free account → get an API key

export PATHLY_API_TOKEN=sp_…

curl -sS https://api.pathlyhq.com/v1/scenarios \
  -H "Authorization: Bearer $PATHLY_API_TOKEN" | jq .

curl -sS -X POST https://api.pathlyhq.com/v1/scenarios \
  -H "Authorization: Bearer $PATHLY_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: qs-$(date +%Y%m%d)-home" \
  -d '{
    "type": "http",
    "name": "Home",
    "url": "https://www.example.com/",
    "intervalSec": 300,
    "expectedStatus": 200
  }'

curl -sS -X POST https://api.pathlyhq.com/v1/webhooks \
  -H "Authorization: Bearer $PATHLY_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: qs-hook-1" \
  -d '{
    "url": "https://www.example.com/hooks/pathly",
    "events": ["run.failed", "run.recovered"]
  }'

terraform {
  required_providers {
    pathly = { source = "pathlyhq/pathly", version = "~> 0.1" }
  }
}
provider "pathly" {}
# PATHLY_API_TOKEN dans l'environnement CI / shell — jamais dans .tf

Doc pages

To write (SEO backlog)

Page intents not created yet. Flip an entry to status live + sectionIds to publish it.

• Monitoring as code — /developers/monitoring-as-code

  SEO landing “monitoring as code” / Checkly alternative — also planned under /cas-usage/.