Introduction - Flameup Developer Documentation

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

Here's a complete example showing how to identify a user and track an event:

// Initialize with your API key
const API_KEY = 'ws_live_abc12345_abc123.your_secret_here';
const WORKSPACE_ID = 'your_workspace_id';
const BASE_URL = 'https://api.flameup.ai/api/v1';

// Identify a user
const response = await fetch(
  `${BASE_URL}/workspaces/${WORKSPACE_ID}/people`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${API_KEY}`
    },
    body: JSON.stringify({
      userId: 'user_123',
      email: 'jane@example.com',
      traits: {
        first_name: 'Jane',
        last_name: 'Doe',
        plan: 'premium'
      }
    })
  }
);

const user = await response.json();
console.log('User created:', user.id);

import requests

API_KEY = 'ws_live_abc12345_abc123.your_secret_here'
WORKSPACE_ID = 'your_workspace_id'
BASE_URL = 'https://api.flameup.ai/api/v1'

# Identify a user
response = requests.post(
    f'{BASE_URL}/workspaces/{WORKSPACE_ID}/people',
    headers={
        'Content-Type': 'application/json',
        'Authorization': f'Bearer {API_KEY}'
    },
    json={
        'userId': 'user_123',
        'email': 'jane@example.com',
        'traits': {
            'first_name': 'Jane',
            'last_name': 'Doe',
            'plan': 'premium'
        }
    }
)

user = response.json()
print(f"User created: {user['id']}")

# Identify a user with cURL
curl -X POST "https://api.flameup.ai/api/v1/workspaces/{workspace_id}/people" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ws_live_abc12345_abc123.your_secret_here" \
  -d '{
    "userId": "user_123",
    "email": "jane@example.com",
    "traits": {
      "first_name": "Jane",
      "last_name": "Doe",
      "plan": "premium"
    }
  }'

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 send Transactional messages to engage users.

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

Built with Documentation.AI

Last updated today