OpenAPI 3.1 spec

Roadmap — not yet published. The public REST API is planned (see the API reference), so the OpenAPI document below is not served yet. We'll publish a downloadable openapi.yaml here when the API ships.

When released, the canonical, machine-readable description of the VisitorFlow REST API will be published at a stable URL on this docs site so codegen tools and IDE plugins can pull it directly.

Generating a client (once published)

# TypeScript (axios) using openapi-typescript-codegen
npx openapi-typescript-codegen \
  --input https://visitorflow.com/docs/api/openapi.yaml \
  --output ./src/visitorflow

# Python (httpx) using openapi-python-client
openapi-python-client generate \
  --url https://visitorflow.com/docs/api/openapi.yaml

Versioning

We will bump the spec's info.version field on every release. Additive, backwards-compatible changes will not bump the URL prefix; breaking changes ship as /v2/ with a 12-month overlap.

Looking for narrative documentation? Start with the API reference or the webhooks guide.