Host-page events

The chat widget runs inside a cross-origin iframe, so your page cannot read its state directly. Instead, the embed loader exposes a small API on window.anyreach and emits a stream of events: what the visitor did on your site, what they did with the widget, and what happened in the conversation. Every event carries the same envelope (visitor id, session, page, campaign, device), so a single record is joinable into a funnel without lookups. Events are delivered to your own JavaScript callbacks and, optionally, pushed to a Google Tag Manager data layer. Anyreach also receives a fixed subset of them, cut to a few fields, for the widget’s Analytics page and its experiments’ results: the page views, the widget and conversation events, and cart adds from chat. The journey events (session start and end, time on page, scroll depth), identify traits and your track goals stay in your visitor’s browser. What Anyreach receives lists it exactly, and config({ analytics: false }) stops it.

Quick start

Subscribe before the loader arrives by queueing commands on window.anyreach. The loader replays the queue when it loads, so listeners registered this way see the very first events (session_started, page_viewed, widget_loaded).

<script>
  window.anyreach = window.anyreach || [];
  window.anyreach.push(['on', 'widget_opened', function (event) {
    console.log('opened from', event.page_path, 'after', event.pages_viewed_before_open, 'pages');
  }]);
  window.anyreach.push(['on', 'conversation_ended', function (event) {
    myAnalytics.track('chat_ended', { outcome: event.end_reason, messages: event.message_count });
  }]);
</script>
<script src="https://your-host/public/embed/{widgetId}" async></script>

After the loader has run, window.anyreach is an object and the same calls work directly:

window.anyreach.on('lead_capture_form', handler); // any event name, or '*' for all
window.anyreach.identify('user_123', { plan: 'pro' });
window.anyreach.track('checkout_completed', { value: 129 });

push([...]) keeps working after load, so a snippet written for the queue form never has to care which state the loader is in.

API

Call	What it does
`on(name, fn)`	Subscribe to one event name, or `'*'` for every event. Returns an unsubscribe function.
`off(name, fn)`	Remove a listener.
`identify(userId, traits?)`	Bind the anonymous visitor to your own user id. Sets `external_user_id` on every later event, persists across pages, emits an `identify` event, and passes the id and traits into the widget as conversation context so the agent knows who it is talking to. Pass `null` to clear; that also ends the visitor’s verified identity in the widget. To prove who the visitor is, pass traits your server signed, as in the Shopify example.
`track(name, properties?)`	Record a conversion or any custom event from your page code. Emits a `track` event carrying `name` and `properties`.
`config({ dataLayer, pageEvents, analytics })`	`dataLayer: true` pushes every event to `window.dataLayer` (or pass a string to name a different array). `pageEvents: false` switches off the page and journey events below, and stops Anyreach counting page views. `analytics: false` stops sending anything to Anyreach for analytics; your listeners and data layer are unaffected. Switching either back on reports the current page once; nothing from while it was off is ever sent.
`getContext()`	The current envelope (ids, session, page, campaign, device) without an event, for stitching into your own calls.
`setLocale(locale)`	For a widget with languages on: speak `locale` (a language tag such as `'fr'` or `'fr-CA'`), when the widget supports it, instead of the language it detected. Use it with your site’s own language switcher. Pass `null` to go back to detection.

Google Tag Manager

window.anyreach.push(['config', { dataLayer: true }]);

Each event is pushed as { event: 'anyreach.<name>', anyreach: { ...payload } }. In GTM, create a Custom Event trigger on anyreach.widget_opened (or a regex such as anyreach\..*) and read fields with Data Layer Variables like anyreach.page_path or anyreach.conversation_id.

Envelope

Every event carries these fields. Ids are minted by the loader on your page, in first-party storage, so they survive across pages even in browsers that partition third-party iframe storage.

