Skip to content
Beta — the Waasl API is in private beta. Endpoints marked Coming soon are designed but not live yet. Request early access

Versioning

The major version lives in the path: /v1. Within v1, behaviour is pinned by date.

  • Your workspace is pinned to the API version current when you made your first request.
  • Override per request with the Waasl-Version header, e.g. Waasl-Version: 2026-10-01.
  • Webhook payloads use your pinned version and state it in api_version.

Not breaking (can ship any time): new endpoints, new optional request fields, new response fields, new enum values, new event types, new error codes. Write clients that ignore unknown fields and treat unknown enum values gracefully.

Breaking (only in a new dated version, announced 30 days ahead in the changelog): removing or renaming fields, changing types, changing defaults, new required fields.

During the beta we may still make breaking changes to endpoints marked Beta; we’ll give at least 14 days’ notice by email to every workspace with an active key.