Quick Start

This guide walks you through building your first Voodflow workflow in under 10 minutes. The example workflow will:

1. Run when a new user is created
2. Send a welcome email to the new user

Prerequisites

• Voodflow installed and configured
• A Voodflow Credential (type smtp) configured in /admin/credentials
• A queue worker running (or VOODFLOW_EXECUTE_SYNC=true for testing)

---

Step 1: Register Your Eloquent Model

Before Voodflow can listen for lifecycle events from your User model, you must register it in the Model Integrations section.

1. Navigate to Voodflow → Model Integrations in the Filament sidebar
2. Click New Model Integration
3. Set:
   • Label: Users
   • Model Class: App\Models\User
   • Essential fields: name, email
4. Save

This registration makes App\Models\User available for event-driven workflows and enables Eloquent lifecycle event descriptors.

In the same Model Integration: 5. Enable the Eloquent created lifecycle event (so the Event Trigger can react when users are created).

---

Step 2: Create an SMTP Credential

Before sending emails, you need to create a credential in Voodflow credentials:

1. Open /admin/credentials
2. Create a new Credential of type smtp
3. Fill in your SMTP settings and save

---

Step 3: Create a New Workflow

1. Navigate to Voodflow → Workflows
2. Click New Workflow
3. Set the name: Welcome Email - New Users
4. Click Save — the visual workflow editor opens

---

Step 4: Add an Event Trigger

1. In the editor canvas, click Add Node → Triggers → Event Trigger
2. Configure:
   • Event Class (field eventClass): eloquent.created: App\\Models\\User
3. Click Save Node

The Event Trigger node is the entry point of your workflow. It starts a run whenever your application creates a new User model instance.

---

Step 5: Add and Configure Send Mail

1. Click the + handle on the Event Trigger node to add a connected node
2. Choose Integrations → Send Mail
3. In the Email Credential selector, pick the smtp credential you created in Step 4
4. Configure:
   • From Email: no-reply@yourapp.com
   • From Name: YourApp
   • To Email: {{user.email}}
   • Subject: Welcome to YourApp, {{user.name}}!
   • Body:

     <h1>Hi {{user.name}},</h1>
     <p>Thank you for registering. Your account is active at {{user.email}}.</p>
     <p>Best regards,<br />The YourApp Team</p>

   • Send as HTML: enabled
5. Click Save Node

---

Step 6: Activate the Workflow

1. In the workflow list, find your workflow
2. Toggle the status from Draft → Active

The workflow is now event-driven and will execute every time a user is created.

---

Testing Manually

To test the workflow on demand, create a new User record in your application (for example from your registration flow).

After execution, navigate to Voodflow → Executions to inspect:

• Overall execution status (success, failed, running)
• Input/output data for every node
• Timing information per node
• Any error messages

---

Template Syntax Overview

Voodflow uses {{field}} double-brace syntax for dynamic value injection in text fields:

Syntax	Description
{{user.email}}	Access field from the current event payload
{{input.name}}	Access field from the previous node's output
{{variables.my_var}}	Access a workflow variable set by Set Variable node
{{now}}	Current datetime (formatted per VOODFLOW_DATE_FORMAT)

See Template Syntax for the full reference.

---

Next Steps

• Learn about all node types
• Set up credentials for APIs
• Understand execution logs
• Build a custom node