README

Statamic Funnels

A path a visitor walks: pages, forms, offers and payments in one flow, drawn on a canvas.

Requirements

Statamic 6 · PHP 8.2+ · a database · goldnead/statamic-payments · goldnead/statamic-offers

What a funnel is, and why it is not an automation

An automation is event → action: something happened, do something.

A funnel is a path somebody is actually standing on. That difference is small in words and large in what it needs: a page, and a memory of how far each person got. Neither belongs in an automation, which is why this is its own addon rather than four new node types in that one.

The editor, though, is literally the same code — goldnead/statamic-flow-canvas, the canvas the automations editor runs on. One editor, consumed twice, so the two cannot drift apart.

Installation

composer require goldnead/statamic-funnels
php artisan migrate
php artisan vendor:publish --tag=statamic-funnels

Funnels live under Utilities → Funnels.

Usage

The five kinds of step

Step	What it is	Ways out
Entry	The first page. Lives under the funnel's own URL.	one
Form	A page with a native Statamic form on it.	one
Page	A plain page: a thank-you, an explanation, a delivery notice.	one
Offer	Where money can change hands.	accepted and declined
Finish	The end. Marks the visit complete.	none

One entry per funnel, because a path has one beginning.

Declining is an answer, not a failure. Most visitors decline; a funnel that treats that as an error has nowhere to send them, so the canvas draws both branches and the editor nags about neither.

Landing pages: point a step at an entry

A step can name a Statamic entry, and then that entry is the page: its own template, its own layout, its own page builder, whatever sets and fields the site has defined. The funnel does not render it, it delivers it, through Statamic's own response — so password protection, private entries and the entry's redirect field all keep working.

There is no landing page builder in this addon and there should not be one. Statamic has Bard, Replicator and the blueprint the site already uses; a second, worse builder inside an addon is the wrong thing to maintain.

The funnel adds its context under a single key, funnel:

