Required Parameters
These parameters are mandatory for a successful launch. Applies to: All integrations.
| Parameter | Type | Description |
| userId | string | Unique identifier of your user. Nothing is verified without it, and a value shorter than 2 characters posts error_occurred (severity: "critical", "User ID is missing: ..."). Used for progress, analytics and personalization |
| company | string | Your company name. Compared in lowercase. The value as you sent it is the default themeName |
| key | string | Your API key, sent as the x-api-key header of the verify call. Required unless you send session |
| session | string | A short-lived session id created by your backend with your API key (Sessions API), sent as the x-session-id header. Send it instead of key so the key never ships inside your app. When both are present, session is used. On session launches the backend's subscription status overrides isSubscribed |
Replies: kinestex_launched when the launch is verified, or error_occurred (severity: "critical", "Cannot verify: ...") when it is not.
SDK Support:
- Swift, Kotlin, Flutter:
apiKey,companyNameanduserIdare arguments of the SDK setup. For session auth, leave outapiKeyand pass"session"incustomParamsof the create call. - React Native:
data.keyordata.session, plusdata.companyanddata.userId. - React (`kinestex-sdk-react-ts`):
key,companyanduserIdare required. This SDK has no session field. - HTML/JS: top-level keys of the launch object.
Required Parameters Setup
Swift example:
1// API key
2let kinestex = KinesteXAIKit(
3 apiKey: "YOUR_API_KEY",
4 companyName: "YOUR_COMPANY",
5 userId: "unique-user-id"
6)
7
8// Session auth: leave out apiKey and pass the session in customParams of the create call,
9// e.g. customParams: ["session": sessionId]
10let kinestexWithSession = KinesteXAIKit(
11 companyName: "YOUR_COMPANY",
12 userId: "unique-user-id"
13)