Integration
Versioning and Changelog
Track public integration changes, compatibility expectations, and docs updates.
Versioning policy
The public integration docs describe the current CAIRL hosted verification beta. During beta, CAIRL treats the OAuth authorization flow, token exchange, userinfo claim response, and webhook event names as compatibility-sensitive surfaces.
Expected change types:
| Change type | Compatibility expectation |
|---|---|
| New claim | Additive; existing scopes continue to work |
| New webhook event | Additive; consumers should ignore unknown event types |
| New optional field | Additive; consumers should ignore unknown fields |
| Required request field | Breaking; announced before rollout |
| Response field removal or rename | Breaking; announced before rollout |
Webhook consumers should validate required fields and ignore unknown fields so additive releases do not break production integrations.
Current public surface
| Area | Current docs |
|---|---|
| Hosted verification | Verification sessions |
| OAuth provider | OAuth and OIDC guide |
| Token exchange | Quickstart |
| Webhooks | Webhooks |
| Claims | Claims |
| Shopify apps | Shopify app integration |
Changelog
2026-06-03
- Added Python quickstart snippets for PKCE, token exchange, and userinfo claim retrieval.
- Added a docs-backed homepage sample request for the OAuth token and userinfo endpoints.
- Added Shopify app integration guidance.
- Added the OAuth and OIDC guide.
- Added public integration versioning and changelog guidance.
- Added per-page "Edit on GitHub" links to the docs site.