Forms reference — Balancee Next.js
Balancee for Next.js has two forms: the contact form (“Tell us about your project.”) on the Contact page and the Service
page, and the newsletter box in the footer (“Never Miss an Update — Subscribe!”). Both post to a server action in
src/lib/actions.ts.
| Form | Where | Server action | form in the payload |
Fields (name → label) |
Required |
|---|---|---|---|---|---|
| Contact | Contact, Service | sendContact |
contact |
Name Name, Company Company, Email Email, Phone Phone, Service I’m interested in …, Message Tell us about your project. |
Name, Company, Email |
| Newsletter | every page (footer) | sendNewsletter |
newsletter |
Email Email |
Email |
“I’m interested in …” is a group of radio buttons, one per service (the eight names in contactForm in
src/content/pages/shared.ts): the visitor picks one or none. Name, Company and Email are required and the e-mail must
look like an e-mail address; Phone, the service and the message can be left empty.
<Form> (design system) → server action (src/lib/actions.ts) → deliver() → provider(s) chosen in FORM_PROVIDERThe form, its states, the e-mail check and the spam honeypot work out of the box. The Submit button shows the visitor’s progress as Framer’s does: a turning ring while sending, “Thank you” when it worked (the fields are cleared), and “Something went wrong” on a red fill when it didn’t (what was typed stays, so the visitor can try again). Where the submissions go is a setting, not code.
1. Pick a provider
Section titled “1. Pick a provider”Copy .env.example to .env.local (or add the variables in your host, e.g. Vercel → Settings → Environment Variables)
and set FORM_PROVIDER. Restart npm run dev after changing it.
FORM_PROVIDER |
What happens | Variables |
|---|---|---|
console (default) |
Printed to the server log. For development. | — |
webhook |
Posted as JSON to a URL — Zapier, Make, n8n, Pipedream, Formspree, Slack workflow, your own API. | FORM_WEBHOOK_URL, optional FORM_WEBHOOK_SECRET (sent as Authorization: Bearer …) |
mailchimp |
Sender added or updated in an audience, tagged with the form, the rest saved as a note. | MAILCHIMP_API_KEY, MAILCHIMP_AUDIENCE_ID, optional MAILCHIMP_STATUS |
resend |
Emailed to you; replying answers the sender. | RESEND_API_KEY, FORM_EMAIL_TO, FORM_EMAIL_FROM |
Use several at once with a comma: FORM_PROVIDER=resend,mailchimp emails you and adds the contact to Mailchimp.
If any of them fails, the visitor sees “Something went wrong” (their input stays in the form) and the reason is logged on
the server. The providers run at the same time, so when one fails the others have usually delivered already: sending
again can duplicate. Each submission carries the form’s name (form) and its title (title: “New message from the
Balancee contact form”, “New newsletter subscriber”), whichever page it was sent from.
The variables of .env.example
Section titled “The variables of .env.example”| Variable | For | Needed | What it is |
|---|---|---|---|
FORM_PROVIDER |
all | no (console when missing) |
console, webhook, mailchimp, resend, or several, separated by commas |
FORM_WEBHOOK_URL |
webhook | yes | The address that receives the POST |
FORM_WEBHOOK_SECRET |
webhook | no | Sent as Authorization: Bearer <secret>; leave it empty to send no header |
MAILCHIMP_API_KEY |
mailchimp | yes | Ends in your data center, e.g. …-us21 |
MAILCHIMP_AUDIENCE_ID |
mailchimp | yes | The audience that receives the contacts |
MAILCHIMP_STATUS |
mailchimp | no (transactional) |
The status of a new contact: transactional, pending or subscribed |
RESEND_API_KEY |
resend | yes | Your Resend API key |
FORM_EMAIL_TO |
resend | yes | The recipient, or several separated by commas |
FORM_EMAIL_FROM |
resend | yes | A sender on a domain verified in Resend, e.g. Balancee <forms@yourdomain.com> |
A provider that needs a variable and doesn’t find it stops that submission with Missing environment variable <NAME> (see .env.example) in the server log; a name in FORM_PROVIDER that doesn’t exist does the same with
Unknown FORM_PROVIDER "<name>". The visitor sees “Something went wrong” in both cases.
What each provider receives
Section titled “What each provider receives”console:[forms] <title>followed by the submitted values (data) as an object, for example[forms] New message from the Balancee contact form { Name: 'Jane Smith', Company: 'Acme', Email: 'jane@example.com', … }. In development it shows in the terminal that runsnpm run dev; on a host, in its logs.webhook: onePOSTof JSON (Content-Type: application/json) holding the whole submission, as in the payload below. An answer that isn’t a success is an error.mailchimp: three calls. The sender is added or updated in the audience (Email, in lower case, andFNAMEfromNamewhen filled in;MAILCHIMP_STATUSis the status of a new contact only), tagged with the form’s title, and a note is added to the profile: the title, then one “Label: value” line for each field that was filled in.resend: one e-mail fromFORM_EMAIL_FROMtoFORM_EMAIL_TO. The subject is the title followed by the sender’s name (“New message from the Balancee contact form — Jane Smith”; the title alone if the name is empty), the reply address is the sender’s e-mail, and the text is one “Label: value” line for each field that was filled in, then the time it was sent.
Mailchimp notes
Section titled “Mailchimp notes”- API key: Profile → Extras → API keys. It ends in your data center (
…-us21); nothing else to configure. - Audience ID: Audience → Settings → Audience name and defaults.
- Consent: new contacts are added as
transactional— they can receive replies, not campaigns. Usependingto send a double opt-in email, orsubscribedonly if the form asks for marketing consent. Balancee’s contact form doesn’t; the footer’s newsletter box does ask people to subscribe, so usependingorsubscribedif Mailchimp should mail them. - Merge fields: the name (
Name) →FNAME, a new audience’s default. ChangemergeFieldsat the top ofproviders/mailchimp.tsif your audience uses other tags, for examplePhone: "PHONE". - Service as a tag: add
"Service"totagFieldsin the same file to tag each contact with the service they picked, besides the form’s title.
Webhook payload
Section titled “Webhook payload”{ "form": "contact", "title": "New message from the Balancee contact form", "submittedAt": "2026-10-26T10:48:23.256Z", "data": { "Name": "Jane Smith", "Company": "Acme", "Email": "jane@example.com", "Phone": "", "Service": "Business strategy", "Message": "We'd like help planning our next year." }, "labels": { "Name": "Name", "Company": "Company", "Email": "Email", "Phone": "Phone", "Service": "I'm interested in ...", "Message": "Tell us about your project." }}data has a key for every field, in the order of the form, and labels the label of each. A field left empty is "";
Service is the chosen service or "". The newsletter sends { "form": "newsletter", "title": "New newsletter subscriber", "data": { "Email": "…" } }.
2. Spam: the honeypot
Section titled “2. Spam: the honeypot”Each form carries a hidden text field named fax (honeypotField in
src/design-system/components/forms/form-state.ts): it is out of sight and out of the tab order, a person never fills
it, and bots usually do. deliver() looks at it first: when it holds anything, the visitor is shown “Thank you” and
nothing is sent, so the bot moves on. Keep it as it is, and don’t give a real field the name fax.
3. The checks and the server action
Section titled “3. The checks and the server action”In the browser, <Form> checks the fields before sending: when a required field is empty or the e-mail isn’t an e-mail
address, the first failing field gets the focus and every failing field shows its message (“Please fill out this field.”,
“Please enter a valid email address.” — the field’s error) until it is changed. Without JavaScript the form still posts
and the browser’s own check runs.
sendContact checks again on the server, since a browser can be bypassed. It returns the error state when the e-mail
doesn’t look like an address, then lists the fields of the form (contactForm.fields) and calls
deliver(data, { form, title, fields, required, lists }) from src/lib/forms/deliver.ts, which:
- drops the submission if the honeypot is filled;
- reads each listed field from the submitted data (trimmed); fields named in
listsare read as a list of all values; - returns the error state when a required field is empty;
- builds the submission (
form,title,submittedAt,data,labels) and gives it to every provider named inFORM_PROVIDER; - returns the success state, or the error state with the reason logged (
[forms] <title> could not be delivered).
4. Add your own provider (HubSpot, Brevo, Airtable, a database…)
Section titled “4. Add your own provider (HubSpot, Brevo, Airtable, a database…)”-
Create
src/lib/forms/providers/<name>.ts:import { env, valueOf, type FormProvider } from "../types";export const brevoProvider: FormProvider = {name: "brevo",async send(submission) {const response = await fetch("https://api.brevo.com/v3/contacts", {method: "POST",headers: { "api-key": env("BREVO_API_KEY"), "Content-Type": "application/json" },body: JSON.stringify({email: valueOf(submission, "email"),attributes: { FIRSTNAME: valueOf(submission, "name"), COMPANY: valueOf(submission, "company") },updateEnabled: true,}),});if (!response.ok) throw new Error(`Brevo responded ${response.status}: ${await response.text()}`);},}; -
Register it in
providers/index.ts(brevo: brevoProvider). -
Set
FORM_PROVIDER=brevoand its variables in.env.example/ your host.
Helpers from types.ts: valueOf(submission, name) returns one field as text (a list joined with “, “; the name is
matched ignoring case, so "email" finds Email), toLines(submission) returns "Label: value" lines for every filled
field, and env(name) reads a required variable with a clear error. Both forms always deliver an Email.
5. Change the form
Section titled “5. Change the form”- Fields and labels live in the copy:
contactForm.fieldsinsrc/content/pages/shared.ts.nameis the key providers receive,labelis what people read above the field (and what the notification shows),placeholderis what the empty field shows,typepicks the control (text,email,tel,textarea,radios),requiredmakes the field checked before sending (no asterisk is shown, as in Framer),erroris the message shown when the check fails. The three texts of the button (submit,success,error) and the title of the notification (notification) are there too. - The services in “I’m interested in …” are the
optionsof theservicefield: they are written out in the copy (Framer reads them from its Service collection), so rename or add one there when you change a service insrc/content/collections/services.ts. - Required fields come from the same
requiredflags: the server action checks them again before it sends anything. To require another field, setrequired: trueon it and give it anerrormessage. - A new field: add it to
contactForm.fields, then place it in the form insrc/components/sections/ContactForm.tsx(<FormField {...fields.<key>} />; the form is a two-column grid from tablets up — addclassName="md:col-span-2"for a full row). - A new form: lay it out with
<Form>and<FormField>, add a server action next to the others insrc/lib/actions.ts(“use server”) that callsdeliver(data, { form, title, fields, required }), and add the form name toFormKindintypes.ts.