Overview

This guide covers everything you need to integrate Cueflow into your application. Whether you're adding the JavaScript SDK to your frontend or connecting your backend via REST API, you'll find the documentation here.

Integration Options

Cueflow offers two ways to integrate:

Integration	Use Case	Best For
JavaScript SDK	Display messages to users in the browser	Frontend apps, SPAs, websites
REST API	Server-side operations and data sync	Backend services, webhooks, batch operations

JavaScript SDK

The JavaScript SDK displays banners, modals, checklists, feedback surveys, and changelogs directly in your application. It handles:

• User identification

• Message targeting and display

• Event tracking

• SPA navigation detection

Quick start:

<script>
(function(w,d,i){
  w.Cueflow=w.Cueflow||{q:[],
    init:function(u){this.q.push(['init',u])},
    update:function(u){this.q.push(['update',u])},
    track:function(e,p){this.q.push(['track',e,p])},
    check:function(){this.q.push(['check'])},
    shutdown:function(){this.q.push(['shutdown'])}
  };
  var s=d.createElement('script');s.async=1;
  s.src='https://script.cueflow.so/embed/cueflow.js';
  s.setAttribute('data-workspace-id',i);
  d.head.appendChild(s);
})(window,document,'YOUR_WORKSPACE_ID');
</script>

<script>
  Cueflow.init({
    id: 'user-123',
    email: '[email protected]',
    name: 'Jane Smith'
  });
</script>

View full JavaScript SDK documentation

REST API

The REST API enables server-to-server integration for:

• Syncing contacts from your database

• Tracking events from backend systems

• Batch operations

• Webhook handlers

Quick start:

curl -X POST https://app.cueflow.so/api/v1/contacts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]", "name": "John Doe"}'

View full REST API documentation

Getting Your Credentials

Workspace ID (for JavaScript SDK)

1. Go to Developer Guide in the Cueflow dashboard

2. Your Workspace ID is shown in the code examples

API Key (for REST API)

1. Go to API Keys in the sidebar

2. Click Create API Key

3. Copy and securely store your key

Next Steps

• JavaScript SDK - Full frontend integration guide

• REST API - Backend API reference

• Troubleshooting - Common issues and solutions