Documentation
Documentation

Getting Started

Welcome to Flux Relay! Get up and running in minutes.

Quick Start

Flux Relay is a powerful messaging platform that provides real-time communication capabilities for your applications. Follow these steps to get started:

1. Create a Developer Account

Start by creating your developer account to access the Flux Relay platform.

Option 1: Use the Dashboard

Visit the registration page and create your account with your email and password.

Option 2: Use the API

POST /api/auth/developer/register
{
  "email": "developer@example.com",
  "password": "your-secure-password",
  "name": "Your Name"
}

After registration, check your email to verify your account. You'll receive an access token upon successful login.

2. Create a Project

Projects are containers for your messaging applications. Each project can have multiple servers and databases.

Option 1: Use the Dashboard

Go to your dashboard and click "Create Project" to set up a new project.

Option 2: Use the API

See detailed documentation: Create Project API

POST /api/developer/projects
Authorization: Bearer YOUR_TOKEN
{
  "name": "My Messaging App",
  "description": "My messaging application"
}

3. Set Up a Server

Servers handle the real-time messaging infrastructure for your project. Each server can manage multiple databases.

Option 1: Use the Dashboard

Navigate to your project in the dashboard and create a server from the servers section.

Option 2: Use the API

See detailed documentation: Create Server API

POST /api/developer/projects/{projectId}/servers
Authorization: Bearer YOUR_TOKEN
{
  "name": "Production Server",
  "description": "Main production instance"
}

Save the server key returned in the response - you'll need it for authentication.

4. Initialize Your Database

Initialize your database with the messaging schema to start storing conversations and messages.

Option 1: Use the Dashboard

Go to your server's database section and click "Initialize Database" to set up the messaging schema.

Option 2: Use the API

See detailed documentation: Initialize Database API

POST /v1/organizations/{organizationSlug}/databases/{databaseName}/initialize
Authorization: Bearer YOUR_TOKEN
{
  "schemaType": "messaging",
  "dropExisting": false
}

This creates the necessary tables for conversations, messages, contacts, and more.

5. Start Sending Messages

Once your database is initialized, you can start sending and receiving messages.

Option 1: Use the Dashboard

Visit the Messages interface to test sending messages through the dashboard.

Option 2: Use the API

Use the conversations and messages API endpoints to send messages programmatically. See Conversations API for details.

POST /api/conversations
Authorization: Bearer YOUR_SERVER_KEY
{
  "contactEmail": "user@example.com",
  "message": "Hello, this is my first message!"
}

Check out the Integrations section for framework-specific examples.

Next Steps