public

GET /v1/public/chat/{publicKey}/challenge

The ticket form's Turnstile challenge, as a page to frame (our own chat only).

All public endpoints

All developer docs →

Authentication

This endpoint is public. It takes no credential and no organisation — it is what our own marketing site and AI answer engines read.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/public/chat/{publicKey}/challenge?origin=<origin>

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Anonymous. An HTML page holding one Cloudflare Turnstile challenge. The chat's ticket form frames it and receives the token by postMessage, so one Turnstile widget (listing our own API hostname) serves every site the chat runs on — a widget lists at most 10 hostnames and an account holds at most 20 widgets (Q272). An iframe navigation sends no Origin, so the parent page is named in origin and must be one the widget lists; the response's frame-ancestors is exactly that origin and the token is posted to it alone. 404 for every customer's widget, for an origin the widget does not list, and when no Turnstile site key is configured.

Parameters

NameTypeRequiredWhat it is
publicKey (path)stringYesThe widget's public key. Public by design — it ships in the page source of every site that embeds the widget — so it NAMES a widget and authorises nothing; the Origin header is…
origin (query)stringYesThe framing page's origin, e.g. https://storeflips.com.
locale (query)stringNoThe challenge's language (the visitor's page language).

Errors this endpoint can return

404 · 429