Documentation
API versioning
Dated versions mean your integration keeps working while the API improves.
The version header
The API is versioned by date. Send Veyra-Version on every request to pin the behaviour your code was written against. Without the header, the version pinned to your account at creation is used.
Veyra-Version: 2026-10-01The current and only version is 2026-10-01.
What counts as compatible
| Change | Released without a new version? |
|---|---|
| Adding a new endpoint or resource | Yes |
| Adding an optional request parameter | Yes |
| Adding a field to a response or event | Yes — ignore fields you do not know |
| Adding a new event type or error code | Yes |
| Removing or renaming a field | No — new dated version |
| Changing a field's type or meaning | No — new dated version |
| Changing a state machine transition | No — new dated version |
Webhooks and versions
Each webhook endpoint has its own version, set when you create it. Events are rendered in that version, so you can upgrade the API and the webhooks independently.