Build on the same rails our apps run on.

Authentication & keys

Workspace owners issue API keys from inside Plunk Studio. There are two kinds; where a key may live is the security model, so it's enforced, not advisory.

# Send the key as a bearer token (or X-Api-Key header)
curl https://api.plunk.io/cx/v1/capabilities \
  -H "Authorization: Bearer pk_live_XXXXXXXXXXXX"

Web tracking & conversions

The tracker is one snippet on your site. Page views, sessions, geography, and campaign attribution are automatic from the moment it loads; conversions and engagements are one call each wherever something worth counting happens. Your workspace ID is in Plunk Studio under Settings → Tracking, along with a copy-exact version of this snippet.

<!-- Paste in your shared footer, just before </body>, so it loads on every page -->
<script>
    var plunkConfig = {
      appId: "YOUR_WORKSPACE_ID",
      accountId: "YOUR_WORKSPACE_ID"
    };
</script>
<script src="https://s3.amazonaws.com/plunk.io/v4/js/plunk.tracker.io.js"></script>

<!-- Optional, for conversions: keep a handle once the tracker is ready -->
<script>
    document.addEventListener('plunk-tracker-ready', function () {
        window.plunkTracker = new Plunk.Tracker(window.plunkConfig);
    });
</script>

Conversions are the moments that matter: an order, a quote request, a signup. value is money and flows into revenue reporting, so set it when the moment has a price and leave it 0 when it doesn't.

// e.g. on your order confirmation page
plunkTracker.sendConversion({
    type: 'order',              // your grouping: order, lead, signup…
    name: 'Order Placed',       // how it reads in reporting
    identifier: 'INV-10442',    // optional: order no, SKU, plan…
    value: 2450.00              // optional: dollars
}, []);

Engagements are the steps on the way: a configure button, a swatch order, a dealer-locator search. They cost nothing to record and they're what makes funnel drop-off visible between page view and conversion.

plunkTracker.sendEngagement({
    type: 'cta',                // your grouping
    action: 'click',
    label: 'request-quote'      // which one, for the breakdown
}, []);

Page URL, session, visitor, and campaign are attached automatically to every call; you only supply what the event means. Events appear in your workspace's Activity reporting within a couple of minutes, which is also the fastest way to verify the install.

Customer API api.plunk.io/cx/v1

Versioned, key-scoped, and self-describing: your integration contract is the capabilities document. It lists exactly the resource families and endpoints your key can reach; new resources appear there as your workspace grows, so code against it rather than a static list.

{
  "tenantType": "retail",
  "families": [
    { "key": "products", "label": "Products",
      "endpoints": ["GET /cx/v1/products/top/{range}"] },
    { "key": "locations", "label": "Showroom",
      "endpoints": ["GET /cx/v1/locations"] }
  ]
}

The full surface covers catalog sync, recommendations, reviews, store and dealer analytics, audiences, contact interest, demand forecasting, and enrichment, and every family announces itself in your capabilities document.

Shopper App APIs share.plunk.io

The COM/COL Visualizer and the Sectional Builder are apps we provide, and they run on a public, key-gated API your own team (or agency) can build against instead. A Visualizer App key from Studio scopes which surfaces it opens, locks website keys to your domains, and attributes every render and captured lead back to your workspace. Part of the Studio Scale plan.

<script src="https://share.plunk.io/embed.js"
        data-key="YOUR_SITE_KEY" data-surface="sectional"></script>

# 1 · Bootstrap: units, materials, options, and your workspace's policy
GET /sb/bootstrap
→ { "brand", "builderMode": "open" | "curated", "units": [...],
    "fabrics": [...], "options": [...], "publishedConfigs": [...] }

# 2 · Render: cache-first; a warmed combination returns instantly
POST /sb/render
{ "units": [ { "sku": "L-2750-52", "gx": 0, "gy": 0 },
             { "sku": "L-2750-53", "gx": 3, "gy": 0 } ],
  "fabricKey": "2001-05",
  "options": { "nailhead": "brass" } }
→ 200 { "status": "ready", "url": "…" }         # cache hit
→ 202 { "status": "rendering", "renderId": "…" } # composing now

# 3 · Poll until the composed hero lands
GET /sb/render/{renderId}
→ { "status": "ready" | "rendering" | "pending_review" | "failed", "url" }

# 4 · Save & share: mints a branded board, captures the lead
POST /sb/save
{ "units": [...], "fabricKey": "2001-05", "title": "Living room L",
  "email": "shopper@example.com" }
→ { "configId", "boardUrl", "totalPrice" }

Integrations

Plunk connects to the systems you already run. No connector fees; everything below ships with the platform.

AI integrations

Plunk ships an MCP server at mcp.plunk.io; connect Claude or any MCP-capable client to your workspace and query products, analytics, and Studio from an AI assistant. Ask us for the connection details for your workspace.