Tracking events

The SiteGPT widget sends JavaScript events to your page when a visitor uses the chat. Use them to measure chat activity and conversions in Google Tag Manager, Google Analytics 4 (GA4), or any other analytics tool. You do not change any setting in SiteGPT. The events work with every install that uses the widget script, including the WordPress plugin. They do not work with the iframe embed or the hosted chat link, because those do not run the widget script on your page. See Add SiteGPT to your website.

Your analytics code never goes inside the SiteGPT widget. The widget script runs on your own page, next to your GTM or GA4 code. The widget script sends each event to your dataLayer, to a window event, and to any $sitegpt callback.

Events

Event	Fires when	Payload
`chat_opened`	The floating chat window opens	`chatbotId`
`chat_closed`	The floating chat window closes	`chatbotId`
`conversation_started`	The visitor sends the first message in a conversation	`chatbotId`, `threadId`
`message_sent`	The visitor sends any message	`chatbotId`, `threadId`
`lead_submitted`	The visitor submits the lead form	`chatbotId`, `threadId`
`human_handover`	The conversation is escalated to your team	`chatbotId`, `threadId`
`booking_link_clicked`	The visitor clicks a scheduling link in a reply, for example a Calendly, Cal.com, HubSpot Meetings, Google Calendar appointment, or Microsoft Bookings link	`chatbotId`, `threadId`, `url` (the provider address only, for example `https://calendly.com`)

threadId is the ID of the conversation.

Payloads contain no personal data: no name, email, phone number, or message text. This makes them safe to send to GA4, which does not allow personal data. Lead details stay in your SiteGPT dashboard.

Delivery channels

SiteGPT sends every event in three ways at the same time:

Channel	Name	Payload
`dataLayer` push (for GTM)	`sitegpt_<event>`, for example `sitegpt_chat_opened`	Fields added to the same object
`window` `CustomEvent`	`sitegpt:<event>`, for example `sitegpt:chat_opened`	`event.detail`
SDK callback	`window.$sitegpt.push(['on', '<event>', fn])`	The first argument of `fn`

Examples

Google Tag Manager
GA4 (gtag.js)
Custom JavaScript

Each event is pushed to window.dataLayer with the event name sitegpt_<event>. The payload fields are on the same object:

{
  event: 'sitegpt_lead_submitted',
  chatbotId: 'YOUR_CHATBOT_ID',
  threadId: 'YOUR_CONVERSATION_ID'
}

To use an event in GTM:

Add a Custom Event trigger. Set Event name to the event, for example sitegpt_lead_submitted. To catch all SiteGPT events in one trigger, use sitegpt_.* and turn on Use regex matching.
Optional: add Data Layer Variables named chatbotId, threadId, or url.
Attach a tag, for example a GA4 Event tag, to the trigger.

The widget creates window.dataLayer if it does not exist. The events work even if GTM loads after the widget.

If you use the GA4 gtag.js snippet without GTM, listen for the window events and forward them to GA4. Add this code once, after your gtag snippet:

<script>
  [
    'chat_opened',
    'chat_closed',
    'conversation_started',
    'message_sent',
    'lead_submitted',
    'human_handover',
    'booking_link_clicked',
  ].forEach(function (name) {
    window.addEventListener('sitegpt:' + name, function (e) {
      gtag('event', 'sitegpt_' + name, e.detail);
    });
  });
</script>

The events then show in GA4 as sitegpt_conversation_started, sitegpt_lead_submitted, and so on. You can mark the ones you need as key events in GA4.

Add a callback with the widget SDK. Add this code after the install snippet.

window.$sitegpt.push(['on', 'lead_submitted', function (data) {
  console.log('Lead submitted in conversation', data.threadId);
}]);

window.$sitegpt.push(['on', 'booking_link_clicked', function (data) {
  console.log('Booking link clicked:', data.url);
}]);

To stop a callback, pass the same function to off:

function onOpen(data) { /* ... */ }
window.$sitegpt.push(['on', 'chat_opened', onOpen]);
// later
window.$sitegpt.push(['off', 'chat_opened', onOpen]);

You can also use the browser’s own event API:

window.addEventListener('sitegpt:chat_opened', function (e) {
  console.log(e.detail); // { chatbotId: '...' }
});

More than one chatbot on a page

Every payload includes the chatbotId of the chatbot that sent it. In GTM or GA4, filter on the chatbotId variable. In a callback, check data.chatbotId.

Widget SDK

Control the widget from your page.

Webhooks

Receive messages, leads, and escalations on your server.

Get started

Concepts

Add content

Improve answers

Customize the widget

Install

Leads

Human support

Monitor

Integrations

Account and team

Reference

Developers

Help

Events

Delivery channels

Examples

More than one chatbot on a page

Widget SDK

Webhooks

​Events

​Delivery channels

​Examples

​More than one chatbot on a page

​Related

Widget SDK

Webhooks

Events

Delivery channels

Examples

More than one chatbot on a page

Related