Versioning

Tixstock uses major versioning strategy and works from the premise of not introducing breaking changes and maintaining backwards compatibility for as long as possible. For example, Tixstock strives to only add new optional parameters and avoid unnecessary or breaking changes to existing endpoints, thus reducing the need for new versions of the API.

The benefit of this approach allows Partners to remain on the latest/current version of the API and reduces maintenance overhead, while providing Tixstock with significant scope to change the API, if needed in the future.

Path Versioning

The API version is specified at the start of URL before each endpoint i.e. https://sandbox-pf.tixstock.com/v1/feed.

Webhook Versioning

Tixstock-Version header is set as part of the Webhook Headers, which outlines the version of the Webhook being sent. By default, all webhooks are set to v1. However, you change the version for each webhook via the API Partner Area. This will allow you to set the version for each Webhook to the required version. In most cases this will mirror the API version, which results in the same resources.

Example Webhook Header

{
"Content-Type": "application/json",
"Content-Length": "3030",
"X-Original-URL": "/webhook-handler/ticket-create",
"Tixstock-Version": "v1",
"X-Tixstock-Signature": "ff6fa54da7066fb609a067e2e5e82cf21af494138.....",
"User-Agent": "Tixstock API",
"Host": "example.com"
}

---