Craft CMS plugin

Formie Beacon CRM

A completely free Beacon CRM integration for Formie.

Read the docs (opens in a new tab) View on GitHub (opens in a new tab)

Overview

Formie Beacon CRM is a completely free Craft CMS plugin that adds Beacon CRM as a Formie integration. It reads your account schema at runtime, so you can send submissions to built-in or custom record types without hard-coded fields.

Map form values, use fixed values, upsert existing records, and only send data when a visitor has opted in. The plugin is open source, MIT-licensed, and is not currently distributed through the Craft Plugin Store.

  • Free and open source

    MIT-licensed and installed with Composer. No licence key and nothing to buy.

  • Reads your account live

    Record types, custom fields and drop-down options come straight from your own Beacon account.

  • Blanks never overwrite

    Empty form values are skipped, so a blank optional field never clears data already in Beacon.

Features

What it does

  1. Works with any Beacon account

    Your account's schema is read from Beacon's API at runtime, so custom record types and custom c_* fields appear in the mapping screen without any configuration.

  2. Any record type

    Send submissions to Person, Organisation, Payment or any custom record type you have built, with a different mapping on every form.

  3. Exact drop-down values

    Drop-down options are read from your account, so you pick a value Beacon will accept rather than typing one and hoping it matches.

  4. Create or update

    Turn on Update Existing Records and choose a Match On field, such as email, so repeat submissions update the existing record instead of creating a duplicate.

  5. Fixed values

    Send a constant on every submission, such as a Source of ‘Website’, without a form field for it. Drop-downs offer their configured options.

  6. The right JSON shapes

    Names, emails, phone numbers, drop-downs, record links, checkboxes and currency amounts are converted into the exact format Beacon expects, with currency in major units.

  7. Address fields

    Map an address one part at a time, from the first line to the country code, and the plugin reassembles it into the record's first address.

  8. Opt-in support

    Nominate an opt-in field, usually an Agree field, and nothing is sent unless the person consents.

  9. Logging that explains failures

    Successful writes log their Beacon record ID. Failures log Beacon's real validation message and the payload sent, rather than its generic error.

  10. Credentials kept out of Git

    The account ID and API key are read from environment variables, so the key stays out of project config and version control.

Get started

Install Formie Beacon CRM

  1. Require it with Composer:
    composer require coyshdigital/craft-formie-beacon
  2. In the control panel, go to Settings → Plugins and install it.
  3. The documentation (opens in a new tab) covers the settings and everything after that.

Questions

Questions people ask

Is it really free?
Yes. It is open source under the MIT licence, with no licence key. It isn't on the Craft Plugin Store, so you install it with Composer.
What do I need before I start?
Craft CMS 5, Formie 3 installed and licensed, and a Beacon account on a plan that includes API access. Only a Beacon administrator can create the API key you'll need.
Where do I find my API key and account ID?
In Beacon, go to Settings → API keys and create a key. It is shown once, so copy it straight away. Your account ID is the number at the end of your Beacon API URL. Store both in .env and reference them as $BEACON_ACCOUNT_ID and $BEACON_API_KEY.
How do I stop duplicate records?
Turn on Update Existing Records, pick a Match On field that is genuinely unique, such as email, and make sure that field is mapped. Beacon then updates a matching record instead of creating a new one. If duplicates already exist, clean them up first.
Why is a field missing from the mapping list?
File uploads, Beacon users and fields Beacon calculates itself, such as smart, rollup and auto-increment fields, are left out on purpose because Beacon rejects them on write. Addresses appear one part at a time. For anything added in Beacon recently, click Refresh Integration.
Will a blank form field wipe data in Beacon?
No. Empty values are skipped rather than sent, so a blank optional field won't overwrite what Beacon already holds. 0 and false count as real values and are sent.
Why did a submission trigger an email from Beacon?
That is a Beacon workflow, not the plugin. Records created through the API are treated like any other record, so an active workflow can email someone or create a task. Check your workflows before a form goes live.
Where can I see what was sent?
Open the submission under Formie → Submissions and look at its Integrations tab for the payload and Beacon's reply. Everything is also written to storage/logs/formie.log, with Beacon's specific validation message rather than its generic error.

Support

Help when you need it

More plugins

From Coysh Digital

All plugins

  • Download Tracker

    Craft CMS $10

    Lightweight, static-cache-friendly download tracking for Craft CMS.

  • Craft Analytics

    Craft CMS Lite free, Pro $69

    Privacy-first, consent-aware analytics that runs inside Craft CMS.

  • Webhook Notifier

    Craft CMS

    Rule-driven webhook notifications for Craft CMS, with first-class Microsoft Teams support.

Get in touch

Use the form below to tell us about your project, or email [email protected] directly. We’ll get back to you as soon as we can to see how we can help.