Quickstart

Prerequisites

Before you begin, you’ll need:

A Flux account
Your API key from the dashboard
Node.js 18+ (or Python 3.8+, Go 1.19+)

1. Install the SDK

npm install @flux/node

yarn add @flux/node

pnpm add @flux/node

pip install flux-python

go get github.com/flux-events/flux-go

2. Initialize the Client

Create a new Flux client with your API key:

import Flux from '@flux/node';

const flux = new Flux(process.env.FLUX_API_KEY);

Never hardcode your API key. Use environment variables to keep it secure.

3. Send an Event

Events in Flux have a type and a data payload. The type is a string that identifies the kind of event (we recommend using dot notation like user.signup).

const event = await flux.events.send({
  type: 'order.completed',
  data: {
    orderId: 'ord_8x7kj2',
    amount: 9900,
    currency: 'usd',
    customerId: 'cus_abc123'
  }
});

console.log('Event sent:', event.id);

4. Verify It Worked

Head to the Events tab in your dashboard. You should see your event logged with its full payload and metadata.

Next Steps

Now that you’ve sent your first event, explore these guides:

Set Up Webhooks

Receive events in real-time via HTTP

Event Filtering

Subscribe to specific event types

Authentication

Secure your integration

API Reference

Full API documentation

Introduction SDK Setup

Getting Started

Guides

Prerequisites

1. Install the SDK

2. Initialize the Client

3. Send an Event

4. Verify It Worked

Next Steps

Set Up Webhooks

Event Filtering

Authentication

API Reference

​Prerequisites

​1. Install the SDK

​2. Initialize the Client

​3. Send an Event

​4. Verify It Worked

​Next Steps

Set Up Webhooks

Event Filtering

Authentication

API Reference

Prerequisites

1. Install the SDK

2. Initialize the Client

3. Send an Event

4. Verify It Worked

Next Steps