Field	Meaning
`event`, `event_id`, `timestamp`, `sequence_number`, `schema_version`	Name, unique id, ISO timestamp, per-session ordering counter (sort on this, not on client clocks), and `1`.
`anonymous_id`	Stable per browser. The basis for returning-visitor analysis.
`session_id`	Rolling 30-minute inactivity window.
`external_user_id`	Whatever you passed to `identify()`, or `null`.
`widget_id`, `agent_id`, `conversation_id`	Which widget and agent, and the conversation in progress (`null` outside one).
`experiment_id`, `variant_key`	The widget’s running experiment and the variant this visitor sees, or `null` when none is running.
`locale`	The language the widget speaks to this visitor, on a widget with languages on; `null` otherwise, or until the widget has loaded.
`page_url`, `page_path`, `page_title`, `page_referrer`	The page at the moment the event fired.
`utm_source`, `utm_medium`, `utm_campaign`, `utm_term`, `utm_content`	Captured once at session start and carried on every event in the session, even after the visitor navigates away from the landing page. Only present when the landing URL had them.
`device_type`, `os`, `browser`, `viewport_width`, `viewport_height`, `language`, `timezone`	Coarse device classification from the user agent, plus viewport, `navigator.language` and the IANA timezone.

Events

Page and journey

Emitted by the loader on your page; no widget interaction needed. These give you the denominator for every engagement rate. Turn them off with config({ pageEvents: false }) if your consent setup does not cover page-level tracking; that also stops Anyreach counting page views. Of these, only page_viewed is ever sent to Anyreach, and only as a count.

Event	Extra fields
`session_started`	`is_returning`, `entry_url`
`page_viewed`	`navigation`: `load`, `pushState`, `replaceState` or `popstate`. Single-page apps are handled by hooking the History API.
`page_left`	`time_on_page_ms`, `max_scroll_depth_pct`. Fired when the tab is hidden or the page is unloaded, once per visit to the page.
`session_ended`	`session_duration_ms`, `pages_viewed`, `widget_opened`, `end_reason`. A session can only be known to have ended after the fact, so this fires on the visitor’s next page load once the 30-minute window has lapsed, with the old `session_id`.

Event	Extra fields
`widget_loaded`	`load_time_ms`, `published`
`exposure`	`variant_name`. On every page load while the visitor is in an experiment, so a listener that attaches late still sees it. Count distinct `anonymous_id` per `variant_key` for the denominator of every per-variant rate. Not affected by `config({ pageEvents: false })`.
`widget_opened`	`trigger` (`launcher`, `suggested_question`, `teaser`, `default_open`, or `link_carryover` when it reopens on the page an agent link led to), `seconds_since_page_load`, `seconds_since_session_start`, `pages_viewed_before_open`, `seconds_since_shown` (since the launcher appeared on this page, an in-page navigation counting as a new page), `seconds_since_first_shown` (since it first appeared in the session). Both `seconds_since_*shown` are `null` for opens the widget did on its own (`default_open`, `link_carryover`) or before the launcher appeared.
`widget_closed`	`reason` (`launcher`, `close_button`), `open_duration_ms`, `had_conversation`
`proactive_message_shown`	`kind` (`teaser` or `questions`), `messages`, `count`, `question_keys`, `templates`, `rule`, `display_mode`. Sent when the teaser or the suggested questions beside the closed launcher become visible (after any start delay), and again on each page an in-page navigation leads to. Questions shown one at a time (or one per bubble on a phone) are reported one per event, each as it appears. A page value that fills in later on the same page updates the text without another event. `question_keys` names the named question behind each message (`null` for one-off text); `templates` is each message as configured, before page values are filled in; `rule` is the matching page rule’s name, `null` for the default; `display_mode` is `all_at_once` or `one_at_a_time`.
`proactive_message_clicked`	`kind` (`teaser` or `question`), `message`, `index`, `question_key`, `template`, `rule`
`proactive_message_dismissed`	`kind` (`teaser` or `questions`), `rule`. The visitor closed the bubbles; they stay closed for the rest of the visit.
`quick_action_clicked`	`action_id`, `label`, `action_value`. A button in a starting-message action grid.
`prefill_shown`	`rule`, `template`. A prefilled message appeared in the open chat’s message box: once per conversation for each rule and template, so a page change that only changes the page values does not repeat it. `template` is the message as configured, before page values; `rule` is the page rule’s name, `null` for the default.
`prefill_sent`	`rule`, `template`, `kind` (`as_written`, or `edited` when the visitor changed it first). The visitor sent from the box while it held a prefill. Not sent when they clicked a question or button instead.
`mode_switched`	`from`, `to` (`chat` or `voice`)

Conversation

