Versioning
The API uses date-based versions. Pin a version for stable integrations and migrate at your own pace.
The Wajub API is versioned by date. Your account is pinned to the active version at the time of creation; breaking changes ship under a new date without breaking your existing integration.
Specifying a version
Pass the X-Wajub-Version header. Without a header, your account's default version applies.
Authorization: pk.xxxx
X-Wajub-Version: 2026-08-01What constitutes a breaking change
Breaking (new version)breakingoptionalField removal, renaming, type change, new validation constraint, status change.
Compatible (no new version)additiveoptionalAddition of an optional field, endpoint, webhook event type, enum value.
Write tolerant parsers
Treat additions as normal: ignore unknown fields and don't crash on a new enum value. This is key to absorbing additive changes without redeploying.
Migrating
- Read the new version's notes in the Changelog.
- Test with
X-Wajub-Versionpointing to the new date in the test environment. - Once validated, update your account's default version in the Dashboard.
The current version is always shown at the top of the Changelog.