Skip to main content

​
Events Overview

Events are named identifiers that represent discrete occurrences in your system. When something happens—a user signs up, an order is created, a payment is completed—you trigger an event that carries a JSON payload with relevant data.

​
How Events Work

Your Application          Flowripple           Workflows
     │                        │                    │
     │ trigger("user.signup") │                    │
     │───────────────────────>│                    │
     │                        │ Event captured     │
     │                        │───────────────────>│
     │                        │                    │ Workflow executes
     │                        │                    │ with event data
  1. Trigger: Your application sends an event to Flowripple with an identifier and data payload
  2. Capture: Flowripple records the event and extracts variables from the payload
  3. Execute: All workflows configured to start on that event execute with access to the event data

​
Key Concepts

Identifiers

Named strings like user.signup or payment.completed that uniquely identify event types within a project.

Payloads

JSON data sent with each event containing context like user information, order details, or any relevant data.

Variables

Automatically extracted from payloads, variables make event data available throughout your workflows using {{variable.path}} syntax.

Captures

Every triggered event is recorded as a capture, creating an audit trail for monitoring and debugging.

​
Event Identifiers

Event identifiers follow a dot notation convention that organizes related events by domain:
IdentifierDomainAction
user.signupusersignup
user.loginuserlogin
order.createdordercreated
payment.completedpaymentcompleted
Use consistent naming patterns across your project. Group related events by domain (user.*, order.*, payment.*) to keep your event library organized.

​
Auto-Detection

Events are automatically created when you trigger them for the first time. You don’t need to pre-configure events before using them—simply trigger an event with a new identifier, and Flowripple creates the event and extracts variables from your payload. 
// First trigger creates the event automatically
await flowripple.trigger('order.shipped', {
  orderId: 'ord_123',
  trackingNumber: 'TRK456789',
  carrier: 'fedex'
});
While auto-detection is convenient for development, consider pre-creating events in the dashboard to define expected payload structures and add descriptive names.

​
What’s Next?

Creating Events

Learn how to create and configure events in the dashboard.

Event Payloads

Understand payload structure and how variables are extracted.

Triggering Events

Trigger events from your application using the SDK or HTTP API.

Monitoring Captures

Track event triggers and analyze capture data.

​
Using Events in Workflows

Once you’ve created events, configure workflows to respond to them using event triggers.

Event Trigger

Learn how to configure workflows to start automatically when events occur.