Track Events Emitted By Nobi

Tracking Events From Nobi

Overview

1. Window Events - Custom events dispatched to window for merchant capture

2. Shopify Analytics - Native Shopify analytics events (for Shopify stores)

Emitted events

1. Generic nobi-analytics event - This fires for all Nobi events and contains the specific event name in the detail.event property

2. Specific event - Like nobi-search, etc.

• nobi-analytics with detail: { event: "Search", data: {...} }

• nobi-search with detail: { event: "Search", data: {...} }

• nobi-analytics with detail: { event: "Product Added To Cart", data: {...} }

• nobi-search: { event: "Search", data: {...} }

1. Listen to everything: addEventListener('nobi-analytics', ...)

2. Listen to specific events: addEventListener('nobi-search', ...)

Capturing Events

Window Event Listeners

// Listen to all Nobi events
window.addEventListener('nobi-analytics', function(event) {
    const { event: eventName, data, timestamp, source } = event.detail;

    // Send to your analytics platform
    analytics.track(eventName, {
        ...data,
        timestamp,
        source
    });
});

// Listen to specific event types
window.addEventListener('nobi-search', function(event) {
    console.log('User performed a search:', event.detail);
});

Event Structure

{
    detail: {
        event: "Search",                    // Event name
        data: {                            // Event-specific data
            query: "red sweater",
            searchEngine: "Nobi",
            // ... other properties
        },
        timestamp: "2024-01-15T10:30:00Z", // ISO timestamp
        source: "nobi"                     // Always "nobi"
    }
}

Event Reference

Search Events

// Example
{
    event: "Search",
    data: {
        query: "red sweater",
        searchEngine: "Nobi",
        conversationId: "conv_123",
        entryPoint: "SearchBar",
        shopperId: "shopper_456",
        isMobile: false,
        pageUrl: "https://store.com/search"
    }
}

User Interface Events

Chat and Conversation Events

Product Collection Events

Recommendation Events

Custom Instruction Events

Common Event Properties

• conversationId (string, optional) - Associated conversation ID

• entryPoint (string) - How user accessed Nobi ("SearchBar", "Cart", "PDP")

• shopperId (string) - Unique shopper identifier (persisted in localStorage)

• isMobile (boolean) - Whether user is on mobile device

• pageUrl (string) - Current page URL

• timestamp (string) - ISO timestamp when event occurred

• source (string) - Always "nobi"

Merchant Information

• Nobi Merchant Name (string) - Your store name in Nobi

Implementation Examples

Google Analytics 4

// Track all Nobi events in GA4
window.addEventListener('nobi-analytics', function(event) {
    const { event: eventName, data } = event.detail;

    gtag('event', eventName.toLowerCase().replace(/\s+/g, '_'), {
        event_category: 'nobi',
        ...data
    });
});

Segment

// Track Nobi events with Segment
window.addEventListener('nobi-analytics', function(event) {
    const { event: eventName, data } = event.detail;

    analytics.track(eventName, {
        ...data,
        source: 'nobi'
    });
});

Custom Analytics

// Send to your custom analytics endpoint
window.addEventListener('nobi-analytics', function(event) {
    const { event: eventName, data, timestamp } = event.detail;

    fetch('/api/analytics/track', {
        method: 'POST',
        headers: {
            'Content-Type': 'application/json',
        },
        body: JSON.stringify({
            event: eventName,
            properties: data,
            timestamp: timestamp,
            source: 'nobi'
        })
    });
});

Shopify Analytics Integration

• Shopify Admin Analytics

• Shopify Scripts

• Shopify Flow

• Third-party apps that use Shopify's Web Pixels API

Shopify Event Names

• Custom Nobi events (non-Shopify native events)

• All events except: product_added_to_cart, product_viewed, search_submitted, product_removed_from_cart, checkout_completed (these are native Shopify events)

Privacy and Data Handling

User Privacy

• Events include a unique shopperId that persists across sessions but doesn't contain PII

• No email addresses, names, or other personal information are included in events

• IP addresses are not included in event data

GDPR Compliance

• The shopperId can be reset by clearing localStorage

• All event data is aggregated and anonymized in Nobi's systems

• Merchants are responsible for obtaining appropriate consent for their own analytics tracking

Data Retention

• Window events are ephemeral and only exist in the browser session

• Merchants control retention of captured event data in their own systems

• Nobi retains aggregated analytics data according to our privacy policy

Troubleshooting

Events Not Firing

1. Check browser console for JavaScript errors

2. Verify Nobi is properly initialized on your site

3. Test with the browser's developer tools:

// Check if events are being dispatched
window.addEventListener('nobi-analytics', function(event) {
    console.log('Nobi Event:', event.detail);
});

Missing Event Data

• Some properties are only available in certain contexts (e.g., conversationId only exists during chat sessions)

• Shopify-specific data (like product IDs) only exists on Shopify stores

• Mobile detection may vary based on device and browser

Event Timing

• Events are dispatched synchronously when actions occur

• Network delays may affect when your analytics platform receives the data

• Some events (like Checkout Completed) may fire with a slight delay due to Shopify's event timing