Documentation - FormFlow

Getting Started

FormFlow makes it incredibly easy to add contact forms to your static websites. In just a few minutes, you can have a fully functional form that sends emails directly to your inbox.

What You Need

A FormFlow account (sign up for free)
Your API key from the dashboard
A basic HTML form with the required fields

Setup Instructions

Follow these simple steps to integrate FormFlow with your website:

Sign up for FormFlow
Create your free account at FormFlow and get your unique API key from the dashboard.
Create your HTML form
Add a form to your website with the required fields and point it to our API endpoint.
Test your form
Submit a test message to make sure everything is working correctly.
Go live
Deploy your website and start receiving form submissions!

Form Example

Here's a complete example of how to set up a contact form with FormFlow:

<!-- Basic Contact Form -->
<form action="https://formflow.omnaris.xyz/send/[email protected]" method="POST">
  <!-- Hidden API key field -->
  <input type="hidden" name="access_key" value="your-api-key-here" />
  
  <!-- Required fields (must use these exact names) -->
  <input type="text" name="name" placeholder="Your Name" required />
  <input type="email" name="email" placeholder="Your Email" required />
  <textarea name="message" placeholder="Your Message" required></textarea>
  
  <!-- Honeypot field for spam protection -->
  <input type="checkbox" name="botcheck" style="display:none" />
  
  <button type="submit">Send Message</button>
</form>

Important: Your form must include fields with exactly these names: name, email, and message. FormFlow will not process forms without these required fields.

API Reference

Endpoint

POST https://formflow.omnaris.xyz/send/{[email protected]}

Required Fields

access_key - Your FormFlow API key
name - Sender's name
email - Sender's email address
message - Message content

Optional Fields

botcheck - Honeypot field for spam protection (should be hidden)
subject - Custom email subject line

Response Codes

200 - Message sent successfully
400 - Missing required fields or invalid data
403 - Invalid API key or bot detected
429 - Rate limit exceeded
500 - Server error

Self-Hosting

FormFlow is open source and can be self-hosted on your own infrastructure. Here's how to get started:

Using Docker

# Clone the repository
git clone [email protected]:DanilSidorov8625/FormFlow.git
cd FormFlow

# Set up environment variables
cp .env.example .env
# Edit .env with your settings

# Run with Docker Compose
docker-compose up -d

Environment Variables

RESEND_API_KEY - Your Resend API key for sending emails

Quick Navigation