Quickstart

​

Get started in 5 minutes

1

Create your account and project

Sign up for Flowripple and create your first project in the dashboard.

Once you’ve created a project, you’ll be ready to create API keys and start building workflows.

2

Create an API key

API keys authenticate requests from your application to Flowripple. Create your first API key: 1. Navigate to your project in the dashboard 2. Go to API Keys in the sidebar navigation 3. Click “Create New Key” button (or use an existing key if you already have one) 4. In the dialog that appears, enter a descriptive name for your API key (e.g., “Production Key” or “Development Key”) 5. Click “Create Key” to generate your API key 6. Copy the generated API key and store it in a secure place in your project

How to copy your API key

Security best practice: Keep your API key secure. Never commit it to version control or expose it in client-side code. Store it as an environment variable or use a secrets management service.

Create separate API keys for different environments (development, staging, production) to better track usage, manage access, and rotate keys independently. You can view, reveal, or delete existing keys from the API Keys page at any time.

3

Create an event

Events are the triggers that start your workflows. For this guide, we’ll create a user signup event. While events are auto-created when first triggered via SDK (or API), you can pre-configure them with names and expected payloads:

1. Go to the Events section in your dashboard
2. Click “Create Event”
3. Enter an Event Name (e.g., “User Signup”)
4. The Event Identifier will be auto-generated from the name (e.g., user.signup). You can customize it, but it must use only lowercase letters, numbers, dots (.), and dashes (-)
5. (Optional) Define the Expected Payload as a JSON structure to map variables and their data types. For a user signup event, you might use:

Copy

{
  "userId": "string",
  "email": "string",
  "name": "string",
  "timestamp": "number"
}

The expected payload helps workflows understand the data structure, enabling proper variable mapping, validation, and data routing in your workflow steps.

How to create an event

Event naming convention: Use dot notation (e.g., user.signup) to organize related events by domain. The identifier is automatically generated from the name, but you can customize it. Events are automatically created when you trigger them for the first time, so you can skip this step and jump straight to building workflows.

The form shows a live SDK Usage Preview that updates as you type, showing exactly how you’ll trigger this event in your code. This helps you see the final API call before creating the event.

4

Build your first workflow

Create a workflow that sends a welcome email to users when they sign up:

1. Go to the Workflows section in your dashboard
2. Click “Create Workflow”
3. Give it a descriptive name (e.g., “Welcome Email” or “User Onboarding”)
4. In the workflow builder, configure the event trigger:
   • Click on the trigger node (the starting point of the workflow)
   • Select “Event Trigger” from the trigger options
   • In the event dropdown, select the event you just created (e.g., user.signup)
   • Click “Save” to confirm the trigger configuration
5. Add the email step:
   • Drag and drop the “Send Email” step onto the canvas
   • Click on the Send Email step to open its configuration
   • Configure the email inputs:
     • To Email: Use an event variable like {{trigger.email}} to send to the user who signed up
     • Subject: Enter a subject line (e.g., “Welcome to our platform!”)
     • Body: Write your email body and use event variables like {{trigger.name}} to personalize the message
   • Click “Save” to confirm the email step configuration
6. The trigger and email step will automatically connect. Click “Save Workflow” to save your workflow
7. Toggle the “Active” to enable your workflow

How to create and configure a workflow

This creates a simple single-step workflow. You’ll learn about building complex workflows with conditions, loops, and multiple steps in the workflow documentation.

5

Trigger your workflow from code

Trigger your workflow from your application. You can use the Flowripple SDK (Node.js only) or make HTTP requests from any programming language.

• Node.js (SDK)
• HTTP (Any Language)

First, install the Flowripple SDK:

npm

pnpm

yarn

bun

Copy

npm install @flowripple/sdk

Then use it in your code:

Copy

import flowripple from '@flowripple/sdk';

// Initialize the SDK with your API key
flowripple.init(process.env.FLOWRIPPLE_API_KEY);

// Trigger the event
await flowripple.trigger('user.signup', {
  "userId": "user_123",
  "email": "[email protected]",
  "name": "John Doe",
  "timestamp": 1704067200000
});

The SDK automatically handles authentication, request formatting, and error handling. Replace user.signup with your event identifier and include the data payload your workflow expects.

You can trigger events using HTTP requests from any programming language. Here’s an example using cURL:

Copy

curl -X POST https://flowripple.com/api/v1/trigger \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "identifier": "user.signup",
    "data": {
      "userId": "user_123",
      "email": "[email protected]",
      "name": "John Doe",
      "timestamp": 1704067200000
    }
  }'

Expected response:

Copy

{
  "jobId": "job_abc123",
  "status": "queued"
}

Replace YOUR_API_KEY with your actual API key from step 2. You can use this same HTTP endpoint from Python, Ruby, Go, PHP, or any other language that supports HTTP requests.

If successful, you’ll receive a response with a jobId indicating your event was queued for processing. The workflow will execute asynchronously—check your dashboard to see the execution status and logs.

​

Verify your workflow

1. Go to the Executions section in your dashboard
2. Find the execution for your workflow (it should appear within a few seconds)
3. Check the status—it should show “Success” if everything ran correctly
4. Click on the execution to view detailed logs and see:
   • Each step that was executed
   • The data that was passed between steps
   • Any errors or warnings
   • Execution timing information

​

What’s next?

​

Troubleshooting