{{# In any template a step points at. #}}
{{ if funnel:action }}
    <form method="POST" action="{{ funnel:action }}">
        {{ csrf_field }}
        <button type="submit">Weiter</button>
    </form>
{{ /if }}

Available	What it is
`funnel:handle`, `funnel:title`	The funnel
`funnel:step:key`, `:type`, `:label`, `:slug`	The step being shown
`funnel:action`	Where the form posts to move on
`funnel:offer`	The offer on an offer step, price included
`funnel:visit:name`, `:email`	What the visitor has told you so far
`funnel:preview`	`true` when the Control Panel is looking

One key, not a dozen loose ones, and that is load-bearing rather than tidy: Statamic merges view data over an entry's own fields, so a funnel that handed over a flat body would blank the body of the very page it was rendering. Namespacing makes the collision impossible.

An entry that is unpublished falls back to the step's own fields rather than breaking the walk. One pulled into draft should not take a running funnel down with it.

Looking at it before it is live

The editor has a Preview. It walks the funnel step by step: the stepper follows the graph, one branch to its end and then the other, with the device sizes from config/live_preview.php.

What it shows is the graph on screen, not the one in the table, so an unsaved headline is visible immediately. It works on an unpublished funnel, which is the point. And it writes nothing: no visit, no step event, and no impression against an offer — an editor clicking through their own funnel twenty times must not move the acceptance rate the offers screen is judged by.

Behind it is a real Statamic\Facades\Token, minted only by somebody with the funnels permission, reused across a session rather than reissued per keystroke, and good for fifteen minutes.

Where people stop

Every step card in the editor carries three figures: how many visitors reached it, how many carried on from it, and the share. Counted per visitor, not per page load, so a reload does not flatter a step. A step nobody has reached shows nothing at all, and the last step of a walk shows no rate — a thank-you page is not converting at 0 %, it is the end.

Order bumps and coupon codes

An offer can carry other offers as tick-boxes beside the order button (bumps on the offer), and the page can take a coupon code. Both are settled on the server:

Only bumps the offer lists can be ticked. The form says which boxes were checked; the offer says which boxes exist, and only the intersection is bought.
A coupon code is a string from the browser; what it is worth is looked up. The rule that no amount ever comes from a request is intact.
A code's last use is claimed with a conditional update, so two people typing it at the same moment cannot both have it. If the loser was mid-purchase, they pay full price rather than failing — a sale lost to a race is worse than a discount missed.

Set coupons to false to leave the field off the page entirely.

A deadline that holds

An offer step can carry one, and it is enforced on the server: past it the step refuses to be accepted, whatever a stale tab still shows. A countdown that only counts is a lie told in Javascript, and a visitor who reloads past one learns that every deadline on the site is decoration.

Kind	What it means
`fixed`	One moment for everybody. A launch that closes on Friday.
`rolling`	A window per visitor, from the first time they see the step.

The rolling one is what people mean by "evergreen", and it needs saying out loud: the deadline is per visitor, written to their walk on first sight, and somebody who clears cookies gets a new one. That is a property of the mechanism. Enforcing it otherwise would mean identifying people.

The shipped page draws it and ticks it (funnels.js, no build step, no dependency). A site with its own front end reads funnel:countdown and does its own:

{{ if funnel:countdown }}
    <p data-funnel-countdown="{{ funnel:countdown:ends_at }}">
        {{ if funnel:countdown:expired }}Vorbei.{{ else }}<time data-funnel-clock>{{ funnel:countdown:seconds }}</time>{{ /if }}
    </p>
{{ /if }}

Declining still works after the deadline. A closed offer is not a closed funnel, and somebody standing on an expired page must be able to move on rather than being stuck.

Testing two versions of a page

Any step can run one. Set a share for B and fill in only the fields B changes:

Field
`split_share`	A whole percentage for B. Empty or 0 means no test.
`variant_entry`	A different page
`variant_headline`, `variant_body`	Different words

Three properties it has, and each is the reason such a thing is usually worthless without it:

Stable. A visitor sees the same version every time, decided once from their walk token and the step key. Splitting per render would show somebody A, then B, then A, and the numbers underneath would be about nothing.
Per step, not per funnel. Two tests can run at once without one deciding the other.
Recorded. The version is written onto the arrival, so the drop-off numbers can be split by it. A test that cannot be counted is a coin toss with extra steps.

The result shows in the editor, on the step where the test is set up — a split report on another screen is a report nobody opens. Only fields B actually sets are swapped: a test that changes one headline must not silently blank the body.

URLs

/f/{funnel}              the entry step
/f/{funnel}/{slug}       every other step

Real URLs, one per step, so a bookmark works, the back button works, and an email can link into the middle of a flow — which is how the second half of most funnels actually starts.

A step's slug is derived from its label once and then left alone. A slug that followed the label would break every link already sent out.

Money

An offer step sells an offer from statamic-offers, at the price that lives there. The price never comes from the page.

Accepted means paid. The walk moves on when the payment addon's webhook says the money arrived, and exactly once however often the provider redelivers. A buyer who closes the tab has still paid; a buyer who reaches the return page has not necessarily.

The provider sends them back into the funnel, not to the site's general thank-you page. Landing outside the flow is being dropped halfway through a purchase, and everything that was meant to follow the sale never happens.

If the same walk has already paid once and the site collects mandates, the second offer is charged without asking for card details again. The consent is not skipped — see statamic-payments/docs/follow-up-offers.md, because in Germany a follow-up order still needs its own unambiguously labelled button.

Templates

Each step may name its own Antlers template. Without one, a shipped template renders it, styled by a small stylesheet whose every value is a custom property. That fallback matters more than it looks: a funnel that renders nothing until somebody has written four templates never gets tried out.

{{ funnels:link handle="fruehlingskurs" }}

{{ funnels:progress handle="fruehlingskurs" }}
    {{ if no_results }}{{ else }}
        <a href="{{ url }}">Weiter bei „{{ step }}"</a>
    {{ /if }}
{{ /funnels:progress }}

progress is the "you were partway through this" link, which is worth more than most of what a funnel does at the front.

Who is walking

A random token in the visitor's own cookie identifies a walk, not a person. A funnel has to work before anybody has said who they are, and most visitors never do. Nothing here needs a login.

The cookie is deliberately not encrypted: it holds nothing worth hiding, and Laravel silently discards a cookie it cannot decrypt — a failure that looks exactly like a visitor who never came back.

What it plugs into

Every one of these is optional, checked with class_exists, and off by default. Installing a funnel addon must not start writing into somebody's CRM.

Sibling	What it does
`statamic-payments`	takes the money, decides what "paid" means
`statamic-offers`	says what a thing costs here
`statamic-leadhub`	receives a captured address as a contact
`statamic-automations`	four trigger nodes: step entered, form submitted, offer accepted, funnel completed
Statamic forms	are the form; this addon never grew its own

Configuration

Key	Default	What happens when it is wrong
`route_prefix`	`f`	Every funnel URL changes with it, including ones already printed on a flyer.
`styles`	`true`	Off for a site with its own design. The markup keeps its class names either way.
`integrations.leadhub`	`false`	On, captured addresses go to LeadHub as contacts.
`integrations.entitlements`	`false`	Off because the payment addon offers the same bridge, and two addons granting the same thing is worse than neither.
`coupons`	`true`	Off leaves the code field off every offer page.
`template_prefix`	`''`	A folder name confines what a step may name as its template. A namespaced name is refused either way.

Multi-site

Funnels are not site-scoped. A funnel is a campaign, not content.

Support

Only the latest version. https://github.com/goldnead/statamic-funnels/issues

Changelog · License

CHANGELOG.md · LICENSE.md

goldnead / statamic-funnels

Maintainers

Package info

Statistics

Security