API keys
Create keys in Settings → Developer → API Keys (workspace owners only).
The plaintext secret is shown once when you create a secret key. Store it in a secret manager and never expose it in client bundles.
Publishable keys are safe to use in your frontend with the hosted Whistle iframe and React SDK. They are not a replacement for backend secret keys.
API reference
The API reference tab is generated fromopenapi.json. Try it against a running API:
- Server: your API origin (for example
http://localhost:3001). - Authorization:
Bearer+ your secret key (sk_live_...).
SDK base URL
The Node SDK targets the Whistle SDK mount point by default:https://api.kansato.com/sdk/whistle/v1
Override with baseUrl for local development:
/api/v1/organizations/...; those are documented on the feature pages and in the running server’s OpenAPI/Swagger where exposed.
For browser-side UI integrations, the hosted report form lives on the Whistle web origin and is opened through the React SDK or the plain iframe snippet shown in the dashboard’s developer settings.
Webhooks
In Settings → Developer → Webhooks, register HTTPS endpoints, pick event types, and set a signing secret. Verify deliveries with the Node SDK or manually—see Outbound webhooks.Local OpenAPI UI
With the Whistle server running locally, Swagger UI is typically athttp://localhost:3001/docs (exact path matches your server config).
