# JavaScript live chat SDK & custom visitor data — Orka

Canonical: https://orka.chat/sdk
Updated: 2026-09-21

ORKA JAVASCRIPT SDK 

# Live chat with your user data. 

 The plan they pay for. The feature they are using. The detail that makes the answer obvious.

 Connect the information your product already knows to Orka’s Visitor Data panel. Your team sees it alongside the conversation.

[Connect your data ↓](#connect-data) npm · orka-web-sdk Custom attributes SPAs + Shopify apps 

 Studio Fern merchant@example.com 

 ● Online 

 ▥ Visitor Data ⌄ 

 shop studio-fern.myshopify.com 

 shop_name Studio Fern 

 pricing_type per-usage 

 plan Pro 

 per_usage_plan tier_1000 

 premium Yes 

 has_branding No 

 installed_at 2026-09-18 

 shopify_plan Basic 

 admin_link Open customer record ↗ 

 onboarding Calendar connected 

 ＋ Your next useful field Any relevant value 

 Fictional merchant, email and account values. Your app sends the fields you choose.

 YOUR PRODUCT. YOUR CONTEXT. 

## Not a fixed checklist. The fields your team actually needs.

### Shopify apps

 Shop domain, Shopify plan, app plan, billing type, installation date, branding setting and a link to your internal admin.

### SaaS & vibe-coded apps

 Workspace name, subscription, usage tier, onboarding step, enabled features and the screen where someone needs a hand.

### Mobile & subscription products

 App version, platform, language, plan and the state of a feature. Enough context to understand the issue before asking another question.

 You choose the keys and supply the values. An internal record link can save a lookup; a plan or installation date can change how you explain the next step. These are examples, not a limit on what you can model.

 SEND THE CONTEXT. KEEP THE CONVERSATION. 

## A few fields. A much warmer hello.

 01 

### Install your project’s widget

 Copy its snippet from Settings → your project → Installation, or use the npm package in your web app.

 02 

### Map the useful attributes

 Take account values from your own trusted app state. Pass them with the SDK instead of asking the customer to type them again.

 03 

### Keep them up to date

 Refresh the context when the account, plan or relevant screen changes. Check Visitor Data with a test account.

 BROWSER SDK · EXAMPLE ATTRIBUTES Copy example 

```html
// After your Orka widget has loaded.
window.Orka.update({
 name: "Alex Morgan",
 email: "alex@example.com",
 shop_name: "Studio Fern",
 plan: "Pro",
 shopify_plan: "Basic",
 installed_at: "2026-09-18",
 pricing_type: "per-usage",
 per_usage_plan: "tier_1000",
 premium: "Yes",
 onboarding: "Calendar connected"
});
```

 The fields are fictional examples. Keep passwords, API keys and payment credentials out of visitor attributes. Browser-supplied data is support context, not authorization for privileged actions.

 A SMALL API. A LOT OF POSSIBILITIES. 

## Put support where it belongs.

 update(data) Refresh user and session attributes.

 show() / hide() Connect your own Help button to the widget.

 toggle() Open or close chat from a custom entry point.

 reset() Close chat and refresh page title/URL context.

 destroy() Remove the widget instance when appropriate.

 ORKA_SESSION Provide initial session data before the script loads.

 Wait for the browser widget API before calling its methods. The npm wrapper can queue update data before the widget is ready. The [SPA guide](/how-to-add-orka-to-single-page-application) covers initialization and navigation.

 YOUR BEARINGS, BEFORE YOU DIVE IN 

## Your SDK questions. With real answers.

 Still wondering about something? [Ask a human at Orka ↗](mailto:hello@orka.chat)

 Does Orka have a JavaScript SDK? + Yes. Orka provides the orka-web-sdk npm package and a browser API through window.Orka. Use them to initialize the widget, update visitor data, open or hide chat and connect support to your product.

 Which custom visitor attributes can I send? + Choose the support-relevant key-value fields your app knows: a plan, installation date, usage tier, account role, language, feature state or internal record link. You are not restricted to the example fields on this page. Check how your chosen values render in Visitor Data.

 Is visitor data imported automatically from Shopify? + Your integration supplies it. The SDK does not grant Shopify API access or determine a subscription on its own. Read account data through your app’s existing authenticated flow, then pass the fields that help your team.

 Can I change the data after the user upgrades? + Yes. Call update with fresh values after a plan change or other relevant event. Initial ORKA_SESSION data belongs before the widget script; update is the way to provide later changes.

 Can a non-developer connect visitor data with AI? + An AI coding assistant can help locate the account data and add the integration. Give it the official docs and the field names you want. Someone should still review the data mapping and test account changes before publishing.

 Does reset securely sign a visitor out? + The documented reset method closes chat and refreshes the current page title and URL. Do not treat that as a guaranteed identity wipe. Design and test your account-switching and logout flow separately.

 Is this a native iOS or Android SDK? + The package described here is a JavaScript web SDK. It works with your website or web app. A web-based support view inside a mobile app needs its own integration and testing; Orka’s mobile operator apps are a separate way for your team to answer.

 Your question for Orka ↗ 

 Ask Orky · AI answers from our website, with sources. Your question is sent to OpenAI; please leave out personal information. [Privacy](/privacy) 

 [Email your question ↗](mailto:hello@orka.chat) 

 STRAIGHT FROM THE DOCUMENTATION 

## The details, when you need them.

 Checked in September 2026. Questions or corrections? [hello@orka.chat](mailto:hello@orka.chat).

 [Official Orka SDK and SPA documentation ↗](https://penida.gitbook.io/orka-livechat/how-to-add-orka-.../how-to-add-orka-on-your-single-page-application-spa) [Orka integration for Shopify apps ↗](https://penida.gitbook.io/orka-livechat/how-to-add-orka-.../how-to-add-orka-on-your-shopify-app) [Published orka-web-sdk package ↗](https://www.npmjs.com/package/orka-web-sdk) 

## More context. A better first answer.

 One inbox for every app, store and idea you run.

[Start with Orka ↗](http://dashboard.orka.chat/signup)