v1Changelog

Required Headers

HeaderRequiredDescription
X-Client-IdRequiredYour QwikLive client identifier.
X-Client-SecretRequiredYour client secret. Treat it like a password — never log, embed in URLs, or expose it client-side.
X-PartnerRequiredPartner identifier issued to your organization.
X-Correlation-IdOptionalA client-generated trace id (UUID recommended). Echoed back on the response and useful when raising support tickets.
Keep secrets server-side

Credentials must only ever be sent from your backend over TLS. Do not embed X-Client-Secret in mobile apps, browser code, or query strings. Rotate immediately if a secret is exposed.

Example

Headers
X-Client-Id: your-sandbox-client-id
X-Client-Secret: ****************
X-Partner: QWIKLIVE
X-Correlation-Id: 7c3e1b90-2a44-4c8e-9b1a-0f5d2a6e8c10
Content-Type: application/json

Authentication Errors

StatusMeaning
401Missing or invalid client credentials.
403Credentials are valid but not permitted for this operation or partner.
429Rate limit exceeded — back off and retry after the indicated interval.

All errors use the standard Problem envelope.