Introduction

Welcome to Flameup - The customer engagement platform for modern applications. Updated August 2026.

Welcome to Flameup

Flameup is a powerful customer engagement platform that enables you to understand your users, track their behavior, and communicate with them through personalized messaging campaigns. Whether you're sending transactional notifications, running automated campaigns, or analyzing user behavior, Flameup provides the tools you need.

Quick Start

Get up and running in 5 minutes with our step-by-step guide.

API Reference

Explore the complete API documentation with examples.

Authentication

Learn how to authenticate your API requests.

What Can You Build?

Flameup provides a complete toolkit for customer engagement:

People API - Create and manage user profiles with rich attributes.

Identify users with custom IDs or email addresses
Store user attributes and preferences
Segment users based on behavior and properties
Batch operations for efficient bulk updates

The People API supports upsert operations, making it easy to create or update users in a single call.

Core Concepts

Understanding these key concepts will help you get the most out of Flameup:

Workspaces are isolated environments for your data. Each workspace has its own:

Users (People)
Events
Campaigns
API Keys

Use separate workspaces for development, staging, and production environments.

Base URL

All API requests should be made to:

https://api.flameup.ai/api/v1

Workspace-scoped endpoints follow this pattern:

https://api.flameup.ai/api/v1/workspaces/{workspace_id}/{resource}

Quick Example

Two calls: describe a person, then record something they did. The workspace comes from the key, so it never appears in the URL or the body.

const API_KEY = 'ws_live_abc12345_abc123.your_secret_here';
const BASE_URL = 'https://api.flameup.ai/api/v1';

const headers = {
  'Content-Type': 'application/json',
  'Authorization': `Bearer ${API_KEY}`
};

// 1. Identify — creates or updates the person, keyed on your own user id
await fetch(`${BASE_URL}/identify`, {
  method: 'POST',
  headers,
  body: JSON.stringify({
    userId: 'user_123',
    email: 'jane@example.com',
    traits: { first_name: 'Jane', plan: 'premium' }
  })
});

// 2. Track — this is what campaigns trigger on
await fetch(`${BASE_URL}/track`, {
  method: 'POST',
  headers,
  body: JSON.stringify({
    userId: 'user_123',
    event: 'signed_up',
    parameters: { source: 'organic' }
  })
});

import requests

API_KEY = 'ws_live_abc12345_abc123.your_secret_here'
BASE_URL = 'https://api.flameup.ai/api/v1'
headers = {'Authorization': f'Bearer {API_KEY}'}

# 1. Identify
requests.post(f'{BASE_URL}/identify', headers=headers, json={
    'userId': 'user_123',
    'email': 'jane@example.com',
    'traits': {'first_name': 'Jane', 'plan': 'premium'}
})

# 2. Track
requests.post(f'{BASE_URL}/track', headers=headers, json={
    'userId': 'user_123',
    'event': 'signed_up',
    'parameters': {'source': 'organic'}
})

curl -X POST https://api.flameup.ai/api/v1/identify \
  -H "Authorization: Bearer ws_live_abc12345_abc123.your_secret_here" \
  -H 'Content-Type: application/json' \
  -d '{"userId":"user_123","email":"jane@example.com","traits":{"first_name":"Jane","plan":"premium"}}'

curl -X POST https://api.flameup.ai/api/v1/track \
  -H "Authorization: Bearer ws_live_abc12345_abc123.your_secret_here" \
  -H 'Content-Type: application/json' \
  -d '{"userId":"user_123","event":"signed_up","parameters":{"source":"organic"}}'

/track creates the person if it has not seen that id, so the order does not matter and there is no first-event race. The response says "person_created": true when it did — useful for catching a mistyped identifier.

Health

Endpoint	Purpose
`GET /health`	Liveness. Returns `{status: "alive"}`
`GET /api/v1/health`	Readiness, with per-service status for `postgres`, `clickhouse` and `redis`. Watch `redis` in particular: it drives the wait scheduler, so a workspace whose journeys stall at wait steps should check it first

Neither requires authentication, and neither counts against your rate limit.

Next Steps

Get Your API Key

Create an API key in your Flameup Dashboard with the permissions you need.

Identify Your Users

Use the People API to create user profiles and store attributes.

Track Events

Capture user behavior with the Events API to power analytics and campaigns.

Send Messages

Set up Campaigns or use the Messaging APIs to send push notifications.

Need help? Check out the API Reference for detailed endpoint documentation, or reach out to our support team.

Was this page helpful?