Quickstart

Wire any HTML form at FormRelay in under a minute. The examples below use http://localhost:8399 — swap in your FormRelay host.

1. Point your form at the endpoint

<form action="http://localhost:8399/f/contact?key=YOUR_API_KEY" method="POST">
  <input type="email" name="email" required>
  <textarea name="message"></textarea>
  <!-- honeypot: leave empty, hide with CSS -->
  <input type="text" name="company" style="display:none" tabindex="-1">
  <button type="submit">Send</button>
</form>

2. Or POST JSON with your API key

curl -X POST http://localhost:8399/f/contact \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"email":"don+formrelay@lifeofmorr.com","message":"Hello","company":""}'
# {"ok": true, "status": "received", "id": "sub_...", "received_at": "..."}

3. Read submissions back

curl http://localhost:8399/f/contact/submissions \
  -H 'X-API-Key: YOUR_API_KEY'
# {"ok": true, "form_id": "contact", "count": 2, "submissions": [...]}
Full reference: every endpoint — method, path, auth, request and response shapes — is documented in OPENAPI.md in the product repo.

Pick a plan