Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.helpalive.com/llms.txt

Use this file to discover all available pages before exploring further.

The HelpAlive SDK is a small browser script that does three things: auto-captures user behavior, ties activity to real users and workspaces, and feeds the AI Agent fresh page context whenever a user opens it. One script tag, one identify() call, and you’re done.

​
At a glance

Where it runsIn your users’ browsers, alongside your product
Effect on your pageNone — loads in the background, doesn’t slow your site
What you installOne script tag, or a single Google Tag Manager tag
What you writeOne identify() call after login — nothing else
Browser supportModern browsers (Chrome, Edge, Firefox, Safari)

​
What the SDK does

Autocapture

Clicks, pageviews, form submits, rage clicks, DOM errors — captured automatically with no tagging.

Identity

identify() ties events to a stable user and workspace so analytics and Agent personalization are accurate.

Agent context

Feeds the in-app AI Agent fresh page context — what the user just clicked, where they got stuck — so it answers like someone who’s actually watching.

​
What’s auto-captured

The SDK observes user behavior automatically — you don’t write tracking code or maintain a tag plan. Every captured event is anonymized before transmission.
EventWhat we capture
pageviewPage loads, including in-app navigations (single-page apps work out of the box).
clickClicks on buttons, links, and other interactive elements. Element identifiers are anonymized; text content is redacted.
form_startThe user begins filling out a form. Useful for abandonment analysis.
form_submitThe user submits a form. (We never capture the field values.)
rage_clickRepeated clicks on the same element — a strong frustration signal.
scroll_depthHow far a user scrolled on each page.
dom_errorJavaScript errors and console errors that occurred while the user was interacting.
exposureA summary of which interactive elements were visible on the page. Helps the Agent know what’s on screen when a user asks a question.

​
What’s not captured

  • Keystrokes. The SDK never logs what users type into inputs.
  • Form values. Submit events fire; the values inside are never transmitted.
  • Password fields. Always excluded.
  • Personal data like emails, phone numbers, and national IDs. Removed in the browser before anything is sent, and again on our servers before anything is stored.
See Privacy & redaction for the complete data model.

​
The two calls you need to make

The SDK exposes a small surface on window.HelpAlive. The only methods you’ll typically call yourself are:

​
HelpAlive.identify({ ... }) — required after login

Tells HelpAlive who the user is and which workspace they belong to. Without it, the SDK buffers events but nothing is sent. 
HelpAlive.identify({
  userId:   user.id,           // required
  tenantId: tenant.id,         // required (use "default" if no workspaces)
  email:    user.email,
  plan:     user.plan
});
See Identify for the full field reference. Pauses or resumes tracking based on the user’s consent state. 
HelpAlive.setConsent({ analytics: true, chat: true });
See Consent for the full setup. That’s it for the public surface most apps need. Everything else — buffering, flushing, real-time mode while the Agent is open, page-context handoff to the chatbot — happens automatically inside the SDK.

​
Anonymous activity is dropped

Until you call identify(), the SDK doesn’t send anything to our servers. If the user never logs in, the activity is forgotten when they leave the page. This keeps unauthenticated traffic out of your analytics, and keeps anonymous browsing out of HelpAlive entirely.

​
Next steps

Identify users

The required call after authentication.

Configure consent

Pause tracking until your consent banner returns a decision.

Set up the Agent

Train the AI assistant on your docs.

Privacy posture

What we capture, what we don’t, where redaction happens.