OpenAPI 3 spec

The full machine-readable spec is at /openapi.yaml. Drop it into Swagger UI, Stoplight, or your preferred client generator.

Pinning versions

The path prefix is /v1. We follow semver-ish: backwards-incompatible changes get a new prefix (/v2); additive changes ship without notice. Removed fields are deprecated for at least 90 days before removal.

Generated clients

From this spec you can generate clients in any language with openapi-generator or similar. Note: the auto-generated client probably won't include HMAC verification for inbound webhooks — use the language samples in signature verification.

Quick links