Event	Extra fields
`conversation_started`	`mode`, `resumed` (true when the visitor picked the conversation back up; the new leg gets its own `conversation_ended`)
`message_sent`, `message_received`	`channel` (`text`, `voice`, `human_relay`), `has_attachments`. Message text is never included.
`first_agent_response`	`latency_ms` from the visitor’s first message to the agent’s first reply. Once per conversation.
`form_shown`, `form_submitted`, `form_abandoned`	`form_kind` (`pre_conversation`, `form`, `collect_otp`, `collect_phone_number`, `collect_image`, `handoff_identity`); the pre-conversation form also carries `form_id` and, on submit, `field_count`. Resending a code or changing method is neither a submit nor an abandonment.
`file_uploaded`	`mime_type`, `size_bytes`
`voice_call_started`, `voice_call_ended`	`duration_ms`, `end_reason` (`mode_switched`, `handoff`, `disconnected`) on end
`handoff_requested`, `handoff_completed`, `handoff_unavailable`, `handoff_ended`	`provider`; `agent_display_name` and `wait_ms` on completed; `duration_ms` on ended
`feedback_submitted`	`form_id`, `field_count`. The answers themselves are not included.
`link_clicked`	`url`. A link the agent sent, clicked inside the transcript. Fires on the click, before the widget’s open-link confirmation.
`conversation_ended`	`end_reason` (`user_ended`, `agent_ended`, `inactivity`, `widget_closed`, `new_conversation`, `switched_conversation`, `disconnected`), `message_count`, `messages_sent`, `messages_received`, `duration_ms`, `last_message_from`
`conversation_abandoned`	`reason`, `last_message_from`. Fired alongside `conversation_ended` when the visitor closes the widget mid-conversation.

Identity

Emitted by the widget when its agent has identity verifiers; the widget turns identity on by itself, there is no widget setting. Neither event carries an identifier (no customer id, email or phone), so both are safe to forward to analytics.

Event	Extra fields
`identity_verified`	`subject_types`, `methods` (string arrays, e.g. `["shopify_customer"]` and `["shopify_login"]`). The widget got an identity token for a visitor who was unverified in this tab, or for a different user than the one it held. Refreshing the token for the same visitor does not fire it again.
`identity_cleared`	None. The widget dropped an identity token it held: after `identify(null)` (in every open tab that held one), when `identify()` names a different user, when a refresh is rejected (for the same user, once the token runs out), or when the visitor clicks Not you? Start a new chat. A refresh that times out or errors keeps the token. Nothing fires when there was no token to drop.

Yours

Event	Extra fields
`identify`	`traits`, without the proof fields `signature`, `ts`, `token`, `jwt` and `hmac`
`track`	`name`, `properties`

Notes

Dedupe on event_id, order on sequence_number. Listeners fire synchronously in the order events happen, but if you forward them to a server, do not trust client clocks for ordering.
What Anyreach receives. Only the subset Widget analytics lists, never message text, displayed question text, form answers, identify traits or your track goals. Conversation data reaches Anyreach through the widget as it always has. Events are delivered only to the origin the loader embedded the widget from; a widget framed some other way emits nothing.
Signed payloads stay out of the stream. The identify event drops signature, ts, token, jwt and hmac from traits, so a signed identity payload never reaches your listeners or dataLayer, where it could be copied and replayed. The widget itself still receives the full traits.
Consent. The page and journey events observe scroll depth, dwell time and URLs. If your consent banner gates that kind of tracking, call config({ pageEvents: false }) until consent is given, or simply do not subscribe. To keep everything from Anyreach until consent, queue config({ analytics: false }) before the loader and switch it on when the visitor agrees; the widget’s Collect analytics setting turns it off for every visitor.
Outcome classification, intent and sentiment are produced server-side after the conversation and are not part of this stream.

Getting Started

Agents

Knowledge Bases

Telephony

Web Widgets

Email

Campaigns

Conversations

Evaluation & Metrics

Agent Assist

Workflows

Organizing Agents & Workflows

Custom Data

Anyreach over MCP

Organizations & Billing

Quick start

API

Google Tag Manager

Envelope

Events

Page and journey

Widget lifecycle

Conversation

Identity

Yours

Notes

​Quick start

​API

​Google Tag Manager

​Envelope

​Events

​Page and journey

​Widget lifecycle

​Conversation

​Identity

​Yours

​Notes

Quick start

API

Google Tag Manager

Envelope

Events

Page and journey

Widget lifecycle

Conversation

Identity

Yours

Notes