Skip to content

Segment Integration ​

Send HoloStep events to Segment and forward them to 300+ analytics and marketing tools from a single integration.

Overview ​

Segment is a customer data platform that acts as a universal data pipeline. Instead of integrating each analytics tool separately, you connect HoloStep to Segment once, then route events to any destination.

Why Use Segment? ​

  • One integration, many destinations - Connect to GA4, Mixpanel, Amplitude, HubSpot, and 300+ more
  • Consistent data - Same event schema across all tools
  • Easy management - Add/remove destinations without code changes
  • Data quality - Built-in validation and transformation

Tracked Events ​

HoloStep EventSegment EventDescription
3D Viewer Open3D Viewer OpenedUser opens 3D viewer
3D Interaction3D Model InteractedUser rotates/zooms
AR Mode OpenAR Mode OpenedUser launches AR
Measurement ToolMeasurement Tool OpenedUser opens measurements
Variant SelectProduct Variant SelectedUser changes variant
Add to CartProduct AddedStandard e-commerce event
PurchaseOrder CompletedStandard e-commerce event

Prerequisites ​

  • A Segment account
  • A JavaScript source created in Segment
  • A HoloStep account with an active subscription

Step 1: Create a JavaScript Source ​

1.1 Add a Source ​

  1. Log in to Segment
  2. Go to Connections → Sources
  3. Click Add Source
  4. Search for JavaScript
  5. Click Add Source

1.2 Get Your Write Key ​

  1. In your new source, go to Settings → API Keys
  2. Copy the Write Key

WARNING

Keep your Write Key secure. While it's designed for client-side use, avoid exposing it unnecessarily.


Step 2: Configure HoloStep Integration ​

2.1 Open Integration Settings ​

  1. Log in to your HoloStep Dashboard
  2. Go to Settings → Integrations
  3. Click Add Integration

2.2 Select Segment ​

  1. Choose Segment from the list
  2. Enter a name (e.g., "Production Segment")

2.3 Enter Your Write Key ​

FieldValue
Write KeyYour Segment source Write Key

2.4 Save and Enable ​

  1. Click Create Integration
  2. Toggle the integration ON

INFO

Segment doesn't have a validation endpoint, so the integration validates the Write Key format only. Events will appear in Segment once you interact with your 3D viewer.


Step 3: Verify in Segment ​

Debugger ​

  1. Go to your JavaScript source in Segment
  2. Click the Debugger tab
  3. Open your website with HoloStep
  4. Interact with a 3D viewer
  5. Events should appear in real-time

Event Structure ​

HoloStep events in Segment look like this:

json
{
  "type": "track",
  "event": "3D Viewer Opened",
  "properties": {
    "scene_id": "12345",
    "scene_name": "Modern Chair",
    "content_name": "Modern Chair",
    "domain": "yourshop.com",
    "session_id": "abc123",
    "holostep_source": "client"
  }
}

Step 4: Add Destinations ​

Once events are flowing to Segment, add destinations:

DestinationUse Case
Google Analytics 4Web analytics
MixpanelProduct analytics
AmplitudeBehavioral analytics
HubSpotCRM & marketing
KlaviyoEmail marketing
IntercomCustomer messaging
BigQueryData warehouse

Adding a Destination ​

  1. Go to Connections → Destinations
  2. Click Add Destination
  3. Search for your tool
  4. Click Configure
  5. Select your JavaScript source
  6. Enter the destination's credentials
  7. Enable the destination

Event Mapping ​

Standard E-commerce Events ​

HoloStep uses Segment's E-commerce Spec:

HoloStepSegment SpecNotes
addToCartProduct AddedIncludes product details
purchaseOrder CompletedIncludes order value
viewItemProduct ViewedProduct page view

Custom Events ​

Other HoloStep events use human-readable names:

HoloStepSegment Event
3dButtonClick3D Viewer Opened
arButtonClickedAR Mode Opened
variantSelectedProduct Variant Selected
configurationSavedConfiguration Saved

Event Properties ​

All events include these properties:

PropertyTypeDescription
holostep_sourcestringAlways "client"
scene_idstringHoloStep scene identifier
scene_namestringProduct/scene name
content_namestringSame as scene_name (Segment standard)
domainstringWebsite domain
urlstringFull page URL
session_idstringHoloStep session ID

E-commerce Properties ​

For cart and purchase events:

PropertyTypeDescription
valuenumberProduct/order value
revenuenumberSame as value (Segment standard)
pricenumberUnit price
currencystringCurrency code (e.g., USD)
product_idstringProduct identifier
namestringProduct name

User Identification ​

HoloStep can identify users in Segment if you pass user information:

javascript
// If you have user data, HoloStep will include it
window.analytics.identify('user-123', {
  email: 'user@example.com',
  name: 'John Doe'
});

INFO

User identification is handled by your existing Segment implementation. HoloStep events will be associated with identified users automatically.


Troubleshooting ​

Events Not Appearing ​

IssueSolution
No events in DebuggerCheck Write Key format (alphanumeric, 10+ chars)
Events blockedAd blockers may block Segment; test in incognito
Integration disabledVerify toggle is ON in HoloStep

Debug Checklist ​

  1. Browser Console: Look for [HoloStep] Segment initialized
  2. Network Tab: Filter for api.segment.io requests
  3. Segment Debugger: Real-time event stream
Events in Debugger but not in Destination

Check that your destination is enabled and properly configured. Some destinations have a delay before events appear.

"Write Key invalid" error

Segment Write Keys are alphanumeric and typically 20+ characters. Make sure there are no extra spaces.